CFx SDK Documentation  2020SP3
Public Member Functions | Protected Member Functions | List of all members
CFxUIMenuItem Class Referenceabstract

#include <FxUI.h>

Public Member Functions

virtual const CFxStringGetUID () const =0
 
virtual void SetUID (const CFxString &strUID)=0
 
virtual const CFxStringGetName () const =0
 
virtual void SetName (const CFxString &name)=0
 
virtual OdArray< CFxString > & GetAliases ()=0
 
virtual void AddAlias (const CFxString &sAlias)=0
 
virtual void SetDefinition (CFxUIItemDefinition *pDefinition)=0
 
virtual CFxUIItemDefinitionGetDefinition ()=0
 
virtual const CFxUIMenuItemGetParent () const =0
 
virtual CFxUIMenuItemCollectionGetChildren ()=0
 
virtual bool IsAction () const =0
 
virtual bool IsSeparator () const =0
 
virtual void SetToSeparator ()=0
 
virtual CFxUI::MenuType GetType () const =0
 
virtual void SetType (CFxUI::MenuType type)=0
 
virtual bool IsObsolete () const =0
 
virtual void SetObsolete (bool bObsolete)=0
 
virtual bool IsRuntime () const =0
 

Protected Member Functions

virtual ~CFxUIMenuItem ()
 

Detailed Description

Description: Represents the menu item of the user interface. Library: DDKERNEL

Definition at line 1944 of file FxUI.h.

Constructor & Destructor Documentation

◆ ~CFxUIMenuItem()

virtual CFxUIMenuItem::~CFxUIMenuItem ( )
inlineprotectedvirtual

Definition at line 1947 of file FxUI.h.

Member Function Documentation

◆ AddAlias()

virtual void CFxUIMenuItem::AddAlias ( const CFxString sAlias)
pure virtual

Description: Adds an alias. Arguments:

Parameters
sAliasThe alias.

◆ GetAliases()

virtual OdArray<CFxString>& CFxUIMenuItem::GetAliases ( )
pure virtual

Description: Gets the aliases.

Return Value: The aliases.

◆ GetChildren()

virtual CFxUIMenuItemCollection* CFxUIMenuItem::GetChildren ( )
pure virtual

Description: Gets the children of this item.

Return Value: null if it fails, else the children.

◆ GetDefinition()

virtual CFxUIItemDefinition* CFxUIMenuItem::GetDefinition ( )
pure virtual

Description: Gets the definition.

Return Value: null if it fails, else the definition.

◆ GetName()

virtual const CFxString& CFxUIMenuItem::GetName ( ) const
pure virtual

Description: Gets the name.

Return Value: The name.

◆ GetParent()

virtual const CFxUIMenuItem* CFxUIMenuItem::GetParent ( ) const
pure virtual

Description: Gets the parent of this item.

Return Value: null if it fails, else the parent.

◆ GetType()

virtual CFxUI::MenuType CFxUIMenuItem::GetType ( ) const
pure virtual

Description: Gets the type.

Return Value: The type.

◆ GetUID()

virtual const CFxString& CFxUIMenuItem::GetUID ( ) const
pure virtual

Description: Gets the uid.

Return Value: The uid.

◆ IsAction()

virtual bool CFxUIMenuItem::IsAction ( ) const
pure virtual

Description: Query if this object is action.

Return Value: true if action, false if not.

◆ IsObsolete()

virtual bool CFxUIMenuItem::IsObsolete ( ) const
pure virtual

Description: Query if this object is obsolete.

Return Value: true if obsolete, false if not.

◆ IsRuntime()

virtual bool CFxUIMenuItem::IsRuntime ( ) const
pure virtual

Description: Query if this object is runtime.

Return Value: true if runtime, false if not.

◆ IsSeparator()

virtual bool CFxUIMenuItem::IsSeparator ( ) const
pure virtual

Description: Query if this object is separator.

Return Value: true if separator, false if not.

◆ SetDefinition()

virtual void CFxUIMenuItem::SetDefinition ( CFxUIItemDefinition pDefinition)
pure virtual

Description: Sets a definition. Arguments:

Parameters
[in,out]pDefinitionIf non-null, the definition.

◆ SetName()

virtual void CFxUIMenuItem::SetName ( const CFxString name)
pure virtual

Description: Sets a name. Arguments:

Parameters
nameThe name.

◆ SetObsolete()

virtual void CFxUIMenuItem::SetObsolete ( bool  bObsolete)
pure virtual

Description: Sets an obsolete. Arguments:

Parameters
bObsoletetrue to obsolete.

◆ SetToSeparator()

virtual void CFxUIMenuItem::SetToSeparator ( )
pure virtual

Description: Sets to separator.

◆ SetType()

virtual void CFxUIMenuItem::SetType ( CFxUI::MenuType  type)
pure virtual

Description: Sets a type. Arguments:

Parameters
typeThe type.

◆ SetUID()

virtual void CFxUIMenuItem::SetUID ( const CFxString strUID)
pure virtual

Description: Sets a uid. Arguments:

Parameters
strUIDThe string uid.

The documentation for this class was generated from the following file: