CFxUIDockWidget Class Reference

#include <FxUIDockWidget.h>

Inheritance diagram for CFxUIDockWidget:

Public Member Functions
	CFxUIDockWidget (int iArea)
virtual	~CFxUIDockWidget ()
void	setWidget (CFxUIBaseView *widget)
CFxUIBaseView *	widget ()
const CFxUIBaseView *	widget () const
void	setTitle (const CFxUIString &title)
void	raise ()
virtual void	showEvent (CFxUIShowEvent *e)
virtual void	hideEvent (CFxUIHideEvent *e)
Public Member Functions inherited from CFxUIBaseView
	CFxUIBaseView ()
virtual	~CFxUIBaseView ()
void	setDisabled (bool on)
void	setEnabled (bool on)
bool	isEnabled () const
CFxUIPalette::ColorRole	backgroundRole ()
void	setPalette (const CFxUIPalette &)
const CFxUIPalette &	palette () const
bool	isVisible ()
void	setVisible (bool bVisible)
bool	hasFocus () const
void	setFocus ()
void	setFocus (int iReason)
void	setFocusPolicy (int iPolicy)
int	width ()
void	setWidth (int w)
int	height ()
void	setHeight (int h)
void	update ()
void	setBusyState (bool bBusy=false)
void	resize (int w, int h)
void	setCornerRadius (float radius)
void	setBorderWidth (float width)
void	setBorderWidth (float left, float top, float right, float bottom)
void	setBorderColor (int r, int g, int b)
virtual void	paintEvent (CFxUIPaintEvent *event)
virtual void	resizeEvent (CFxUIResizeEvent *event)
virtual void	focusInEvent (CFxUIFocusEvent *focusInEvent)
virtual void	focusOutEvent (CFxUIFocusEvent *focusOutEvent)
void	setEventAccepted (bool bAccepted=false)
void	addView (CFxUIBaseView *pChild, float fWeight=0.0)
void	insertView (CFxUIBaseView *pChild, int index=0, float fWeight=0.0)
int	indexOf (CFxUIBaseView *pChild)
void	removeView (CFxUIBaseView *pChild)
void	setPreferableSize (int w, int h)
void	setMinimumWidth (int iWidth)
void	setMinimumHeight (int iHeight)
void	setMinimumSize (const CFxUISize &size)
void	setMaximumWidth (int iWidth)
void	setMaximumHeight (int iHeight)
void	setMaximumSize (const CFxUISize &size)
int	minimumWidth ()
int	minimumHeight ()
int	maximumWidth ()
int	maximumHeight ()
void	setToolTip (const CFxUIString &sToolTip)
const CFxUIString	toolTip ()
CFxUISignal< void(void)> &	aboutToPassEventToParent ()
CFxUISignal< void(void)> &	aboutToShow ()
CFxUISignal< void(void)> &	hoverEnter ()
CFxUISignal< void(void)> &	hoverLeave ()
Public Member Functions inherited from CFxUIObject
	CFxUIObject ()
virtual	~CFxUIObject ()
FxNativeHandle	getHandle () const
void	setHandle (FxNativeHandle handle)
void	setParent (CFxUIObject *parent)
CFxUIObject *	parent ()
const CFxUIObject *	parent () const
void	setObjectName (const CFxUIString &objectName)
CFxUIString	objectName () const
bool	setProperty (const char *name, const CFxUIVariant &value)
CFxUIVariant	property (const char *name)
CFxUIList< CFxUIObject * >	children () const
template<typename T >
CFxUIList< T >	findChildren (const CFxUIString &name=CFxUIString())
void	blockSignals (bool block)
bool	signalsBlocked () const

Additional Inherited Members
Public Types inherited from CFxUIBaseView
enum	TextAlignment {   AlignLeft = 0x0001 , AlignRight = 0x0002 , AlignHCenter = 0x0004 , AlignJustify = 0x0008 ,   AlignTop = 0x0020 , AlignBottom = 0x0040 , AlignVCenter = 0x0080 , AlignBaseline = 0x0100 ,   AlignCenter = AlignVCenter | AlignHCenter }
enum	FocusPolicyType {   eNoFocus = 0 , eTabFocus = 0x1 , eClickFocus = 0x2 , eStrongFocus = eTabFocus | eClickFocus | 0x8 ,   eWheelFocus = eStrongFocus | 0x4 , eKeyboardOnSetfocus = 0x10 }
enum	UIWidthSizePolicy {   eXS = 0 , eS , eM , eL ,   eXL }
Static Public Member Functions inherited from CFxUIBaseView
static void	setTabOrder (CFxUIObject *first, CFxUIObject *second)
Protected Member Functions inherited from CFxUIObject
CFxUIObject *	sender ()
Protected Attributes inherited from CFxUIObject
CFxUIObjectImpl *	m_pImpl
CFxUIObjectData *	m_pData

Detailed Description

Class CFxUIDockWidget provides the concept of dock widgets, also know as tool palettes or utility windows.

Dock windows are secondary windows placed in the dock widget area around the central widget in main window.

Definition at line 27 of file FxUIDockWidget.h.

Constructor & Destructor Documentation

CFxUIDockWidget()

CFxUIDockWidget::CFxUIDockWidget ( int  iArea )

explicit

Constructor.

Parameters

iArea

The parameter passed defines the area where the widget have to be placed i.e leftDcokWidgetArea, rightDockWidgetArea, bottomDockWidgetArea, topDockWidgetArea.

~CFxUIDockWidget()

virtual CFxUIDockWidget::~CFxUIDockWidget ( )

virtual

Destructor

Member Function Documentation

hideEvent()

virtual void CFxUIDockWidget::hideEvent ( CFxUIHideEvent *  e )

virtual

This event handler can be reimplemented in a subclass to receive view hide events. The event is passed in the event parameter.

Parameters

e	Pointer the hide events.

Reimplemented from CFxUIBaseView.

raise()

void CFxUIDockWidget::raise

(

)

setTitle()

void CFxUIDockWidget::setTitle

(

const CFxUIString &

title

)

Sets the title of dock widget.

Parameters

text

Input

setWidget()

void CFxUIDockWidget::setWidget

(

CFxUIBaseView *

widget

)

Sets the widget for the dock widget to widget.

If the dock widget is visible when widget is added, you must show() it explicitly.

Add the layout of the widget before you call this function; if not, the widget will not be visible.

Parameters

widget

Pointer to the widget.

showEvent()

virtual void CFxUIDockWidget::showEvent ( CFxUIShowEvent *  e )

virtual

This event handler can be reimplemented in a subclass to receive view show events which are passed in the event parameter.

Parameters

e	Pointer to the show events.

Reimplemented from CFxUIBaseView.

widget() [1/2]

CFxUIBaseView* CFxUIDockWidget::widget

(

)

Returns the widget for the dock widget.

Returns

widget This returns zero if the widget has not been set else pointer to widget is returned.

widget() [2/2]

const CFxUIBaseView* CFxUIDockWidget::widget

(

)

const

---

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

• FxUIDockWidget.h