#include <CLayoutClient.h>

Inheritance diagram for sptk::CLayoutClient:

Public Member Functions
	CLayoutClient (Fl_Widget *widget, int layoutSize, CLayoutAlign ca)

virtual	~CLayoutClient ()

CLayoutAlign	layoutAlign () const

void	layoutAlign (CLayoutAlign al)

int	layoutSize () const

void	layoutSize (int ls)

virtual void	label (const String &l)

virtual const String &	label () const

void	name (const char *aname)

void	name (const String &aname)

const String &	name () const

virtual bool	preferredSize (int &w, int &h)

virtual bool	computeSize (int &w, int &h)

virtual String	className () const

Fl_Widget *	widget () const

virtual void	load (const xdoc::SNode &node, CLayoutXMLmode xmlMode)

virtual void	load (const std::shared_ptr< xdoc::Node > &node)

virtual void	save (const std::shared_ptr< xdoc::Node > &node, CLayoutXMLmode xmlMode) const

Protected Member Functions
int	lastPreferredH () const

int	lastPreferredW () const

void	lastPreferredH (int height)

void	lastPreferredW (int width)

Protected Attributes
Fl_Widget *	m_widget

String	m_name

String	m_label

CLayoutAlign	m_layoutAlign

Friends
class	CLayoutManager

Detailed Description

Base layout manager client.

Allows CLayoutManager objects to move and resize the CLayoutClient objects in accordancy with they preferredSize() and layout alignment.

Constructor & Destructor Documentation

◆ CLayoutClient()

sptk::CLayoutClient::CLayoutClient	(	Fl_Widget *	widget,
		int	layoutSize,
		CLayoutAlign	ca
	)

Constructor

Parameters

widget	Fl_Widget*, widget to control
layoutSize	int, the size of the widget in layout. See m_layoutSize for more information.
ca	CLayoutAlign, widget align in layout

◆ ~CLayoutClient()

virtual sptk::CLayoutClient::~CLayoutClient ( )

inlinevirtual

Destructor

Member Function Documentation

◆ className()

virtual String sptk::CLayoutClient::className ( ) const

inlinevirtual

Returns widget class name (internal SPTK RTTI).

Reimplemented in sptk::CSplitter, sptk::CTabs, sptk::CToolBar, sptk::CBox, sptk::CBaseButton, sptk::CCheckButtons, sptk::CComboBox, sptk::CListBox, sptk::CControl, sptk::CDateIntervalInput, sptk::CDateInput, sptk::CTimeInput, sptk::CDateTimeInput, sptk::CDialog, sptk::CFloatInput, sptk::CFontComboBox, sptk::CGroup, sptk::CHtmlBox, sptk::CInput, sptk::CIntegerInput, sptk::CListView, sptk::CMemoInput, sptk::CMenuBar, sptk::CPhoneNumberInput, sptk::CRadioButtons, sptk::CScroll, sptk::CScrollBar, sptk::CTreeItem, sptk::CTreeControl, sptk::CTreeView, and sptk::CWindow.

◆ computeSize()

virtual bool sptk::CLayoutClient::computeSize	(	int &	w,
		int &	h
	)

inlinevirtual

Computes widget's preferred size, and stores size values internally as cache

Used internally by CLayoutManager.

Parameters

w	int&, input/output widget preferred width
h	int&, input/output widget preferred height

◆ label() [1/2]

virtual const String & sptk::CLayoutClient::label ( ) const

inlinevirtual

Returns the current label

Reimplemented in sptk::CGroup, sptk::CWindow, sptk::CBaseButton, sptk::CControl, sptk::CGroup, sptk::CTreeItem, and sptk::CWindow.

◆ label() [2/2]

virtual void sptk::CLayoutClient::label ( const String & l )

inlinevirtual

Sets label, makes an internal copy of the string

Parameters

l New label

Reimplemented in sptk::CControl, sptk::CGroup, sptk::CWindow, sptk::CBaseButton, and sptk::CTreeItem.

◆ lastPreferredH() [1/2]

int sptk::CLayoutClient::lastPreferredH ( ) const

protected

Returns: last preferred height

◆ lastPreferredH() [2/2]

void sptk::CLayoutClient::lastPreferredH ( int height )

protected

Set last preferred height

Parameters

height Height

◆ lastPreferredW() [1/2]

int sptk::CLayoutClient::lastPreferredW ( ) const

protected

Returns: last preferred width

◆ lastPreferredW() [2/2]

void sptk::CLayoutClient::lastPreferredW ( int width )

protected

Set last preferred width

Parameters

width Width

◆ layoutAlign() [1/2]

CLayoutAlign sptk::CLayoutClient::layoutAlign ( ) const

inline

Returns widget's layout align

