CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
CFxUIDockableWindow Class Referenceabstract

#include <FxUI.h>

Public Member Functions

virtual ~CFxUIDockableWindow ()
 
virtual bool GetShow () const =0
 
virtual void SetShow (bool bShow)=0
 
virtual CFxUI::Orientation GetAvailableOrientations () const =0
 
virtual CFxUI::Orientation GetOrientation () const =0
 
virtual bool SetOrientation (CFxUI::Orientation orientation)=0
 
virtual bool GetAllowDocking () const =0
 
virtual void SetAllowDocking (bool bDockable)=0
 
virtual const CFxStringGetName () const =0
 
virtual const CFxStringGetObjectName () const =0
 
virtual const CFxStringGetDescription () const =0
 
virtual const CFxStringGetIconResPath () const =0
 

Detailed Description

Description: Represents the dockable window of the user interface. Library: DDKERNEL

Definition at line 2655 of file FxUI.h.

Constructor & Destructor Documentation

◆ ~CFxUIDockableWindow()

virtual CFxUIDockableWindow::~CFxUIDockableWindow ( )
inlinevirtual

Definition at line 2658 of file FxUI.h.

Member Function Documentation

◆ GetAllowDocking()

virtual bool CFxUIDockableWindow::GetAllowDocking ( ) const
pure virtual

Description: Gets the allow docking.
Return Value:
True if it succeeds, false if it fails.

◆ GetAvailableOrientations()

virtual CFxUI::Orientation CFxUIDockableWindow::GetAvailableOrientations ( ) const
pure virtual

Description: Gets the available orientations. Return Value:
The available orientations.

◆ GetDescription()

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

Description: Gets the description. Return Value:
The description.

◆ GetIconResPath()

virtual const CFxString & CFxUIDockableWindow::GetIconResPath ( ) const
pure virtual

Description: Gets the icon resource path. Return Value:
The icon resource path.

◆ GetName()

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

Description: Gets the name. Return Value:
The name.

◆ GetObjectName()

virtual const CFxString & CFxUIDockableWindow::GetObjectName ( ) const
pure virtual

Description: Gets the object name (case-insensitive). Return Value:
The object name (case-insensitive).

◆ GetOrientation()

virtual CFxUI::Orientation CFxUIDockableWindow::GetOrientation ( ) const
pure virtual

Description: Gets the orientation. Return Value:
The orientation.

◆ GetShow()

virtual bool CFxUIDockableWindow::GetShow ( ) const
pure virtual

Description: Gets the show.
Return Value:
True if it succeeds, false if it fails.

◆ SetAllowDocking()

virtual void CFxUIDockableWindow::SetAllowDocking ( bool bDockable)
pure virtual

Description: Sets an allow docking. Arguments:

Parameters
bDockabletrue if dockable.

◆ SetOrientation()

virtual bool CFxUIDockableWindow::SetOrientation ( CFxUI::Orientation orientation)
pure virtual

Description: Sets an orientation. Arguments:

Parameters
orientationThe orientation. Return Value:
True if it succeeds, false if it fails.

◆ SetShow()

virtual void CFxUIDockableWindow::SetShow ( bool bShow)
pure virtual

Description: Sets a show. Arguments:

Parameters
bShowtrue to show, false to hide.

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