3ds Max C++ API Reference
Loading...
Searching...
No Matches
ActionContext Class Reference

An ActionContext is an identifier of a group of keyboard shortcuts. More...

#include <C:/adskgit/3dsmax/3dsmax/3dswin/src/maxsdk/include/actiontable_REMOTE_92.h>

Inheritance diagram for ActionContext:

Public Types

enum  ActionContextFps {
  kGetName , kGetContextId , kIsActive , kGetName ,
  kGetContextId , kIsActive , kGetName , kGetContextId ,
  kIsActive , kGetName , kGetContextId , kIsActive ,
  kGetName , kGetContextId , kIsActive
}
enum  ActionContextFps {
  kGetName , kGetContextId , kIsActive , kGetName ,
  kGetContextId , kIsActive , kGetName , kGetContextId ,
  kIsActive , kGetName , kGetContextId , kIsActive ,
  kGetName , kGetContextId , kIsActive
}
enum  ActionContextFps {
  kGetName , kGetContextId , kIsActive , kGetName ,
  kGetContextId , kIsActive , kGetName , kGetContextId ,
  kIsActive , kGetName , kGetContextId , kIsActive ,
  kGetName , kGetContextId , kIsActive
}
enum  ActionContextFps {
  kGetName , kGetContextId , kIsActive , kGetName ,
  kGetContextId , kIsActive , kGetName , kGetContextId ,
  kIsActive , kGetName , kGetContextId , kIsActive ,
  kGetName , kGetContextId , kIsActive
}
enum  ActionContextFps {
  kGetName , kGetContextId , kIsActive , kGetName ,
  kGetContextId , kIsActive , kGetName , kGetContextId ,
  kIsActive , kGetName , kGetContextId , kIsActive ,
  kGetName , kGetContextId , kIsActive
}
Public Types inherited from BaseInterface
enum  LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

Public Member Functions

 ActionContext (ActionContextId contextId, const MSTR &pName)
 Initialize the context ID and the name from the passed arguments.
const MSTR & GetName ()
 Returns the name of this ActionContext.
ActionContextId GetContextId ()
 Returns the ID of this ActionContext.
bool IsActive ()
 Returns true if this ActionContext is active; otherwise false.
void SetActive (bool active)
 Sets the active state of this ActionContext.
CoreExport FPInterfaceDesc * GetDescByID (Interface_ID id)
CoreExport FPInterfaceDesc * GetDesc ()
virtual CoreExport BaseInterface * GetInterface (Interface_ID id)
virtual CoreExport Interface_ID GetID ()
 ActionContext (ActionContextId contextId, const MSTR &pName)
 Initialize the context ID and the name from the passed arguments.
const MSTR & GetName ()
 Returns the name of this ActionContext.
ActionContextId GetContextId ()
 Returns the ID of this ActionContext.
bool IsActive ()
 Returns true if this ActionContext is active; otherwise false.
void SetActive (bool active)
 Sets the active state of this ActionContext.
CoreExport FPInterfaceDesc * GetDescByID (Interface_ID id)
CoreExport FPInterfaceDesc * GetDesc ()
virtual CoreExport BaseInterface * GetInterface (Interface_ID id)
virtual CoreExport Interface_ID GetID ()
 ActionContext (ActionContextId contextId, const MSTR &pName)
 Initialize the context ID and the name from the passed arguments.
const MSTR & GetName ()
 Returns the name of this ActionContext.
ActionContextId GetContextId ()
 Returns the ID of this ActionContext.
bool IsActive ()
 Returns true if this ActionContext is active; otherwise false.
void SetActive (bool active)
 Sets the active state of this ActionContext.
CoreExport FPInterfaceDesc * GetDescByID (Interface_ID id)
CoreExport FPInterfaceDesc * GetDesc ()
virtual CoreExport BaseInterface * GetInterface (Interface_ID id)
virtual CoreExport Interface_ID GetID ()
 ActionContext (ActionContextId contextId, const MSTR &pName)
 Initialize the context ID and the name from the passed arguments.
const MSTR & GetName ()
 Returns the name of this ActionContext.
ActionContextId GetContextId ()
 Returns the ID of this ActionContext.
bool IsActive ()
 Returns true if this ActionContext is active; otherwise false.
void SetActive (bool active)
 Sets the active state of this ActionContext.