See also: CLayoutAlign

◆ layoutAlign() [2/2]

void sptk::CLayoutClient::layoutAlign ( CLayoutAlign al )

inline

Sets widget's layout align

See also: CLayoutAlign

◆ layoutSize() [1/2]

int sptk::CLayoutClient::layoutSize ( ) const

inline

Returns widget's layout size

◆ layoutSize() [2/2]

void sptk::CLayoutClient::layoutSize ( int ls )

inline

Sets widget's layout size

◆ load() [1/2]

virtual void sptk::CLayoutClient::load ( const std::shared_ptr< xdoc::Node > & node )

inlinevirtual

Loads layout client information from XML node

Layout information may also include widget size and position, as well as visible() and active() states

Parameters

node	the XML node

Reimplemented in sptk::CWindow.

References LAYOUT.

◆ load() [2/2]

virtual void sptk::CLayoutClient::load	(	const xdoc::SNode &	node,
		CLayoutXMLmode	xmlMode
	)

virtual

Loads layout client information from XML node

Layout information may also include widget size and position, as well as visible() and active() states

Parameters

node	the XML node
xmlMode	the mode defining how the layout and/or data should be stored

Reimplemented in sptk::CButtonGroup, sptk::CBaseListBox, sptk::CControl, sptk::CDateTimeBaseInput, sptk::CInput, sptk::CListView, and sptk::CTreeControl.

Referenced by sptk::CMenuBar::creator().

◆ name() [1/3]

const String & sptk::CLayoutClient::name ( ) const

inline

Returns the current name

◆ name() [2/3]

void sptk::CLayoutClient::name ( const char * aname )

inline

Sets the new widget name

Parameters

aname const char*, new widget name

◆ name() [3/3]

void sptk::CLayoutClient::name ( const String & aname )

inline

Sets the new widget name

Parameters

aname New widget name

◆ preferredSize()

virtual bool sptk::CLayoutClient::preferredSize	(	int &	w,
		int &	h
	)

inlinevirtual

Computes widget's preferred size.

Should be overriten in derived widget if it has any ideas about it's size limits. Widget may want to change none, one, or both preferred width and height suggested by the CLayoutManager.

Parameters

w	int&, input/output widget preferred width
h	int&, input/output widget preferred height

Returns: true if the size is stable (doesn't depend on input sizes)

Reimplemented in sptk::CToolBar, sptk::CBox, sptk::CBaseButton, sptk::CButtonGroup, sptk::CCheckButton, sptk::CBaseListBox, sptk::CDBDropDownList, sptk::CEditor, sptk::CGroup, sptk::CHtmlBox, sptk::CInput_, sptk::CInput, sptk::CListView, sptk::CMemoInput, sptk::CMenuBar, sptk::CProgressBar, sptk::CScroll, sptk::CScrollBar, sptk::CTreeItem, and sptk::CWindow.

◆ save()

virtual void sptk::CLayoutClient::save	(	const std::shared_ptr< xdoc::Node > &	node,
		CLayoutXMLmode	xmlMode
	)		const

virtual

Saves layout client information from XML node

Layout information may also include widget size and position, as well as visible() and active() states

Parameters

node	the XML node
xmlMode	the mode defining how the layout and/or data should be stored

Reimplemented in sptk::CButton, and sptk::CWindow.

◆ widget()

Fl_Widget * sptk::CLayoutClient::widget ( ) const

inline

Returns widget handled by that object

Member Data Documentation

◆ m_label

String sptk::CLayoutClient::m_label

protected

Widget caption storage

◆ m_layoutAlign

CLayoutAlign sptk::CLayoutClient::m_layoutAlign

protected

The layout align for the widget in CLayoutManager group

◆ m_name

String sptk::CLayoutClient::m_name

protected

Widget name (widget id)

◆ m_widget

Fl_Widget* sptk::CLayoutClient::m_widget

protected

Widget to manage

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

CLayoutClient.h

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CLayoutClient()

◆ ~CLayoutClient()

Member Function Documentation

◆ className()

◆ computeSize()

◆ label() [1/2]

◆ label() [2/2]

◆ lastPreferredH() [1/2]

◆ lastPreferredH() [2/2]

◆ lastPreferredW() [1/2]

◆ lastPreferredW() [2/2]

◆ layoutAlign() [1/2]

◆ layoutAlign() [2/2]

◆ layoutSize() [1/2]

◆ layoutSize() [2/2]

◆ load() [1/2]

◆ load() [2/2]

◆ name() [1/3]

◆ name() [2/3]

◆ name() [3/3]

◆ preferredSize()

◆ save()

◆ widget()

Member Data Documentation

◆ m_label

◆ m_layoutAlign

◆ m_name

◆ m_widget