command processor and intializing and event handling classes specific for wxDocview. More...

#include "wx/list.h"
#include "wx/event.h"
#include "wx/cmdproc.h"
#include <wx/module.h>
#include "wx/general/a2dlist.h"
#include "wx/general/gen.h"
#include <map>

Include dependency graph for comevt.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	a2dCommandId
	Each a2dCommand is given a command id at construction. More...

class	a2dCommand
	a base command for the a2dCommandProcessor More...

class	a2dCommandException
	For exceptions thrown from commands. More...

class	a2dCommandGroup
	a group of commands, used to group commands together for undo/redo More...

class	a2dCommand_SetProperty
	used to change a property on objects More...

class	a2dPropertyEditEvent
	see a2dCommandProcessorEvent More...

class	a2dCommandProcessorEvent
	Event sent to a2dCommandProcessor. More...

class	a2dCommandProcessor
	base command processor More...

class	a2dSmrtPtrWrap< T >
	help class which makes it possible to store a smart pointer as a wxObject* More...

class	a2dGeneralGlobal
	One Global instance of this class exists, in order to get to global needed objects. More...

class	a2dGeneralModule
	initializes the general module More...

class	a2dCommand_SetVariable
	Set a string variable inside wxDocview. More...

class	a2dCommand_SetVariable::Args

struct	a2dCommand_SetVariable::Args::argValuet

struct	a2dCommand_SetVariable::Args::argSett

class	a2dCommand_SetEnvironmentVariable
	Set a environment variable. More...

class	a2dCommand_SetEnvironmentVariable::Args

struct	a2dCommand_SetEnvironmentVariable::Args::argValuet

struct	a2dCommand_SetEnvironmentVariable::Args::argSett

class	a2dCommand_GetVariable
	Get internal variable. More...

class	a2dCommand_GetVariable::Args

struct	a2dCommand_GetVariable::Args::argValuet

struct	a2dCommand_GetVariable::Args::argSett

class	a2dCommand_GetEnvVariable
	Get internal variable. More...

class	a2dCommand_GetEnvVariable::Args

struct	a2dCommand_GetEnvVariable::Args::argValuet

struct	a2dCommand_GetEnvVariable::Args::argSett

class	a2dMenuIdItem
	store a menu Id generated by XRCID( menuIdString ) plus a menustring and helpstring More...

Macros
#define	EVT_BUTTON_ANY(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_BUTTON_CLICKED, wxID_ANY, wxID_ANY, (wxObjectEventFunction) static_cast < wxCommandEventFunction > ( & func ), (wxObject *) NULL ),
	wxEvtHandler macro

#define	EVT_CHOICE_ANY(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_CHOICE_SELECTED, wxID_ANY, wxID_ANY, (wxObjectEventFunction) static_cast < wxCommandEventFunction > ( & func ), (wxObject *) NULL ),
	wxEvthandler macro

#define	EVT_PROPOBJECT_EDITPROPERTIES_EVENT(func) DECLARE_EVENT_TABLE_ENTRY( a2dEVT_PROPOBJECT_EDITPROPERTIES_EVENT, wxID_ANY, wxID_ANY, (wxObjectEventFunction) static_cast < a2dPropertyEditEventFunctionEvt > ( & func ), (wxObject *) NULL ),
	static event table macro for NON a2dCanvasObject when editing properties for wxEvtHandler

#define	EVT_DO(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_DO, wxID_ANY, wxID_ANY, (wxObjectEventFunction) static_cast< wxCommandProcessorEventFunction > (& func), (wxObject *) NULL ),
	event sent from a2DocumentCommandProcessor when a command is initially done

#define	EVT_UNDO(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_UNDO, wxID_ANY, wxID_ANY, (wxObjectEventFunction) static_cast< wxCommandProcessorEventFunction > (& func), (wxObject *) NULL ),
	event sent from a2DocumentCommandProcessor when a command is undone

#define	EVT_REDO(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_REDO, wxID_ANY, wxID_ANY, (wxObjectEventFunction) static_cast< wxCommandProcessorEventFunction > (& func), (wxObject *) NULL ),
	event sent from a2DocumentCommandProcessor when a command is redone

#define	EVT_MENUSTRINGS(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MENUSTRINGS, wxID_ANY, wxID_ANY, (wxObjectEventFunction) static_cast< wxCommandProcessorEventFunction > (& func), (wxObject *) NULL ),
	event sent to a2dCommandProcessorEvents to adjust menu strings (e.g. for current undo/redo command)

#define	EVT_MODIFIES(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MODIFIES, wxID_ANY, wxID_ANY, (wxObjectEventFunction) static_cast< wxCommandProcessorEventFunction > (& func), (wxObject *) NULL ),
	event sent to a2dCommandProcessorEvents to set modified flag of a document or drawing flag.

#define	EVT_BEGINBUSY(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_BEGINBUSY, wxID_ANY, wxID_ANY, (wxObjectEventFunction) static_cast< wxCommandProcessorEventFunction > (& func), (wxObject *) NULL ),
	event sent from a2DocumentCommandProcessor when a command submit/execute is starting

#define	EVT_ENDBUSY(func) DECLARE_EVENT_TABLE_ENTRY( wxEVT_ENDBUSY, wxID_ANY, wxID_ANY, (wxObjectEventFunction) static_cast< wxCommandProcessorEventFunction > (& func), (wxObject *) NULL ),
	event sent from a2DocumentCommandProcessor when a command submit/execute is ending