CoreExport FPInterfaceDesc * GetDescByID (Interface_ID id)
CoreExport FPInterfaceDesc * GetDesc ()
virtual CoreExport BaseInterface * GetInterface (Interface_ID id)
virtual CoreExport Interface_ID GetID ()
 ActionContext (ActionContextId contextId, const MSTR &pName)
 Initialize the context ID and the name from the passed arguments.
const MSTR & GetName ()
 Returns the name of this ActionContext.
ActionContextId GetContextId ()
 Returns the ID of this ActionContext.
bool IsActive ()
 Returns true if this ActionContext is active; otherwise false.
void SetActive (bool active)
 Sets the active state of this ActionContext.
CoreExport FPInterfaceDesc * GetDescByID (Interface_ID id)
CoreExport FPInterfaceDesc * GetDesc ()
virtual CoreExport BaseInterface * GetInterface (Interface_ID id)
virtual CoreExport Interface_ID GetID ()
Public Member Functions inherited from FPMixinInterface
 FPMixinInterface ()
virtual LifetimeType LifetimeControl ()
virtual CoreExport bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
CoreExport ~FPMixinInterface ()
Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
virtual FPStatus Invoke (FunctionID fid, FPParams *params)
virtual CoreExport FPStatus Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
virtual FPStatus Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
virtual CoreExport FunctionID FindFn (const MCHAR *name)
virtual CoreExport BOOL IsEnabled (FunctionID actionID)
virtual CoreExport BOOL IsChecked (FunctionID actionID)
virtual CoreExport BOOL IsVisible (FunctionID actionID)
virtual CoreExport FunctionID GetIsEnabled (FunctionID actionID)
virtual CoreExport FunctionID GetIsChecked (FunctionID actionID)
virtual CoreExport FunctionID GetIsVisible (FunctionID actionID)
virtual ActionTable * GetActionTable ()
virtual void EnableActions (BOOL onOff)
Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor.
virtual BaseInterface * AcquireInterface ()
virtual void ReleaseInterface ()
virtual void DeleteInterface ()
virtual BaseInterface * CloneInterface (void *remapDir=nullptr)
Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor.
template<class InterfaceType>
InterfaceType * GetTypedInterface ()

Protected Member Functions

 RO_PROP_FN (kGetName, GetName, TYPE_TSTR_BR)
 RO_PROP_FN (kGetContextId, GetContextId, TYPE_DWORD)
 RO_PROP_FN (kIsActive, IsActive, TYPE_bool)
 RO_PROP_FN (kGetName, GetName, TYPE_TSTR_BR)
 RO_PROP_FN (kGetContextId, GetContextId, TYPE_DWORD)
 RO_PROP_FN (kIsActive, IsActive, TYPE_bool)
 RO_PROP_FN (kGetName, GetName, TYPE_TSTR_BR)
 RO_PROP_FN (kGetContextId, GetContextId, TYPE_DWORD)
 RO_PROP_FN (kIsActive, IsActive, TYPE_bool)
 RO_PROP_FN (kGetName, GetName, TYPE_TSTR_BR)
 RO_PROP_FN (kGetContextId, GetContextId, TYPE_DWORD)
 RO_PROP_FN (kIsActive, IsActive, TYPE_bool)
 RO_PROP_FN (kGetName, GetName, TYPE_TSTR_BR)
 RO_PROP_FN (kGetContextId, GetContextId, TYPE_DWORD)
 RO_PROP_FN (kIsActive, IsActive, TYPE_bool)
Protected Member Functions inherited from FPMixinInterface
 FPMixinInterface (const FPMixinInterface &rhs)
FPMixinInterface & operator= (const FPMixinInterface &rhs)
Protected Member Functions inherited from FPInterface
virtual FPStatus _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)
Protected Member Functions inherited from Noncopyable
 Noncopyable ()
 ~Noncopyable ()

Additional Inherited Members

Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void * operator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void * operator new (size_t size, const std::nothrow_t &e)
 Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
