Toolbar widget. More...

#include <CToolBar.h>

Inheritance diagram for sptk::CToolBar:

Public Member Functions
	CToolBar (CLayoutAlign layoutAlign=CLayoutAlign::TOP)
	Constructor in SPTK style. More...

CButton *	addButton (CButtonKind buttonKind, Fl_Callback_p cb, const char *label=0, CLayoutAlign buttonAlign=CLayoutAlign::LEFT)
	Creates and adds a new button to the toolbar. More...

virtual void	resize (int x, int y, int w, int h)
	Resizes the group and inside widgets. More...

virtual bool	preferredSize (int &w, int &h)
	Computes the optimal group size. More...

bool	collapsed () const
	Flag, true if the toolbar is collapsed.

int	handle (int)
	Special handle() function.

void	draw ()
	Draws the toolbar.

virtual String	className () const
	Returns widget class name (internal SPTK RTTI). More...

Public Member Functions inherited from sptk::CGroup
bool	drawClipped () const

void	drawClipped (bool drawClipped)

	CGroup (const char *label=nullptr, int layoutSize=10, CLayoutAlign layoutAlign=CLayoutAlign::TOP)

void	draw () override

void	resize (int x, int y, int w, int h) override

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

void	clear () override
	Removes all the widgets inside the group. More...

const String &	label () const override
	Returns the current label. More...

String	className () const override
	Returns widget class name (internal SPTK RTTI). More...

virtual void	label (const String &l)

virtual const String &	label () const

Public Member Functions inherited from sptk::CLayoutManager
	CLayoutManager (Fl_Group *group, int layoutSize, CLayoutAlign ca)

	~CLayoutManager () override=default

virtual void	clear ()
	Removes all the children. More...

int	layoutSpacing () const

void	layoutSpacing (int ls)

void	layoutGrowMode (CLayoutGrowMode gm=CLayoutGrowMode::LGM_AUTO_GROW)

CLayoutGrowMode	layoutGrowMode () const

void	relayout ()

void	frame (CFrame *frame, bool drawBackground=true)
	Defines frame. More...

const CFrame *	frame () const
	Returnes the current frame.

uint32_t	frameWidth () const
	Returns frame width.

virtual void	loadLayout (const xdoc::SNode &node, CLayoutXMLmode xmlMode)
	Loads group controls data from XML node. More...

virtual void	saveLayout (const xdoc::SNode &node, CLayoutXMLmode xmlMode) const
	Saves group controls data into XML node. More...

void	nameIndex (CWidgetNamesMap &index, bool recursive, bool clean=true) const
	Builds an index of internal widget names. More...

bool	noXml () const
	Returns flag of blocking XML processing. More...

void	noXml (bool noXml)
	Sets flag of blocking XML processing. More...

Public Member Functions inherited from sptk::CLayoutClient
	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

Static Public Member Functions
static CLayoutClient *	creator (const xdoc::SNode &node)
	Creates a widget based on the XML node information. More...

Static Public Member Functions inherited from sptk::CGroup
static CLayoutClient *	creator (const xdoc::SNode &node)
	Creates a widget based on the XML node information. More...

Static Public Member Functions inherited from sptk::CLayoutManager
static void	registerControl (std::string typeName, createControlCallback creator) noexcept
	Register control type for loading layouts. More...

static const std::map< std::string, Fl_Boxtype > &	boxTypeNames ()
	Returns a read-only map of box type names and corresponding constants.

Additional Inherited Members
Protected Member Functions inherited from sptk::CGroup
void	ctor_init (const char *label)

Protected Member Functions inherited from sptk::CLayoutManager
bool	autoLayout (int x, int y, int &w, int &h, bool resizeWidgets) const

virtual void	paintBackground ()

Protected Member Functions inherited from sptk::CLayoutClient
int	lastPreferredH () const

int	lastPreferredW () const

void	lastPreferredH (int height)

void	lastPreferredW (int width)

Protected Attributes inherited from sptk::CLayoutManager
int	m_layoutSpacing

CLayoutGrowMode	m_layoutGrowMode

Fl_Group *	m_group

CFrame *	m_frame

bool	m_frameDrawBackground

bool	m_noXml

Protected Attributes inherited from sptk::CLayoutClient
Fl_Widget *	m_widget

String	m_name

String	m_label

CLayoutAlign	m_layoutAlign

Static Protected Attributes inherited from sptk::CLayoutManager
static std::map< std::string, Fl_Boxtype >	m_boxTypeNames

static createControlCallbackMap	controlCreator

Detailed Description

Toolbar widget.

The slightely extended CGroup to work as a toolbar. Most of the toolbar functionality isn't implemented yet.

Constructor & Destructor Documentation

◆ CToolBar()

sptk::CToolBar::CToolBar ( CLayoutAlign layoutAlign = CLayoutAlign::TOP )

explicit

Constructor in SPTK style.

Parameters

layoutAlign CLayoutAlign, widget align in layout

Member Function Documentation

◆ addButton()

CButton * sptk::CToolBar::addButton	(	CButtonKind	buttonKind,
		Fl_Callback_p	cb,
		const char *	label = `0`,
		CLayoutAlign	buttonAlign = `CLayoutAlign::LEFT`
	)

Creates and adds a new button to the toolbar.

Parameters

buttonKind	CButtonKind, button type
cb	Fl_Callback_p, button callback
label	const char *, button label
buttonAlign	CLayoutAlign, button align in the toolbar

See also: CButton

◆ className()

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

inlinevirtual

Returns widget class name (internal SPTK RTTI).

Reimplemented from sptk::CGroup.

◆ creator()

static CLayoutClient * sptk::CToolBar::creator ( const xdoc::SNode & node )

static

Creates a widget based on the XML node information.

Parameters

node	xml::Node*, an XML node with widget information

◆ preferredSize()

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

virtual

Computes the optimal group size.

Parameters

w	int&, input - width offered by the program, output - width required by widget
h	int&, input - height offered by the program, output - height required by widget

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

Reimplemented from sptk::CGroup.

◆ resize()

virtual void sptk::CToolBar::resize	(	int	x,
		int	y,
		int	w,
		int	h
	)

virtual

Resizes the group and inside widgets.

Parameters

x	int, x-position
y	int, y-position
w	int, width
h	int, height

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

CToolBar.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CToolBar()

Member Function Documentation

◆ addButton()

◆ className()

◆ creator()

◆ preferredSize()

◆ resize()