CFx SDK Documentation  2023 SP0
Public Member Functions | Protected Member Functions | List of all members
CFxUIItemDefinition Class Referenceabstract

#include <FxUI.h>

Public Member Functions

virtual void SetID (const CFxString &sId)=0
 
virtual const CFxStringGetID () const =0
 
virtual CFxUIContextGetContext ()=0
 
virtual const CFxStringGetName () const =0
 
virtual void SetName (const CFxString &name)=0
 
virtual const CFxStringGetCommand () const =0
 
virtual void SetCommand (const CFxString &command)=0
 
virtual QIcon & GetIcon (int iSize)=0
 
virtual QIcon & GetDarkIcon (int iSize)=0
 
virtual QIcon & GetLightIcon (int iSize)=0
 
virtual const CFxStringGetDarkIconInfo (CFxString &iconResource) const =0
 
virtual void SetDarkIconInfo (const CFxString &iconName, const CFxString &iconResource)=0
 
virtual const CFxStringGetLightIconInfo (CFxString &iconResource) const =0
 
virtual void SetLightIconInfo (const CFxString &iconName, const CFxString &iconResource)=0
 
virtual const CFxStringGetDescription () const =0
 
virtual void SetDescription (const CFxString &description)=0
 
virtual bool IsObsolete () const =0
 
virtual void SetObsolete (bool bObsolete)=0
 
virtual bool IsRuntime () const =0
 

Protected Member Functions

virtual ~CFxUIItemDefinition ()
 

Detailed Description

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

Definition at line 1791 of file FxUI.h.

Constructor & Destructor Documentation

◆ ~CFxUIItemDefinition()

virtual CFxUIItemDefinition::~CFxUIItemDefinition ( )
inlineprotectedvirtual

Definition at line 1794 of file FxUI.h.

Member Function Documentation

◆ GetCommand()

virtual const CFxString& CFxUIItemDefinition::GetCommand ( ) const
pure virtual

Description: Gets the command.

Return Value: The command.

◆ GetContext()

virtual CFxUIContext* CFxUIItemDefinition::GetContext ( )
pure virtual

Description: Gets the context.

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

◆ GetDarkIcon()

virtual QIcon& CFxUIItemDefinition::GetDarkIcon ( int  iSize)
pure virtual

Description: Gets the dark theme SVG icon.

Return Value: The dark theme SVG icon.

◆ GetDarkIconInfo()

virtual const CFxString& CFxUIItemDefinition::GetDarkIconInfo ( CFxString iconResource) const
pure virtual

Description: Gets a dark theme SVG icon information. Arguments:

Parameters
[in,out]iconResourceThe icon resource.

Return Value: The dark theme SVG icon information.

◆ GetDescription()

virtual const CFxString& CFxUIItemDefinition::GetDescription ( ) const
pure virtual

Description: Gets the description.

Return Value: The description.

◆ GetIcon()

virtual QIcon& CFxUIItemDefinition::GetIcon ( int  iSize)
pure virtual

Description: Gets the SVG icon according to current style.

Return Value: The SVG icon.

◆ GetID()

virtual const CFxString& CFxUIItemDefinition::GetID ( ) const
pure virtual

Description: Gets the identifier.

Return Value: The identifier.

◆ GetLightIcon()

virtual QIcon& CFxUIItemDefinition::GetLightIcon ( int  iSize)
pure virtual

Description: Gets the light theme SVG icon.

Return Value: The light theme SVG icon.

◆ GetLightIconInfo()

virtual const CFxString& CFxUIItemDefinition::GetLightIconInfo ( CFxString iconResource) const
pure virtual

Description: Gets a light theme SVG icon information. Arguments:

Parameters
[in,out]iconResourceThe icon resource.

Return Value: The light theme SVG icon information.

◆ GetName()

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

Description: Gets the name.

Return Value: The name.

◆ IsObsolete()

virtual bool CFxUIItemDefinition::IsObsolete ( ) const
pure virtual

Description: Query if this object is obsolete.

Return Value: true if obsolete, false if not.

◆ IsRuntime()

virtual bool CFxUIItemDefinition::IsRuntime ( ) const
pure virtual

Description: Query if this object is runtime.

Return Value: true if runtime, false if not.

◆ SetCommand()

virtual void CFxUIItemDefinition::SetCommand ( const CFxString command)
pure virtual

Description: Sets a command. Arguments:

Parameters
commandThe command.

◆ SetDarkIconInfo()

virtual void CFxUIItemDefinition::SetDarkIconInfo ( const CFxString iconName,
const CFxString iconResource 
)
pure virtual

Description: Sets a dark theme SVG icon information. Arguments:

Parameters
iconNameName of the icon.
iconResourceThe dark theme SVG icon resource.

◆ SetDescription()

virtual void CFxUIItemDefinition::SetDescription ( const CFxString description)
pure virtual

Description: Sets a description. Arguments:

Parameters
descriptionThe description.

◆ SetID()

virtual void CFxUIItemDefinition::SetID ( const CFxString sId)
pure virtual

Description: Sets an identifier. Arguments:

Parameters
sIdThe identifier.

◆ SetLightIconInfo()

virtual void CFxUIItemDefinition::SetLightIconInfo ( const CFxString iconName,
const CFxString iconResource 
)
pure virtual

Description: Sets a light theme SVG icon information. Arguments:

Parameters
iconNameName of the icon.
iconResourceThe icon resource.

◆ SetName()

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

Description: Sets a name. Arguments:

Parameters
nameThe name.

◆ SetObsolete()

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

Description: Sets an obsolete. Arguments:

Parameters
bObsoletetrue to obsolete.

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