CFxUIToolbarItem Class Reference

#include <FxUI.h>

Public Member Functions
virtual const CFxString &	GetUID () const =0
virtual void	SetUID (const CFxString &strUID)=0
virtual const CFxString &	GetName () 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 CFxUIItemDefinition *	GetDefinition ()=0
virtual const CFxUIToolbarItem *	GetParent () const =0
virtual CFxUIToolbarItemCollection *	GetChildren ()=0
virtual CFxUI::ToolbarType	GetType () const =0
virtual bool	IsAction () const =0
virtual bool	IsSeparator () const =0
virtual void	SetToSeparator ()=0
virtual bool	GetOnByDefault () const =0
virtual void	SetOnByDefault (bool bOnByDefault)=0
virtual CFxUI::Orientation	GetOrientation () const =0
virtual void	SetOrientation (CFxUI::Orientation orientation)=0
virtual bool	GetMovable () const =0
virtual void	SetMovable (bool bMovable)=0
virtual int	GetDefXLocation () const =0
virtual void	SetDefXLocation (int iXLocation)=0
virtual int	GetDefYLocation () const =0
virtual void	SetDefYLocation (int iYLocation)=0
virtual bool	IsInMatrixToolbar () const =0
virtual void	SetInMatrixToolbar (bool bInMatrixToolbar)=0
virtual int	GetMatrixToolbarIndex () const =0
virtual void	SetMatrixToolbarIndex (int index)=0
virtual bool	IsExpanded () const =0
virtual void	SetExpanded (bool bIsExpanded)=0
virtual int	GetRows () const =0
virtual void	SetRows (int iRows)=0
virtual bool	IsObsolete () const =0
virtual void	SetObsolete (bool bObsolete)=0
virtual const CFxString &	GetFlyoutID () const =0
virtual void	SetFlyoutID (CFxString flyoutID)=0
virtual int	GetDockRow () const =0
virtual void	SetDockRow (int iDockRow)=0
virtual int	GetDockColumn () const =0
virtual void	SetDockColumn (int iDockColumn)=0
virtual bool	IsRuntime () const =0

Protected Member Functions
virtual	~CFxUIToolbarItem ()

Detailed Description

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

Definition at line 2097 of file FxUI.h.

Constructor & Destructor Documentation

~CFxUIToolbarItem()

virtual CFxUIToolbarItem::~CFxUIToolbarItem ( )

inlineprotectedvirtual

Definition at line 2100 of file FxUI.h.

Member Function Documentation

AddAlias()

virtual void CFxUIToolbarItem::AddAlias ( const CFxString &  sAlias )

pure virtual

Description: Adds an alias. Arguments:

Parameters

sAlias

The alias.

GetAliases()

virtual OdArray<CFxString>& CFxUIToolbarItem::GetAliases ( )

pure virtual

Description: Gets the aliases.

Return Value: The aliases.

GetChildren()

virtual CFxUIToolbarItemCollection* CFxUIToolbarItem::GetChildren ( )

pure virtual

Description: Gets the children of this item.

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

GetDefinition()

virtual CFxUIItemDefinition* CFxUIToolbarItem::GetDefinition ( )

pure virtual

Description: Gets the definition.

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

GetDefXLocation()

virtual int CFxUIToolbarItem::GetDefXLocation ( ) const

pure virtual

Description: Gets the def x coordinate location.

Return Value: The def x coordinate location.

GetDefYLocation()

virtual int CFxUIToolbarItem::GetDefYLocation ( ) const

pure virtual

Description: Gets the def y coordinate location.

Return Value: The def y coordinate location.

GetDockColumn()

virtual int CFxUIToolbarItem::GetDockColumn ( ) const

pure virtual

GetDockRow()

virtual int CFxUIToolbarItem::GetDockRow ( ) const

pure virtual

GetFlyoutID()

virtual const CFxString& CFxUIToolbarItem::GetFlyoutID ( ) const

pure virtual

Description: Gets the flyout identifier.

Return Value: The flyout identifier.

GetMatrixToolbarIndex()

virtual int CFxUIToolbarItem::GetMatrixToolbarIndex ( ) const

pure virtual

Description: Gets the matrix toolbar index.

Return Value: The matrix toolbar index.

GetMovable()

virtual bool CFxUIToolbarItem::GetMovable ( ) const

pure virtual

Description: Gets the movable.

Return Value: true if it succeeds, false if it fails.

GetName()

virtual const CFxString& CFxUIToolbarItem::GetName ( ) const

pure virtual

Description: Gets the name.

Return Value: The name.

GetOnByDefault()

virtual bool CFxUIToolbarItem::GetOnByDefault ( ) const

pure virtual

Description: Gets the on by default.

Return Value: true if it succeeds, false if it fails.

GetOrientation()

virtual CFxUI::Orientation CFxUIToolbarItem::GetOrientation ( ) const

pure virtual

Description: Gets the orientation.

Return Value: The orientation.

GetParent()

virtual const CFxUIToolbarItem* CFxUIToolbarItem::GetParent ( ) const

pure virtual

Description: Gets the parent of this item.

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

GetRows()

