CFx SDK Documentation  2020SP3
Public Types | Public Member Functions | List of all members
CFxStatusBar Class Referenceabstract

#include <FxStatusBar.h>

Public Types

enum  SubElementId { eCoords = 1 }
 

Public Member Functions

 CFxStatusBar (void)
 
virtual ~CFxStatusBar (void)
 
virtual void StartProgressor (const CFxString &displayString)=0
 
virtual void StopProgressor ()=0
 
virtual void MeterProgress (double dPos)=0
 
virtual CFxString GetText (bool useLeftLabel) const =0
 
virtual void SetText (const CFxString &text, bool useLeftLabel)=0
 
virtual void RefreshCoords (const OdGePoint3d &point, bool isInsideCommand, const OdGePoint3d *pBasePoint=0)=0
 
virtual CFxWidgetGetFxWidget ()=0
 
virtual FxWId GetWindowHandle () const =0
 
virtual CFxWidgetGetSubControl (SubElementId id) const =0
 

Detailed Description

Description: Represents the status bar. Library: DDKERNEL

Definition at line 31 of file FxStatusBar.h.

Member Enumeration Documentation

◆ SubElementId

Enumerator
eCoords 

Definition at line 99 of file FxStatusBar.h.

Constructor & Destructor Documentation

◆ CFxStatusBar()

CFxStatusBar::CFxStatusBar ( void  )

◆ ~CFxStatusBar()

virtual CFxStatusBar::~CFxStatusBar ( void  )
virtual

Member Function Documentation

◆ GetFxWidget()

virtual CFxWidget* CFxStatusBar::GetFxWidget ( )
pure virtual

Description: Returns QWidget object Arguments:

◆ GetSubControl()

virtual CFxWidget* CFxStatusBar::GetSubControl ( SubElementId  id) const
pure virtual

◆ GetText()

virtual CFxString CFxStatusBar::GetText ( bool  useLeftLabel) const
pure virtual

Description: Gets a text. Arguments:

Parameters
useLeftLabeltrue to use left label.

Return Value: The text.

◆ GetWindowHandle()

virtual FxWId CFxStatusBar::GetWindowHandle ( ) const
pure virtual

Description: Returns the window handle.

◆ MeterProgress()

virtual void CFxStatusBar::MeterProgress ( double  dPos)
pure virtual

Description: Meter progress. Arguments:

Parameters
dPosThe position.

◆ RefreshCoords()

virtual void CFxStatusBar::RefreshCoords ( const OdGePoint3d point,
bool  isInsideCommand,
const OdGePoint3d pBasePoint = 0 
)
pure virtual

Description: Refreshes coordinates in the status bar. Arguments:

Parameters
pointThe point.
isInsideCommandtrue if this object is inside command.
pBasePoint(optional) the base point.

◆ SetText()

virtual void CFxStatusBar::SetText ( const CFxString text,
bool  useLeftLabel 
)
pure virtual

Description: Sets a text. Arguments:

Parameters
textThe text.
useLeftLabeltrue to use left label.

◆ StartProgressor()

virtual void CFxStatusBar::StartProgressor ( const CFxString displayString)
pure virtual

Description: Starts a progressor. Arguments:

Parameters
displayStringThe display string.

◆ StopProgressor()

virtual void CFxStatusBar::StopProgressor ( )
pure virtual

Description: Stop progressor.


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