CFx SDK Documentation  2023 SP0
Public Member Functions | Protected Member Functions | List of all members
CFxUIImageItem 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 const CFxStringGetUITitleName () const =0
 
virtual void SetUITitleName (const CFxString &titlename)=0
 
virtual const CFxStringGetImageLibFile () const =0
 
virtual void SetImageLibFile (const CFxString &imagelibname)=0
 
virtual const CFxStringGetImageName () const =0
 
virtual void SetImageName (const CFxString &imagename)=0
 
virtual void SetDefinition (CFxUIItemDefinition *pDefinition)=0
 
virtual CFxUIItemDefinitionGetDefinition ()=0
 
virtual bool IsObsolete () const =0
 
virtual void SetObsolete (bool bObsolete)=0
 
virtual const CFxUIImageItemGetParent () const =0
 
virtual CFxUIImageItemCollectionGetChildren ()=0
 
virtual bool IsSeparator () const =0
 
virtual void SetToSeparator ()=0
 
virtual bool IsRuntime () const =0
 
virtual int GetColumns () const =0
 
virtual void SetColumns (int iColumns)=0
 
virtual int GetRows () const =0
 
virtual void SetRows (int iRows)=0
 

Protected Member Functions

virtual ~CFxUIImageItem ()
 

Detailed Description

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

Definition at line 3068 of file FxUI.h.

Constructor & Destructor Documentation

◆ ~CFxUIImageItem()

virtual CFxUIImageItem::~CFxUIImageItem ( )
inlineprotectedvirtual

Definition at line 3071 of file FxUI.h.

Member Function Documentation

◆ GetChildren()

virtual CFxUIImageItemCollection* CFxUIImageItem::GetChildren ( )
pure virtual

Description: Gets the children of this item.

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

◆ GetColumns()

virtual int CFxUIImageItem::GetColumns ( ) const
pure virtual

Description: Gets number of columns for the image menu item.

Return Value: The number of columns.

◆ GetDefinition()

virtual CFxUIItemDefinition* CFxUIImageItem::GetDefinition ( )
pure virtual

Description: Gets the definition.

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

◆ GetImageLibFile()

virtual const CFxString& CFxUIImageItem::GetImageLibFile ( ) const
pure virtual

Description: Gets Image library file name

Return Value: Tile Image library file name.

◆ GetImageName()

virtual const CFxString& CFxUIImageItem::GetImageName ( ) const
pure virtual

Description: Gets Image name

Return Value: Tile Image name.

◆ GetName()

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

Description: Gets Image menu name

Return Value: Image menu name.

◆ GetParent()

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

Description: Gets the parent of this item.

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

◆ GetRows()

virtual int CFxUIImageItem::GetRows ( ) const
pure virtual

Description: Gets number of rows for the image menu item.

Return Value: The number of rows.

◆ GetUID()

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

Description: Gets the uid.

Return Value: The uid.

◆ GetUITitleName()

virtual const CFxString& CFxUIImageItem::GetUITitleName ( ) const
pure virtual

Description: Gets Image Tile Menu Dialog Title name

Return Value: Tile Menu Dialog Title name.

◆ IsObsolete()

virtual bool CFxUIImageItem::IsObsolete ( ) const
pure virtual

Description: Query if this object is obsolete.

Return Value: true if obsolete, false if not.

◆ IsRuntime()

virtual bool CFxUIImageItem::IsRuntime ( ) const
pure virtual

Description: Query if this object is runtime.

Return Value: true if runtime, false if not.

◆ IsSeparator()

virtual bool CFxUIImageItem::IsSeparator ( ) const
pure virtual

Description: Query if this object is separator.

Return Value: true if separator, false if not.

◆ SetColumns()

virtual void CFxUIImageItem::SetColumns ( int  iColumns)
pure virtual

Description: Sets the number of columns for the image menu item. Arguments:

Parameters
iColumnsThe number of columns.

◆ SetDefinition()

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

Description: Sets a definition. Arguments:

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

◆ SetImageLibFile()

virtual void CFxUIImageItem::SetImageLibFile ( const CFxString imagelibname)
pure virtual

Description: Sets Image library file name. Arguments:

Parameters
imagelibnameTile Image library file name.

◆ SetImageName()

virtual void CFxUIImageItem::SetImageName ( const CFxString imagename)
pure virtual

Description: Sets Image name. Arguments:

Parameters
imagenameTile Image name.

◆ SetName()

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

Description: Sets image menu name. Arguments:

Parameters
nameThe image menu name.

◆ SetObsolete()

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

Description: Sets an obsolete. Arguments:

Parameters
bObsoletetrue to obsolete.

◆ SetRows()

virtual void CFxUIImageItem::SetRows ( int  iRows)
pure virtual

Description: Sets the number of rows for the image menu item. Arguments:

Parameters
iRowsThe rows of columns.

◆ SetToSeparator()

virtual void CFxUIImageItem::SetToSeparator ( )
pure virtual

Description: Sets to separator.

◆ SetUID()

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

Description: Sets a uid. Arguments:

Parameters
strUIDThe string uid.

◆ SetUITitleName()

virtual void CFxUIImageItem::SetUITitleName ( const CFxString titlename)
pure virtual

Description: Sets Image Tile Menu Dialog Title name. Arguments:

Parameters
titlenameTile Menu Dialog Title name.

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