virtual int CFxUIToolbarItem::GetRows ( ) const

pure virtual

Description: Gets the rows.

Return Value: The rows.

GetType()

virtual CFxUI::ToolbarType CFxUIToolbarItem::GetType ( ) const

pure virtual

Description: Gets the type.

Return Value: The type.

GetUID()

virtual const CFxString& CFxUIToolbarItem::GetUID ( ) const

pure virtual

Description: Gets the uid.

Return Value: The uid.

IsAction()

virtual bool CFxUIToolbarItem::IsAction ( ) const

pure virtual

Description: Query if this object is action.

Return Value: true if action, false if not.

IsExpanded()

virtual bool CFxUIToolbarItem::IsExpanded ( ) const

pure virtual

Description: Query if this object is expanded.

Return Value: true if expanded, false if not.

IsInMatrixToolbar()

virtual bool CFxUIToolbarItem::IsInMatrixToolbar ( ) const

pure virtual

Description: Query if this object is in matrix toolbar.

Return Value: true if in matrix toolbar, false if not.

IsObsolete()

virtual bool CFxUIToolbarItem::IsObsolete ( ) const

pure virtual

Description: Query if this object is obsolete.

Return Value: true if obsolete, false if not.

IsRuntime()

virtual bool CFxUIToolbarItem::IsRuntime ( ) const

pure virtual

Description: Query if this object is runtime.

Return Value: true if runtime, false if not.

IsSeparator()

virtual bool CFxUIToolbarItem::IsSeparator ( ) const

pure virtual

Description: Query if this object is separator.

Return Value: true if separator, false if not.

SetDefinition()

virtual void CFxUIToolbarItem::SetDefinition ( CFxUIItemDefinition *  pDefinition )

pure virtual

Description: Sets a definition. Arguments:

Parameters

[in,out]

pDefinition

If non-null, the definition.

SetDefXLocation()

virtual void CFxUIToolbarItem::SetDefXLocation ( int  iXLocation )

pure virtual

Description: Sets a def x coordinate location. Arguments:

Parameters

iXLocation

Zero-based index of the x coordinate location.

SetDefYLocation()

virtual void CFxUIToolbarItem::SetDefYLocation ( int  iYLocation )

pure virtual

Description: Sets a def y coordinate location. Arguments:

Parameters

iYLocation

Zero-based index of the y coordinate location.

SetDockColumn()

virtual void CFxUIToolbarItem::SetDockColumn ( int  iDockColumn )

pure virtual

SetDockRow()

virtual void CFxUIToolbarItem::SetDockRow ( int  iDockRow )

pure virtual

SetExpanded()

virtual void CFxUIToolbarItem::SetExpanded ( bool  bIsExpanded )

pure virtual

Description: Sets an expanded. Arguments:

Parameters

bIsExpanded

true if this object is expanded.

SetFlyoutID()

virtual void CFxUIToolbarItem::SetFlyoutID ( CFxString  flyoutID )

pure virtual

Description: Sets a flyout identifier. Arguments:

Parameters

flyoutID

Identifier for the flyout.

SetInMatrixToolbar()

virtual void CFxUIToolbarItem::SetInMatrixToolbar ( bool  bInMatrixToolbar )

pure virtual

Description: Sets an in matrix toolbar. Arguments:

Parameters

bInMatrixToolbar

true to in matrix toolbar.

SetMatrixToolbarIndex()

virtual void CFxUIToolbarItem::SetMatrixToolbarIndex ( int  index )

pure virtual

Description: Sets a matrix toolbar index. Arguments:

Parameters

index

Zero-based index of the.

SetMovable()

virtual void CFxUIToolbarItem::SetMovable ( bool  bMovable )

pure virtual

Description: Sets a movable. Arguments:

Parameters

bMovable

true if movable.

SetName()

virtual void CFxUIToolbarItem::SetName ( const CFxString &  name )

pure virtual

Description: Sets a name. Arguments:

Parameters

name

The name.

SetObsolete()

virtual void CFxUIToolbarItem::SetObsolete ( bool  bObsolete )

pure virtual

Description: Sets an obsolete. Arguments:

Parameters

bObsolete

true to obsolete.

SetOnByDefault()

virtual void CFxUIToolbarItem::SetOnByDefault ( bool  bOnByDefault )

pure virtual

Description: Sets an on by default. Arguments:

Parameters

bOnByDefault

true to on by default.

SetOrientation()

virtual void CFxUIToolbarItem::SetOrientation ( CFxUI::Orientation  orientation )

pure virtual

Description: Sets an orientation. Arguments:

Parameters

orientation

The orientation.

SetRows()

virtual void CFxUIToolbarItem::SetRows ( int  iRows )

pure virtual

Description: Sets the rows. Arguments:

Parameters

iRows

Zero-based index of the rows.

SetToSeparator()

virtual void CFxUIToolbarItem::SetToSeparator ( )

pure virtual

Description: Sets to separator.

SetUID()

virtual void CFxUIToolbarItem::SetUID ( const CFxString &  strUID )

pure virtual

Description: Sets a uid. Arguments:

Parameters

strUID

The string uid.

---

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

• FxUI.h