///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance").
// All rights reserved.
//
// This software and its documentation and related materials are owned by
// the Alliance. The software may only be incorporated into application
// programs owned by members of the Alliance, subject to a signed
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable
// trade secrets of the Alliance and its suppliers. The software is also
// protected by copyright law and international treaty provisions. Application
// programs incorporating this software must include the following statement
// with their copyright notices:
//
//   This application incorporates Open Design Alliance software pursuant to a license
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance.
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

#pragma once

#include "DbEvalGraph.h"
#include "RxObject.h"
#include "DbObjectId.h"
#include "DbBlockReference.h"

#include "TD_PackPush.h"

class OdDbBlockPostponedAction;

/** \details
    Callback function type for postponed actions on dynamic blocks.
*/
typedef void(*OdDbBlockPostponedActionCallback)(OdDbBlockPostponedAction* op);

/** \details
    This class represents a postponed action for dynamic blocks.
    Postponed actions allow block modifications to be queued and executed later.

    <group OdDb_Classes>
*/
class DYNBLOCKS_EXPORT OdDbBlockPostponedAction : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdDbBlockPostponedAction);

  /** \details
    Default constructor. Initializes all fields to nullptr.
  */
  OdDbBlockPostponedAction();

  /** \details
    Destructor.
  */
  virtual ~OdDbBlockPostponedAction();

  /** \details
    Sets the callback function to be executed for this action.

    \param pCallback [in] Pointer to the callback function.
  */
  void setCallback(OdDbBlockPostponedActionCallback pCallback);

  /** \details
    Sets the block reference that this action will modify.

    \param pBlockRef [in] Pointer to the block reference.
  */
  void setBlockReference(OdDbBlockReference* pBlockRef);

  /** \details
    Sets application-specific data for this action.
    Takes ownership of the provided object.

    \param pData [in] Pointer to application data.
  */
  void setApplicationData(const OdRxObject* pData);

  /** \details
    Returns the callback function for this action.

    \returns Pointer to the callback function.
  */
  OdDbBlockPostponedActionCallback getCallback() const;

  /** \details
    Returns the block reference for this action.

    \returns Pointer to the block reference.
  */
  OdDbBlockReference* getBlockReference() const;

  /** \details
    Returns the application data for this action.

    \returns Pointer to the application data.
  */
  const OdRxObject* getApplicationData() const;

private:
  // Copying is prohibited
  OdDbBlockPostponedAction(const OdDbBlockPostponedAction&);
  OdDbBlockPostponedAction& operator=(const OdDbBlockPostponedAction&);

  class OdDbBlockPostponedActionImpl* m_pImpl;
};

typedef OdSmartPtr<OdDbBlockPostponedAction> OdDbBlockPostponedActionPtr;

#include "TD_PackPop.h"