#include <FxUIBaseView.h>

Inheritance diagram for CFxUIBaseView:

Public Types
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 { eExpanding = -1 , eXS = 0 , eS , eM , eL , eXL }

enum	UIScrollBarPolicy { eScrollBarAsNeeded = 0 , eScrollBarAlwaysOff , eScrollBarAlwaysOn }

Public Member Functions
	CFxUIBaseView ()

virtual	~CFxUIBaseView ()

void	setDisabled (bool on)

void	setEnabled (bool on)

bool	isEnabled () const

CFxUIPalette::FxUIColorRole	backgroundRole ()

void	setPalette (const CFxUIPalette &)

const CFxUIPalette &	palette () const

bool	isVisible ()

void	setVisible (bool bVisible)

bool	isHidden ()

void	setHidden (bool bHidden)

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	showEvent (CFxUIShowEvent *event)

virtual void	hideEvent (CFxUIHideEvent *event)

virtual void	paintEvent (CFxUIPaintEvent *event)

virtual void	resizeEvent (CFxUIResizeEvent *event)

virtual void	focusInEvent (CFxUIFocusEvent *focusInEvent)

virtual void	focusOutEvent (CFxUIFocusEvent *focusOutEvent)

virtual void	mousePressEvent (CFxUIMouseEvent *mouseEvent)

void	setEventAccepted (bool bAccepted=false)

