EdCommandStack.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, 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-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef _ODEDCOMMANDSTACK_H_INCLUDED_
#define _ODEDCOMMANDSTACK_H_INCLUDED_
 
 
 
#define ODRX_COMMAND_DOCK      OD_T("ODRX_REGISTERED_COMMANDS")
 
typedef void (*OdRxFunctionPtr) ();
 
class OdEdCommand;
class OdEdCommandContext;
 
#include "RxObject.h"
 
class OdRxIterator;

typedef OdSmartPtr<OdRxIterator> OdRxIteratorPtr;
 
class OdRxDictionary;
// class OdEdUIContext;
 
#include "TD_PackPush.h"
 
class OdEdCommand;
 
typedef void (OdEdCommandFunction) (OdEdCommandContext* pCmdCtx);

typedef OdSmartPtr<OdEdCommand> OdEdCommandPtr;

class ODRX_ABSTRACT FIRSTDLL_EXPORT OdEdCommand : public OdRxObject 
{
protected:
  OdEdCommand();
public:
  ODRX_DECLARE_MEMBERS(OdEdCommand);
 
  ~OdEdCommand();
  enum
  {
    kModal            = 0x00000000,
    kTransparent      = 0x00000001,
    kUsePickset       = 0x00000002,
    kRedraw           = 0x00000004,
    kNoPerspective    = 0x00000008,
    kNoMultiple       = 0x00000010,
    kNoTilemode       = 0x00000020,
    kNoPaperspace     = 0x00000040,
    kPlotOnly         = 0x00000080,
    kNoOEM            = 0x00000100,
    kUndefined        = 0x00000200,
    kInProgress       = 0x00000400,
    kDefun            = 0x00000800,
    kNoNewStack       = 0x00010000,
    kNoInternalLock   = 0x00020000,
    kDocReadLock      = 0x00080000,
    kDocExclusiveLock = 0x00100000,
    kSession          = 0x00200000,
    kInterruptible    = 0x00400000,
    kNoHistory        = 0x00800000,
 
    kNoUndoMarker     = 0x01000000,
    kNoBedit          = 0x02000000 
  };
 
  static OdEdCommandPtr createObject(
    const OdString& sGroupName,
    const OdString& sGlobalName,
    const OdString& sLocalName,
    OdUInt32 commandFlags,
    OdEdCommandFunction *pFunction,
    OdRxModule *pModule = 0
    );

  virtual const OdString groupName() const = 0;

  virtual const OdString globalName() const = 0;

    virtual const OdString localName() const;

  virtual void execute(OdEdCommandContext* pCommandContext) = 0;
 
  virtual const OdRxModule* module() const;
 
  virtual void undefine(bool undefIt);
 
  virtual OdInt32 flags() const;
 
  /*
  virtual OdEdUIContext   *UIContext() const = 0;
  virtual int             functionCode() const = 0;
  virtual void            functionCode(int fcode) = 0;
  virtual const HINSTANCE resourceHandle() const = 0;
  */
};
 

class FIRSTDLL_EXPORT OdEdCommandStackReactor : public OdRxObject 
{ 
public:
  ODRX_DECLARE_MEMBERS(OdEdCommandStackReactor);
  
  virtual void commandAdded(OdEdCommand* pCommand);
  
  virtual void commandWillBeRemoved(OdEdCommand* pCommand);
  
  virtual void commandWillStart(OdEdCommand* pCommand, OdEdCommandContext* pCmdCtx);
  
  virtual void commandEnded(OdEdCommand* pCommand, OdEdCommandContext* pCmdCtx);
  
  virtual void commandCancelled(OdEdCommand* pCommand, OdEdCommandContext* pCmdCtx);
  
  virtual void commandFailed(OdEdCommand* pCommand, OdEdCommandContext* pCmdCtx);
  
  virtual OdEdCommandPtr unknownCommand(const OdString& commandName, OdEdCommandContext* pCmdCtx);
};

typedef OdSmartPtr<OdEdCommandStackReactor> OdEdCommandStackReactorPtr;

typedef OdArray<OdEdCommandStackReactorPtr> OdEdCommandStackReactorArray;

class OdEdUnknownCommand {};

class FIRSTDLL_EXPORT OdEdCommandStack : public OdRxObject 
{ 
public:
  ODRX_DECLARE_MEMBERS(OdEdCommandStack);

  virtual void addReactor(OdEdCommandStackReactor* pReactor) = 0;

  virtual void removeReactor(OdEdCommandStackReactor* pReactor) = 0;

  virtual OdEdCommandStackReactorArray getCommandStackReactors() const = 0;

  virtual void addCommand(OdEdCommand* pCommand) = 0;

  virtual OdEdCommand* addCommand(
    const OdString& sGroupName,
    const OdString& sGlobalName,
    const OdString& sLocalName,
    OdUInt32 commandFlags,
    OdEdCommandFunction *pFunction,
    OdRxModule *pModule = 0);
  
  virtual OdRxIteratorPtr newIterator() = 0;

  virtual OdRxIteratorPtr newIterator(const OdString& groupName) = 0;
 

  virtual OdRxIteratorPtr newGroupIterator() = 0;
  
  enum LookupFlags
  {
    kGlobal       = 0x01, // Search global (untranslated) names.
    kLocal        = 0x02, // Search local (translated) names.
    kSpecifedGroup= 0x04, // Search in specified group only.
    kUndefed      = 0x08, // Do not fire unknownCommand() event.
    kThrowUnknown = 0x10  // Throw OdEdUnknownCommand exception if command was not found.
  };

  virtual OdEdCommandPtr lookupCmd(
    const OdString& commandName,
    int lookupFlags = kGlobal|kLocal,
    const OdString& groupName = OdString::kEmpty) = 0;

  virtual void executeCommand(OdEdCommand* pCmd, OdEdCommandContext* pCmdCtx) = 0;

  virtual void executeCommand(const OdString& cmdName,
                              OdEdCommandContext* pCmdCtx,
                              int lookupFlags = kGlobal|kLocal,
                              const OdString& groupName = OdString::kEmpty) = 0;

  virtual void removeCmd(const OdString& groupName, const OdString& globalName) = 0;
 
  
  virtual void removeCmd(const OdEdCommand* pCommand) = 0;

  virtual void removeGroup(const OdString& groupName) = 0;
  virtual OdResult popGroupToTop(const OdString& cmdGroupName) = 0;
};

typedef OdSmartPtr<OdEdCommandStack> OdEdCommandStackPtr;

FIRSTDLL_EXPORT OdEdCommandStackPtr odedRegCmds();
 
//FELIX_CHANGE_BEGIN
FIRSTDLL_EXPORT OdEdCommandPtr odedFireUnknownCommand( OdEdCommandStack* pCmdStack, const OdString& sCmd, OdEdCommandContext* pCmdCtx );
//FELIX_CHANGE_END
 
#include "TD_PackPop.h"
 
#endif //#ifndef _ODEDCOMMANDSTACK_H_INCLUDED_