#define	A2D_ARGUMENT_SETTER(TYPE, ARGUMENT_NAME)

#define	DECLARE_MENU_ITEMID(menuName) extern a2dMenuIdItem& menuName() ;

#define	DEFINE_MENU_ITEMID(menuName, menuText, menuHelp)

#define	DEFINE_MENU_ITEMID_KIND(menuName, menuText, menuHelp, kind)

#define	DECLARE_EXPORTED_EVTIDFUNC(expdecl, eventName)

#define	DECLARE_EVTIDFUNC(eventName)

#define	DEFINE_EVTIDFUNC(eventName)

Typedefs
typedef a2dSmrtPtr< a2dCommand >	a2dCommandPtr

typedef class A2DGENERALDLLEXP a2dSmrtPtrList< a2dCommand >	a2dCommandList
	a list of commands used by the command processor or command groups

typedef void(wxEvtHandler::*	a2dPropertyEditEventFunctionEvt )(a2dPropertyEditEvent &)
	event function for a2dPropertyEditEvent

typedef void(wxEvtHandler::*	wxCommandProcessorEventFunction )(a2dCommandProcessorEvent &)

typedef a2dSmrtPtrWrap < a2dCommand >	a2dCommandStore

typedef std::map< wxString, a2dMenuIdItem * >	a2dMenuIdItemMap

Functions
	WX_DECLARE_HASH_MAP_WITH_DECL (wxString, a2dCommandId *, wxStringHash, wxStringEqual, a2dHashMapCommandIds, class A2DGENERALDLLEXP)
	This hash table is used for a2dCommandId with name.

	A2DGENERALDLLEXP_DATA (extern a2dSmrtPtr< a2dGeneralGlobal >) a2dGeneralGlobals
	only instance of a2dGeneralGlobal, to get to settings for dynamic variables and errors.

Variables
class A2DGENERALDLLEXP	a2dCommandProcessor

class A2DGENERALDLLEXP	a2dCommandId

class A2DGENERALDLLEXP	a2dHashMapCommandIds

class A2DGENERALDLLEXP	a2dHashMapCommandIds_wxImplementation_HashTable

class A2DGENERALDLLEXP	a2dHashMapCommandIds_wxImplementation_KeyEx

class A2DGENERALDLLEXP	a2dMenuIdItem

Detailed Description

command processor and intializing and event handling classes specific for wxDocview.

wxDocview has its own event handling classes which are almost equal to the wxWidgets ones. But had to be duplicated to be able to have a a2dObject at the top the class tree. So things like an a2dCanvasObject can be serialized, even if it can handle events.

a2dGeneralGlobal is the class for storing basic stuff like error messages and application wide variables.

a2dCommandProcessor is the basic class on which command processing is based.

Author: Klaas Holwerda

Date: Created 05/07/03

Copyright: 2001-2004 (C) Klaas Holwerda

Licence: wxWidgets licence

RCS-ID:

Id:: comevt.h,v 1.76 2009/08/23 19:49:38 titato Exp

Definition in file comevt.h.

Macro Definition Documentation

#define A2D_ARGUMENT_SETTER	(	TYPE,
		ARGUMENT_NAME
	)

Value:

Args & \
    ARGUMENT_NAME( const TYPE& arg) { \
        this->argValue.ARGUMENT_NAME = arg; \
        this->argSet.ARGUMENT_NAME = true; \
        return *this; \
    }

Definition at line 1265 of file comevt.h.

#define DECLARE_EVTIDFUNC ( eventName )

Value:

DECLARE_EVENT_TYPE( eventName, 1 ) \

extern wxEventType& GETID_##eventName();

Definition at line 1707 of file comevt.h.

#define DECLARE_EXPORTED_EVTIDFUNC	(	expdecl,
		eventName
	)

Value:

DECLARE_EXPORTED_EVENT_TYPE( expdecl, eventName, 1 ) \

extern wxEventType& GETID_##eventName();

Definition at line 1702 of file comevt.h.

#define DEFINE_EVTIDFUNC ( eventName )

Value:

wxEventType& GETID_##eventName() \
{ \
    static wxEventType type = wxNewEventType(); \
    return type; \
} \
const wxEventType eventName = GETID_##eventName();

Definition at line 1711 of file comevt.h.

#define DEFINE_MENU_ITEMID	(	menuName,
		menuText,
		menuHelp
	)

Value:

a2dMenuIdItem& menuName() \
{ \
    static a2dMenuIdItem item( wxT(#menuName), menuText, menuHelp ); \
    return item; \
}

Definition at line 1690 of file comevt.h.

#define DEFINE_MENU_ITEMID_KIND	(	menuName,
		menuText,
		menuHelp,
		kind
	)

Value:

a2dMenuIdItem& menuName () \
{ \
    static a2dMenuIdItem item( wxT(#menuName), menuText, menuHelp, (kind) ); \
    return item; \
}

Definition at line 1696 of file comevt.h.

Typedef Documentation

typedef a2dSmrtPtrWrap< a2dCommand > a2dCommandStore

used to connect a command to a wxObject The wxObject derived class, holds a smart pointer to a command. The wxObject can be stored as m_callbackUserData in events.

Definition at line 1075 of file comevt.h.

Classes

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

Typedef Documentation