Command.h File Reference

#include <list>
#include <map>
#include <string>
#include <vector>
#include <Base/Type.h>

Go to the source code of this file.

Classes
class	Gui::Command
	The Command class. More...
class	Gui::CommandBase
	The CommandBase class This lightweigt class is the base class of all commands in FreeCAD. More...
class	Gui::CommandManager
	The CommandManager class This class manage all available commands in FreeCAD. More...
class	Gui::MacroCommand
	The script command class This is a special type of command class. More...
class	Gui::PythonCommand
	The Python command class This is a special type of command class. More...
Namespaces
namespace	App
	The namespace of the FreeCAD Aplication layer library.
namespace	Gui
	The namespace of the FreeCAD Graphical interface layer library.
Defines
#define	DEF_3DV_CMD(X)
	The Command Macro view This macro makes it easier to define a new command for the 3D View It activate the command only when a 3DView is active.
#define	DEF_STD_CMD(X)
	The Command Macro Standard This macro makes it easier to define a new command.
#define	DEF_STD_CMD_A(X)
	The Command Macro Standard + isActive() This macro makes it easier to define a new command.
#define	DEF_STD_CMD_AC(X)
	The Command Macro Standard + isActive() + createAction() This macro makes it easier to define a new command.
#define	DEF_STD_CMD_ACL(X)
	The Command Macro Standard + isActive() + createAction() + languageChange() This macro makes it easier to define a new command.
#define	DEF_STD_CMD_C(X)
	The Command Macro Standard + createAction() This macro makes it easier to define a new command.
Typedefs
typedef struct _object	PyObject
Functions
void	Gui::CreateDocCommands (void)
void	Gui::CreateFeatCommands (void)
void	Gui::CreateMacroCommands (void)
void	Gui::CreateStdCommands (void)
void	Gui::CreateTestCommands (void)
void	Gui::CreateViewStdCommands (void)
void	Gui::CreateWindowStdCommands (void)

---

Define Documentation

#define DEF_3DV_CMD

(

X

)

Value:

class X : public Gui::Command \
{\
public:\
    X();\
    virtual ~X(){}\
    virtual const char* className() const\
    { return #X; }\
protected: \
    virtual void activated(int iMsg);\
    virtual bool isActive(void)\
    {\
        Gui::MDIView* view = Gui::getMainWindow()->activeWindow();\
        return view && view->isDerivedFrom(Gui::View3DInventor::getClassTypeId());\
    }\
};

The Command Macro view This macro makes it easier to define a new command for the 3D View It activate the command only when a 3DView is active.

The parameters are the class name

Author:

Jürgen Riegel

Definition at line 563 of file Command.h.

#define DEF_STD_CMD

(

X

)

Value:

class X : public Gui::Command \
{\
public:\
    X();\
    virtual const char* className() const\
    { return #X; }\
protected: \
    virtual void activated(int iMsg);\
};

The Command Macro Standard This macro makes it easier to define a new command.

The parameters are the class name.

Author:

Jürgen Riegel

Definition at line 475 of file Command.h.

#define DEF_STD_CMD_A

(

X

)

Value:

class X : public Gui::Command \
{\
public:\
    X();\
    virtual ~X(){}\
    virtual const char* className() const\
    { return #X; }\
protected: \
    virtual void activated(int iMsg);\
    virtual bool isActive(void);\
};

The Command Macro Standard + isActive() This macro makes it easier to define a new command.

The parameters are the class name

Author:

Jürgen Riegel

Definition at line 490 of file Command.h.

#define DEF_STD_CMD_AC

(

X

)

Value:

class X : public Gui::Command \
{\
public:\
    X();\
    virtual ~X(){}\
    virtual const char* className() const\
    { return #X; }\
protected: \
    virtual void activated(int iMsg);\
    virtual bool isActive(void);\
    virtual Gui::Action * createAction(void);\
};

The Command Macro Standard + isActive() + createAction() This macro makes it easier to define a new command.

The parameters are the class name

Author:

Werner Mayer

Definition at line 524 of file Command.h.

#define DEF_STD_CMD_ACL

(

X

)

Value:

class X : public Gui::Command \
{\
public:\
    X();\
    virtual ~X(){}\
    virtual void languageChange(); \
    virtual const char* className() const\
    { return #X; }\
protected: \
    virtual void activated(int iMsg);\
    virtual bool isActive(void);\
    virtual Gui::Action * createAction(void);\
};

The Command Macro Standard + isActive() + createAction() + languageChange() This macro makes it easier to define a new command.

The parameters are the class name

Author:

Werner Mayer

Definition at line 543 of file Command.h.

#define DEF_STD_CMD_C

(

X

)

Value:

class X : public Gui::Command \
{\
public:\
    X();\
    virtual ~X(){}\
    virtual const char* className() const\
    { return #X; }\
protected: \
    virtual void activated(int iMsg);\
    virtual Gui::Action * createAction(void);\
};

The Command Macro Standard + createAction() This macro makes it easier to define a new command.

The parameters are the class name

Author:

Jürgen Riegel

Definition at line 507 of file Command.h.

---

Typedef Documentation

typedef struct _object PyObject

Definition at line 36 of file Command.h.