FxCommand.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted, 
// provided that the above copyright notice appears in all copies and 
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting 
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS. 
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH 
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "FxPragmaPush.h"
 
#include "DDKERNEL.h"
 
#include <Ed/EdCommandStack.h>
 
 
class CFxCommandContext;
class CFxString;
class CFxDocument;
class CFxUserIO;
class CFxView;
class CFxSelectionSet;

class DDKERNEL_API CFxCommand : public OdEdCommand
{
public:

    enum
    {
        kNoSelectionSetModifications = 0x04000000,
        kViewOperation               = 0x08000000,
        kHidden                      = 0x10000000,
        kDisabledInRefedit           = 0x20000000,
        kApplicationContext          = 0x40000000,
        kExecuteStartup              = 0x80000000,
        kHiddenHistory               = 0x00040000,
        kDisabledInActionRecording   = 0x00001000,
        kDimMoveEnabled              = 0x00002000,
        kHiddenInAutoComplete        = 0x00004000,
        kReadOnlyMode                = 0x00008000,
        kNoCommandOutput             = 0x00000100,
        kUseHoverSelection           = 0x00000200
    };
 
    /* {secret} */
    ~CFxCommand();

    const OdString groupName() const override;

    virtual int Execute( CFxCommandContext* pFxCmdCtx) = 0;

    void execute( OdEdCommandContext* pCmdCtx ) override;

    void undefine( bool undefIt ) override;

    OdInt32 flags() const override;

    bool HasFlag( OdInt32 flag ) const;
    static CFxString GetBuiltInGroupName();
    static CFxString GetLISPGroupName( const CFxDocument* pDocument );
    virtual void Help() const;
    static void OpenHelp();

    virtual unsigned int GetHelpId() const;

    virtual const OdString displayName() const;
 
protected:
    CFxCommand();

    void AddFlags( OdInt32 flags );

    void RemoveFlags( OdInt32 flags );

    void SetFlags( OdInt32 flags );

    bool HasFlag( OdInt32 flag );
 
    OdInt32 m_Flags;
};

DDKERNEL_API CFxSelectionSet* CreateSelectionSet( OdEdCommandContext* pCmdCtx );
 
#include "FxPragmaPop.h"