void	setEventRejected (bool bRejected=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 ()

bool	underMouse ()

void	setMask (const CFxUIRegion &region)

void	move (const CFxUIPoint &pos)

CFxUISize	sizeHint () const

CFxUIPoint	mapToGlobal (const CFxUIPoint &pos)

void	setMargin (int left, int top, int right, int bottom)

void	setParentWidget (CFxUIBaseView *pParent)

float	getViewOpacity () const

void	setViewOpacity (const float &opacity)

CFxUISignal< void(void)> &	aboutToPassEventToParent ()

CFxUISignal< void(void)> &	aboutToShow ()

CFxUISignal< void(void)> &	hoverEnter ()

CFxUISignal< void(void)> &	hoverLeave ()

CFxUISignal< void(bool)> &	visibilityChanged ()

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

Static Public Member Functions
static void	setTabOrder (CFxUIObject first, CFxUIObject second)

Additional Inherited Members
Protected Member Functions inherited from CFxUIObject
CFxUIObject *	sender ()

Protected Attributes inherited from CFxUIObject
CFxUIObjectImpl *	m_pImpl

CFxUIObjectData *	m_pData

Detailed Description

Class CFxUIBaseView is the base class for all widgets and provides their common functionalities.

Definition at line 35 of file FxUIBaseView.h.

Member Enumeration Documentation

◆ FocusPolicyType

enum CFxUIBaseView::FocusPolicyType

This enum type defines the policies a view can have with respect to acquiring keyboard focus.

Enumerator
eNoFocus	The widget does not accept focus.
eTabFocus	The widget accepts focus by tabbing.
eClickFocus	The widget accepts focus by clicking.
eStrongFocus	The widget accepts focus by both tabbing and clicking. On macOS it will also accept tab focus in "Text/List focus mode".
eWheelFocus	The widget accepts focus by using the mouse wheel in addition to eStrongFocus.
eKeyboardOnSetfocus	A programmatic SetFocus automatically opens the soft keyboard if available (implemented for Touch).

Definition at line 60 of file FxUIBaseView.h.

◆ TextAlignment

enum CFxUIBaseView::TextAlignment

This enum type defines the alignment of text to be done.

Enumerator
AlignLeft
AlignRight
AlignHCenter
AlignJustify
AlignTop
AlignBottom
AlignVCenter
AlignBaseline
AlignCenter

Definition at line 42 of file FxUIBaseView.h.

◆ UIScrollBarPolicy

enum CFxUIBaseView::UIScrollBarPolicy

This enum type defines the scrollbar policy.

Enumerator
eScrollBarAsNeeded	This enum shows a scroll bar when the content is too large to fit and not otherwise.
eScrollBarAlwaysOff	This enum never shows a scroll bar.
eScrollBarAlwaysOn	This enum always shows a scroll bar.

Definition at line 84 of file FxUIBaseView.h.

◆ UIWidthSizePolicy

enum CFxUIBaseView::UIWidthSizePolicy

This enum type defines the size policy.

Enumerator
eExpanding
eXS	This enum defines size as extra small.
eS	This enum defines size as small.
eM	This enum defines size as medium.
eL	This enum defines size as large.
eXL	This enum defines size as extra large.

Definition at line 72 of file FxUIBaseView.h.

Constructor & Destructor Documentation

◆ CFxUIBaseView()

CFxUIBaseView::CFxUIBaseView ( )

Constructor

◆ ~CFxUIBaseView()

virtual CFxUIBaseView::~CFxUIBaseView ( )

virtual

Destructor

Member Function Documentation

◆ aboutToPassEventToParent()

CFxUISignal< void(void)> & CFxUIBaseView::aboutToPassEventToParent ( )

Signal is emitted before passing event to parent class.

◆ aboutToShow()

CFxUISignal< void(void)> & CFxUIBaseView::aboutToShow ( )

Signal is emitted before showing view.

◆ addView()

void CFxUIBaseView::addView	(	CFxUIBaseView *	pChild,
		float	fWeight = 0.0 )

Add the child view at last index.

Parameters

pChild	Pointer to the child view to be added.
fWeight	Input

◆ backgroundRole()

CFxUIPalette::FxUIColorRole CFxUIBaseView::backgroundRole ( )

Returns the background role of the view.

The background role defines the brush from the view's palette that is used to render the background.

◆ focusInEvent()

virtual void CFxUIBaseView::focusInEvent ( CFxUIFocusEvent * focusInEvent )

virtual

This event handler can be reimplemented in a subclass to receive keyboard focus events (focus received) for the view.

Parameters

focusInEvent Pointer to the focusIn event.

◆ focusOutEvent()

virtual void CFxUIBaseView::focusOutEvent ( CFxUIFocusEvent * focusOutEvent )

virtual

This event handler can be reimplemented in a subclass to receive keyboard focus events (focus lost) for the view.

Parameters

focusOutEvent Pointer to the focusOut event.

◆ getViewOpacity()

float CFxUIBaseView::getViewOpacity ( ) const

◆ hasFocus()

bool CFxUIBaseView::hasFocus ( ) const

Returns if view has the keyboard input focus.

Returns: bool if has keyboard focus the return value is true, otherwise false.

◆ height()

int CFxUIBaseView::height ( )

Returns height of view.

Returns: int value.

◆ hideEvent()

virtual void CFxUIBaseView::hideEvent ( CFxUIHideEvent * event )

virtual

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

Parameters

event Pointer the hide events.

Reimplemented in CFxUIDockWidget.

◆ hoverEnter()

CFxUISignal< void(void)> & CFxUIBaseView::hoverEnter ( )

Signal is emitted when mouse cursor enters the hover widget..

◆ hoverLeave()

CFxUISignal< void(void)> & CFxUIBaseView::hoverLeave ( )

Signal is emitted when mouse cursor leave the hover widget..

◆ indexOf()

int CFxUIBaseView::indexOf ( CFxUIBaseView * pChild )

Returns the index of view.

Returns: int value.

◆ insertView()

void CFxUIBaseView::insertView	(	CFxUIBaseView *	pChild,
		int	index = 0,
		float	fWeight = 0.0 )

Insert the child view at specified index.

Parameters

pChild	Pointer to the child view to be inserted.
index	Value at which the child view is inserted.
fWeight	Input

◆ isEnabled()

bool CFxUIBaseView::isEnabled ( ) const

Returns if the view is enabled.

Returns: true if the view is enabled, otherwise false.

◆ isHidden()

bool CFxUIBaseView::isHidden ( )

inline

Returns if view is hidden.

Returns: true if visible, otherwise false

Definition at line 162 of file FxUIBaseView.h.

◆ isVisible()

bool CFxUIBaseView::isVisible ( )

Returns if view is visible.

Returns: true if visible, otherwise false

◆ mapToGlobal()

CFxUIPoint CFxUIBaseView::mapToGlobal ( const CFxUIPoint & pos )

Translates the view coordinate pos to the coordinate system of parent.

Parameters

pos Input

◆ maximumHeight()

int CFxUIBaseView::maximumHeight ( )

Returns the maximum height of view.

Returns: int value.

◆ maximumWidth()

int CFxUIBaseView::maximumWidth ( )

Returns the maximum width of view.

Returns: int value.

◆ minimumHeight()

int CFxUIBaseView::minimumHeight ( )

Returns the minimum height of view.

Returns: int value.

◆ minimumWidth()

int CFxUIBaseView::minimumWidth ( )

Returns the minimum width of view.

Returns: int value.

◆ mousePressEvent()

virtual void CFxUIBaseView::mousePressEvent ( CFxUIMouseEvent * mouseEvent )

virtual

This event handler can be reimplemented in a subclass to receive mouse button press events for the view.

Parameters

CFxUIMouseEvent Pointer to the mouseEvent event.

◆ move()

void CFxUIBaseView::move ( const CFxUIPoint & pos )

Sets position of view.

Parameters

pos Input

◆ paintEvent()

virtual void CFxUIBaseView::paintEvent ( CFxUIPaintEvent * event )

virtual

This event handler can be reimplemented in a subclass to receive paint events passed in event.

Parameters

event Pointer to the paint events.

Reimplemented in CFxUIImageView.

◆ palette()

const CFxUIPalette & CFxUIBaseView::palette ( ) const

Returns the view's palette. The view's palette contains color groups for each view's state.

Returns: The view's palette

◆ removeView()

void CFxUIBaseView::removeView ( CFxUIBaseView * pChild )

Remove the child view.

Parameters

pChild Pointer to the child view to be removed.

◆ resize()

void CFxUIBaseView::resize	(	int	w,
		int	h )

Resize the view to width and height.

Parameters

w	Input
h	Input

◆ resizeEvent()

virtual void CFxUIBaseView::resizeEvent ( CFxUIResizeEvent * event )

virtual

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

When resizeEvent() is called, the view already has its new geometry.

Parameters

event Pointer to the resize event.

◆ setBorderColor()

void CFxUIBaseView::setBorderColor	(	int	r,
		int	g,
		int	b )

Sets the border color of view in rgb format.

Parameters

r	Input
g	Input
b	Input

◆ setBorderWidth() [1/2]

void CFxUIBaseView::setBorderWidth	(	float	left,
		float	top,
		float	right,
		float	bottom )

Sets the border width of view.

Parameters

left	Input
top	Input
right	Input
bottom	Input

◆ setBorderWidth() [2/2]

void CFxUIBaseView::setBorderWidth ( float width )

Sets the border width of view.

Parameters

width Input

◆ setBusyState()

void CFxUIBaseView::setBusyState ( bool bBusy = false )

Sets the view in busy state.

By default, this property will be disabled.

Parameters

bBusy Input

◆ setCornerRadius()

void CFxUIBaseView::setCornerRadius ( float radius )

Sets the corner radius of view.

Parameters

radius Input

◆ setDisabled()

void CFxUIBaseView::setDisabled ( bool on )

Sets whether the view is disabled.

Parameters

on	The view is disabled if the value of the parameter is true, otherwise it will be enabled.

◆ setEnabled()

void CFxUIBaseView::setEnabled ( bool on )

Sets whether the view is enabled.

Parameters

on	The view is enabled if the value of the parameter is true, otherwise it will be disabled.

◆ setEventAccepted()

void CFxUIBaseView::setEventAccepted ( bool bAccepted = false )

Accept the current event by enabling it.

By default, this property will be disabled.

Parameters

bAccepted Input

◆ setEventRejected()

void CFxUIBaseView::setEventRejected ( bool bRejected = false )

Reject the current event by enabling it.

By default, this property will be disabled.

Parameters

bRejected Input

◆ setFocus() [1/2]

void CFxUIBaseView::setFocus ( )

Sets keyoboard input focus to this view.

◆ setFocus() [2/2]

void CFxUIBaseView::setFocus ( int iReason )

Set the keyboard input focus to this view.

Parameters

iReason This is used to give an explanation of what caused the view to get focus.

◆ setFocusPolicy()

void CFxUIBaseView::setFocusPolicy ( int iPolicy )

Set the focus policy in the way view accepts keyboard focus.

Parameters

iPolicy The input defines policies view can have with respect to acquiring keyboard focus.

◆ setHeight()

void CFxUIBaseView::setHeight ( int h )

Sets the height of view.

Parameters

h Input

◆ setHidden()

void CFxUIBaseView::setHidden ( bool bHidden )

inline

Hides or shows the view according to the parameter.

Parameters

bHidden The view gets hidden if the value of the parameter is true, otherwise it will be shown.

Definition at line 169 of file FxUIBaseView.h.

◆ setMargin()

void CFxUIBaseView::setMargin	(	int	left,
		int	top,
		int	right,
		int	bottom )

set the Margin.

Parameters

top	margin-top is set.
bottom	margin-bottom is set.
left	margin-left set
right	margin-right is set

◆ setMask()

void CFxUIBaseView::setMask ( const CFxUIRegion & region )

Sets mask for view .

Parameters

region Causes only the parts of the view which overlap region to be visible.

◆ setMaximumHeight()

void CFxUIBaseView::setMaximumHeight ( int iHeight )

Sets the maximum height of view.

Parameters

iHeight Input

◆ setMaximumSize()

void CFxUIBaseView::setMaximumSize ( const CFxUISize & size )

◆ setMaximumWidth()

void CFxUIBaseView::setMaximumWidth ( int iWidth )

Sets the maximum width of view.

Parameters

iWidth Input

◆ setMinimumHeight()

void CFxUIBaseView::setMinimumHeight ( int iHeight )

Sets the minimum height of view.

Parameters

iHeight Input

◆ setMinimumSize()

void CFxUIBaseView::setMinimumSize ( const CFxUISize & size )

◆ setMinimumWidth()

void CFxUIBaseView::setMinimumWidth ( int iWidth )

Sets the minimum width of view.

Parameters

iWidth Input

◆ setPalette()

void CFxUIBaseView::setPalette ( const CFxUIPalette & )

Sets the view pallete.

The palette is used by the view's style when rendering standard components.

Parameters

palette Input

◆ setParentWidget()

void CFxUIBaseView::setParentWidget ( CFxUIBaseView * pParent )

set the parent for child Widget.

Parameters

childWidget parent is set for childWidget.

◆ setPreferableSize()

void CFxUIBaseView::setPreferableSize	(	int	w,
		int	h )

Sets the preferred size of view.

Parameters

w	Input
h	Input

◆ setTabOrder()

static void CFxUIBaseView::setTabOrder	(	CFxUIObject *	first,
		CFxUIObject *	second )

static

Set the tab order of the views.

Parameters

first	Pointer to the first view in the order.
second	Pointer to the second view in the order.

◆ setToolTip()

void CFxUIBaseView::setToolTip ( const CFxUIString & sToolTip )

Sets tooltip .

Parameters

sToolTip The value passed in parameter is set to tooltip which is visible on hovering.

◆ setViewOpacity()

void CFxUIBaseView::setViewOpacity ( const float & opacity )

Sets opacity of view.

Parameters

opacity Input

◆ setVisible()

void CFxUIBaseView::setVisible ( bool bVisible )

Sets whether the view is visible.

Parameters

bVisible The view is visible if the value of the parameter is true, otherwise it will be hidden.

◆ setWidth()

void CFxUIBaseView::setWidth ( int w )

Sets the width of view.

Parameters

w Input

◆ showEvent()

virtual void CFxUIBaseView::showEvent ( CFxUIShowEvent * event )

virtual

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

Parameters

event Pointer to the show events.

Reimplemented in CFxUIDockWidget.

◆ sizeHint()

CFxUISize CFxUIBaseView::sizeHint ( ) const

Returns the recommended size for the view

Returns: CFxUISize value.

◆ toolTip()

const CFxUIString CFxUIBaseView::toolTip ( )

Returns the tooltip.

Returns: tool tip

◆ underMouse()

bool CFxUIBaseView::underMouse ( )

Returns true if the view is under the mouse cursor; otherwise returns false.

Returns: bool value.

◆ update()

void CFxUIBaseView::update ( )

Updates the view unless updates are disabled or the view is hidden.

◆ visibilityChanged()

CFxUISignal< void(bool)> & CFxUIBaseView::visibilityChanged ( )

Signal is emitted when widget change its visibility..

◆ width()

int CFxUIBaseView::width ( )

Returns width of view.

Returns: int value.

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

FxUIBaseView.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ FocusPolicyType

◆ TextAlignment

◆ UIScrollBarPolicy

◆ UIWidthSizePolicy

Constructor & Destructor Documentation

◆ CFxUIBaseView()

◆ ~CFxUIBaseView()

Member Function Documentation

◆ aboutToPassEventToParent()

◆ aboutToShow()

◆ addView()

◆ backgroundRole()

◆ focusInEvent()

◆ focusOutEvent()

◆ getViewOpacity()

◆ hasFocus()

◆ height()

◆ hideEvent()

◆ hoverEnter()

◆ hoverLeave()

◆ indexOf()

◆ insertView()

◆ isEnabled()

◆ isHidden()

◆ isVisible()

◆ mapToGlobal()

◆ maximumHeight()

◆ maximumWidth()

◆ minimumHeight()

◆ minimumWidth()

◆ mousePressEvent()

◆ move()

◆ paintEvent()

◆ palette()

◆ removeView()

◆ resize()

◆ resizeEvent()

◆ setBorderColor()

◆ setBorderWidth() [1/2]

◆ setBorderWidth() [2/2]

◆ setBusyState()

◆ setCornerRadius()

◆ setDisabled()

◆ setEnabled()

◆ setEventAccepted()

◆ setEventRejected()

◆ setFocus() [1/2]

◆ setFocus() [2/2]

◆ setFocusPolicy()

◆ setHeight()

◆ setHidden()

◆ setMargin()

◆ setMask()

◆ setMaximumHeight()

◆ setMaximumSize()

◆ setMaximumWidth()

◆ setMinimumHeight()

◆ setMinimumSize()

◆ setMinimumWidth()

◆ setPalette()

◆ setParentWidget()

◆ setPreferableSize()

◆ setTabOrder()

◆ setToolTip()

◆ setViewOpacity()

◆ setVisible()

◆ setWidth()

◆ showEvent()

◆ sizeHint()

◆ toolTip()

◆ underMouse()

◆ update()

◆ visibilityChanged()

◆ width()