static UtilExport void * operator new (size_t size, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void * operator new (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void * operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
static UtilExport void * operator new (size_t size, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
static UtilExport void * operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
static UtilExport void * operator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void * operator new[] (size_t size, const std::nothrow_t &e)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void * operator new[] (size_t size, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void * operator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects.
static UtilExport void * operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void * operator new[] (size_t size, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void * operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void operator delete (void *ptr)
 Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
static UtilExport void operator delete (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void operator delete (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void operator delete (void *ptr, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
static UtilExport void operator delete[] (void *ptr)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
static UtilExport void operator delete[] (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void operator delete[] (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void operator delete[] (void *ptr, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void * operator new (size_t size, void *placement_ptr)
 Placement new operator.
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator.
static UtilExport void * aligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary.
static UtilExport void * aligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary.
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.
Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc nullInterface
Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > * interfaceNotifyCBs

Detailed Description

An ActionContext is an identifier of a group of keyboard shortcuts.

An ActionContext is an identifer of a group of keyboard shortcuts.

Examples are the Main 3ds Max UI, Track View, and the Editable Mesh. They are registered using IActionManager::RegisterActionContext().

See also
Class ActionTable, Class ActionItem, Class ActionCallback, Class IActionManager, Class Interface.

Examples are the Main 3ds Max UI, Track View, and the Editable Mesh. They are registered using IActionManager::RegisterActionContext().

<<<<<<< HEAD

Version
4.0

autotoc_md2

See also
Class ActionTable, Class ActionItem, Class ActionCallback, Class IActionManager, Class Interface.
Class ActionTable, Class ActionItem, Class ActionCallback, Class IActionManager, Class DynamicMenu, Class DynamicMenuCallback, Class Interface.

a406e112cf287e51abdbba7f88b8e4b91e0a64e7

Examples are the Main 3ds Max UI, Track View, and the Editable Mesh. They are registered using IActionManager::RegisterActionContext().

Version
4.0
See also
Class ActionTable, Class ActionItem, Class ActionCallback, Class IActionManager, Class DynamicMenu, Class DynamicMenuCallback, Class Interface.

Examples are the Main 3ds Max UI, Track View, and the Editable Mesh. They are registered using IActionManager::RegisterActionContext().

Version
4.0
See also
Class ActionTable, Class ActionItem, Class ActionCallback, Class IActionManager, Class Interface.

Examples are the Main 3ds Max UI, Track View, and the Editable Mesh. They are registered using IActionManager::RegisterActionContext().

See also
Class ActionTable, Class ActionItem, Class ActionCallback, Class IActionManager, Class DynamicMenu, Class DynamicMenuCallback, Class Interface.

Member Enumeration Documentation

◆ ActionContextFps [1/5]

enum ActionContextFps
Enumerator
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
908 {
909 kGetName,
910 kGetContextId,
911 kIsActive,
912 };
ActionContext::kIsActive
@ kIsActive
Definition actiontable.h:911
ActionContext::kGetContextId
@ kGetContextId
Definition actiontable.h:910
ActionContext::kGetName
@ kGetName
Definition actiontable.h:909

◆ ActionContextFps [2/5]

enum ActionContextFps
Enumerator
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
935 {
936 kGetName,
937 kGetContextId,
938 kIsActive,
939 };

◆ ActionContextFps [3/5]

enum ActionContextFps
Enumerator
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
845 {
846 kGetName,
847 kGetContextId,
848 kIsActive,
849 };

◆ ActionContextFps [4/5]

enum ActionContextFps
Enumerator
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
912 {
913 kGetName,
914 kGetContextId,
915 kIsActive,
916 };

◆ ActionContextFps [5/5]

enum ActionContextFps
Enumerator
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
kGetName 
kGetContextId 
kIsActive 
848 {
849 kGetName,
850 kGetContextId,
851 kIsActive,
852 };

Constructor & Destructor Documentation

◆ ActionContext() [1/5]

ActionContext ( ActionContextId contextId,
const MSTR & pName )
inline

Initialize the context ID and the name from the passed arguments.

Parameters
contextIdThe ID for the ActionContext.
pNameThe name for the ActionContext.
879 : mName(pName)
880 { mContextId = contextId; mActive = true; }

◆ ActionContext() [2/5]

ActionContext ( ActionContextId contextId,
const MSTR & pName )
inline

Initialize the context ID and the name from the passed arguments.

Parameters
contextIdThe ID for the ActionContext.
pNameThe name for the ActionContext.
906 : mName(pName)
907 { mContextId = contextId; mActive = true; }

◆ ActionContext() [3/5]

ActionContext ( ActionContextId contextId,
const MSTR & pName )
inline

Initialize the context ID and the name from the passed arguments.

Parameters
contextIdThe ID for the ActionContext.
pNameThe name for the ActionContext.
816 : mName(pName)
817 { mContextId = contextId; mActive = true; }

◆ ActionContext() [4/5]

ActionContext ( ActionContextId contextId,
const MSTR & pName )
inline

Initialize the context ID and the name from the passed arguments.

Parameters
contextIdThe ID for the ActionContext.
pNameThe name for the ActionContext.
883 : mName(pName)
884 { mContextId = contextId; mActive = true; }

◆ ActionContext() [5/5]

ActionContext ( ActionContextId contextId,
const MSTR & pName )
inline

Initialize the context ID and the name from the passed arguments.

Parameters
contextIdThe ID for the ActionContext.
pNameThe name for the ActionContext.
819 : mName(pName)
820 { mContextId = contextId; mActive = true; }

Member Function Documentation

◆ GetName() [1/5]

const MSTR & GetName ( )
inline

Returns the name of this ActionContext.

883{ return mName; }

◆ GetContextId() [1/5]

ActionContextId GetContextId ( )
inline

Returns the ID of this ActionContext.

886{ return mContextId; }

◆ IsActive() [1/5]

bool IsActive ( )
inline

Returns true if this ActionContext is active; otherwise false.

An active ActionContext means that it uses its keyboard accelerators. This corresponds to the "Active" checkbox in the keyboard customization UI.

892{ return mActive; }

◆ SetActive() [1/5]

void SetActive ( bool active)
inline

Sets the active state of this ActionContext.

Parameters
activetrue for active; false for inactive.
896{ mActive = active; }

◆ GetDescByID() [1/5]

CoreExport FPInterfaceDesc * GetDescByID ( Interface_ID id)
virtual
Remarks
This method is used to directly implement FPInterface::GetDesc() in your public virtual base mixin class, like this;

FPInterfaceDesc* GetDesc() { return GetDescByID(THIS_INTERFACE_ID); }

Then implement a GetDescByID() in the implementing class to avoid link export issues.
Parameters:
Interface_ID id

The unique interface ID by which to get the FPInterfaceDesc.
Default Implementation:
{ return &nullInterface; }

Reimplemented from FPMixinInterface.

◆ GetDesc() [1/5]

CoreExport FPInterfaceDesc * GetDesc ( )
virtual
Remarks
Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

◆ GetInterface() [1/5]

virtual CoreExport BaseInterface * GetInterface ( Interface_ID id)
virtual
Remarks
Returns a pointer to the interface whose ID is specified.
Parameters:
Interface_ID id

The ID of the interface to return.
Default Implementation:
{ return NULL; }

Reimplemented from FPMixinInterface.

◆ GetID() [1/5]

virtual CoreExport Interface_ID GetID ( )
virtual
Remarks
This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.
Returns
The Interface_ID.
Default Implementation:
{ return GetDesc()->ID; }

Reimplemented from FPMixinInterface.

◆ RO_PROP_FN() [1/15]

RO_PROP_FN ( kGetName ,
GetName ,
TYPE_TSTR_BR  )
protected

◆ RO_PROP_FN() [2/15]

RO_PROP_FN ( kGetContextId ,
GetContextId ,
TYPE_DWORD  )
protected

◆ RO_PROP_FN() [3/15]

RO_PROP_FN ( kIsActive ,
IsActive ,
TYPE_bool  )
protected

◆ GetName() [2/5]

const MSTR & GetName ( )
inline

Returns the name of this ActionContext.

910{ return mName; }

◆ GetContextId() [2/5]

ActionContextId GetContextId ( )
inline

Returns the ID of this ActionContext.

913{ return mContextId; }

◆ IsActive() [2/5]

bool IsActive ( )
inline

Returns true if this ActionContext is active; otherwise false.

An active ActionContext means that it uses its keyboard accelerators. This corresponds to the "Active" checkbox in the keyboard customization UI.

919{ return mActive; }

◆ SetActive() [2/5]

void SetActive ( bool active)
inline

Sets the active state of this ActionContext.

Parameters
activetrue for active; false for inactive.
923{ mActive = active; }

◆ GetDescByID() [2/5]

CoreExport FPInterfaceDesc * GetDescByID ( Interface_ID id)
virtual
Remarks
This method is used to directly implement FPInterface::GetDesc() in your public virtual base mixin class, like this;

FPInterfaceDesc* GetDesc() { return GetDescByID(THIS_INTERFACE_ID); }

Then implement a GetDescByID() in the implementing class to avoid link export issues.
Parameters:
Interface_ID id

The unique interface ID by which to get the FPInterfaceDesc.
Default Implementation:
{ return &nullInterface; }

Reimplemented from FPMixinInterface.

◆ GetDesc() [2/5]

CoreExport FPInterfaceDesc * GetDesc ( )
virtual
Remarks
Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

◆ GetInterface() [2/5]

virtual CoreExport BaseInterface * GetInterface ( Interface_ID id)
virtual
Remarks
Returns a pointer to the interface whose ID is specified.
Parameters:
Interface_ID id

The ID of the interface to return.
Default Implementation:
{ return NULL; }

Reimplemented from FPMixinInterface.

◆ GetID() [2/5]

virtual CoreExport Interface_ID GetID ( )
virtual
Remarks
This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.
Returns
The Interface_ID.
Default Implementation:
{ return GetDesc()->ID; }

Reimplemented from FPMixinInterface.

◆ RO_PROP_FN() [4/15]

RO_PROP_FN ( kGetName ,
GetName ,
TYPE_TSTR_BR  )
protected

◆ RO_PROP_FN() [5/15]

RO_PROP_FN ( kGetContextId ,
GetContextId ,
TYPE_DWORD  )
protected

◆ RO_PROP_FN() [6/15]

RO_PROP_FN ( kIsActive ,
IsActive ,
TYPE_bool  )
protected

◆ GetName() [3/5]

const MSTR & GetName ( )
inline

Returns the name of this ActionContext.

820{ return mName; }

◆ GetContextId() [3/5]

ActionContextId GetContextId ( )
inline

Returns the ID of this ActionContext.

823{ return mContextId; }

◆ IsActive() [3/5]

bool IsActive ( )
inline

Returns true if this ActionContext is active; otherwise false.

An active ActionContext means that it uses its keyboard accelerators. This corresponds to the "Active" checkbox in the keyboard customization UI.

829{ return mActive; }

◆ SetActive() [3/5]

void SetActive ( bool active)
inline

Sets the active state of this ActionContext.

Parameters
activetrue for active; false for inactive.
833{ mActive = active; }

◆ GetDescByID() [3/5]

CoreExport FPInterfaceDesc * GetDescByID ( Interface_ID id)
virtual
Remarks
This method is used to directly implement FPInterface::GetDesc() in your public virtual base mixin class, like this;

FPInterfaceDesc* GetDesc() { return GetDescByID(THIS_INTERFACE_ID); }

Then implement a GetDescByID() in the implementing class to avoid link export issues.
Parameters:
Interface_ID id

The unique interface ID by which to get the FPInterfaceDesc.
Default Implementation:
{ return &nullInterface; }

Reimplemented from FPMixinInterface.

◆ GetDesc() [3/5]

CoreExport FPInterfaceDesc * GetDesc ( )
virtual
Remarks
Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

◆ GetInterface() [3/5]

virtual CoreExport BaseInterface * GetInterface ( Interface_ID id)
virtual
Remarks
Returns a pointer to the interface whose ID is specified.
Parameters:
Interface_ID id

The ID of the interface to return.
Default Implementation:
{ return NULL; }

Reimplemented from FPMixinInterface.

◆ GetID() [3/5]

virtual CoreExport Interface_ID GetID ( )
virtual
Remarks
This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.
Returns
The Interface_ID.
Default Implementation:
{ return GetDesc()->ID; }

Reimplemented from FPMixinInterface.

◆ RO_PROP_FN() [7/15]

RO_PROP_FN ( kGetName ,
GetName ,
TYPE_TSTR_BR  )
protected

◆ RO_PROP_FN() [8/15]

RO_PROP_FN ( kGetContextId ,
GetContextId ,
TYPE_DWORD  )
protected

◆ RO_PROP_FN() [9/15]

RO_PROP_FN ( kIsActive ,
IsActive ,
TYPE_bool  )
protected

◆ GetName() [4/5]

const MSTR & GetName ( )
inline

Returns the name of this ActionContext.

887{ return mName; }

◆ GetContextId() [4/5]

ActionContextId GetContextId ( )
inline

Returns the ID of this ActionContext.

890{ return mContextId; }

◆ IsActive() [4/5]

bool IsActive ( )
inline

Returns true if this ActionContext is active; otherwise false.

An active ActionContext means that it uses its keyboard accelerators. This corresponds to the "Active" checkbox in the keyboard customization UI.

896{ return mActive; }

◆ SetActive() [4/5]

void SetActive ( bool active)
inline

Sets the active state of this ActionContext.

Parameters
activetrue for active; false for inactive.
900{ mActive = active; }

◆ GetDescByID() [4/5]

CoreExport FPInterfaceDesc * GetDescByID ( Interface_ID id)
virtual
Remarks
This method is used to directly implement FPInterface::GetDesc() in your public virtual base mixin class, like this;

FPInterfaceDesc* GetDesc() { return GetDescByID(THIS_INTERFACE_ID); }

Then implement a GetDescByID() in the implementing class to avoid link export issues.
Parameters:
Interface_ID id

The unique interface ID by which to get the FPInterfaceDesc.
Default Implementation:
{ return &nullInterface; }

Reimplemented from FPMixinInterface.

◆ GetDesc() [4/5]

CoreExport FPInterfaceDesc * GetDesc ( )
virtual
Remarks
Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

◆ GetInterface() [4/5]

virtual CoreExport BaseInterface * GetInterface ( Interface_ID id)
virtual
Remarks
Returns a pointer to the interface whose ID is specified.
Parameters:
Interface_ID id

The ID of the interface to return.
Default Implementation:
{ return NULL; }

Reimplemented from FPMixinInterface.

◆ GetID() [4/5]

virtual CoreExport Interface_ID GetID ( )
virtual
Remarks
This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.
Returns
The Interface_ID.
Default Implementation:
{ return GetDesc()->ID; }

Reimplemented from FPMixinInterface.

◆ RO_PROP_FN() [10/15]

RO_PROP_FN ( kGetName ,
GetName ,
TYPE_TSTR_BR  )
protected

◆ RO_PROP_FN() [11/15]

RO_PROP_FN ( kGetContextId ,
GetContextId ,
TYPE_DWORD  )
protected

◆ RO_PROP_FN() [12/15]

RO_PROP_FN ( kIsActive ,
IsActive ,
TYPE_bool  )
protected

◆ GetName() [5/5]

const MSTR & GetName ( )
inline

Returns the name of this ActionContext.

823{ return mName; }

◆ GetContextId() [5/5]

ActionContextId GetContextId ( )
inline

Returns the ID of this ActionContext.

826{ return mContextId; }

◆ IsActive() [5/5]

bool IsActive ( )
inline

Returns true if this ActionContext is active; otherwise false.

An active ActionContext means that it uses its keyboard accelerators. This corresponds to the "Active" checkbox in the keyboard customization UI.

832{ return mActive; }

◆ SetActive() [5/5]

void SetActive ( bool active)
inline

Sets the active state of this ActionContext.

Parameters
activetrue for active; false for inactive.
836{ mActive = active; }

◆ GetDescByID() [5/5]

CoreExport FPInterfaceDesc * GetDescByID ( Interface_ID id)
virtual
Remarks
This method is used to directly implement FPInterface::GetDesc() in your public virtual base mixin class, like this;

FPInterfaceDesc* GetDesc() { return GetDescByID(THIS_INTERFACE_ID); }

Then implement a GetDescByID() in the implementing class to avoid link export issues.
Parameters:
Interface_ID id

The unique interface ID by which to get the FPInterfaceDesc.
Default Implementation:
{ return &nullInterface; }

Reimplemented from FPMixinInterface.

◆ GetDesc() [5/5]

CoreExport FPInterfaceDesc * GetDesc ( )
virtual
Remarks
Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

◆ GetInterface() [5/5]

virtual CoreExport BaseInterface * GetInterface ( Interface_ID id)
virtual
Remarks
Returns a pointer to the interface whose ID is specified.
Parameters:
Interface_ID id

The ID of the interface to return.
Default Implementation:
{ return NULL; }

Reimplemented from FPMixinInterface.

◆ GetID() [5/5]

virtual CoreExport Interface_ID GetID ( )
virtual
Remarks
This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.
Returns
The Interface_ID.
Default Implementation:
{ return GetDesc()->ID; }

Reimplemented from FPMixinInterface.

◆ RO_PROP_FN() [13/15]

RO_PROP_FN ( kGetName ,
GetName ,
TYPE_TSTR_BR  )
protected

◆ RO_PROP_FN() [14/15]

RO_PROP_FN ( kGetContextId ,
GetContextId ,
TYPE_DWORD  )
protected

◆ RO_PROP_FN() [15/15]

RO_PROP_FN ( kIsActive ,
IsActive ,
TYPE_bool  )
protected