fcn::StatusBar Class Reference

#include <statusbar.hpp>

Inheritance diagram for fcn::StatusBar:

Public Member Functions
Container *	getIconArea () const
Container *	getLeftArea () const
Container *	getRightArea () const
std::string const &	getText () const
bool	isShrinkPriorityEnabled () const
bool	isTruncateWithEllipsis () const
StatusBar &	operator= (StatusBar &&)=delete
StatusBar &	operator= (StatusBar const &)=delete
void	setShrinkPriorityEnabled (bool enabled)
void	setText (std::string const &text)
void	setTruncateWithEllipsis (bool enabled)
	StatusBar ()
	StatusBar (StatusBar &&)=delete
	StatusBar (StatusBar const &)=delete
Public Member Functions inherited from fcn::HorizontalBar
void	adjustSize () override
unsigned int	getFixedHeight () const
unsigned int	getPadding () const
unsigned int	getSpacing () const
	HorizontalBar ()
	HorizontalBar (HorizontalBar &&)=delete
	HorizontalBar (HorizontalBar const &)=delete
bool	isClipping () const
bool	isExpandChildren () const
HorizontalBar &	operator= (HorizontalBar &&)=delete
HorizontalBar &	operator= (HorizontalBar const &)=delete
void	resizeToContent (bool recursion=true) override
void	setClipping (bool clip)
void	setExpandChildren (bool expand)
void	setFixedHeight (unsigned int height)
void	setPadding (unsigned int padding)
void	setSpacing (unsigned int spacing)
Public Member Functions inherited from fcn::Container
virtual void	add (Widget *widget)
virtual void	add (Widget *widget, int x, int y)
void	addContainerListener (ContainerListener *containerListener)
virtual void	addWidget (std::unique_ptr< Widget > widget)
virtual void	addWidget (std::unique_ptr< Widget > widget, int x, int y)
	Container ()
	Container (Container &&)=delete
	Container (Container const &)=delete
void	expandContent ()
void	expandContent (bool recursion) override
Widget *	findWidgetById (std::string const &id) override
Widget *	getBackgroundWidget ()
Widget *	getChild (unsigned int index) const
Rectangle	getChildrenArea () override
virtual unsigned int	getHorizontalSpacing () const
virtual LayoutPolicy	getLayout () const
virtual unsigned int	getVerticalSpacing () const
bool	isLayouted () override
virtual bool	isOpaque () const
virtual bool	isUniformSize () const
Container &	operator= (Container &&)=delete
Container &	operator= (Container const &)=delete
void	remove (Widget *widget) override
void	removeAllChildren () override
void	removeContainerListener (ContainerListener *containerListener)
void	setBackgroundWidget (Widget *widget)
virtual void	setHorizontalSpacing (unsigned int spacing)
virtual void	setLayout (LayoutPolicy policy)
virtual void	setOpacity (float opacity)
virtual void	setOpaque (bool opaque)
virtual void	setUniformSize (bool uniform)
virtual void	setVerticalSpacing (unsigned int spacing)
Public Member Functions inherited from fcn::Widget
virtual void	_draw (Graphics *graphics)
virtual FocusHandler *	_getFocusHandler ()
virtual std::list< FocusListener * > const &	_getFocusListeners ()
virtual FocusHandler *	_getInternalFocusHandler ()
virtual std::list< KeyListener * > const &	_getKeyListeners ()
virtual std::list< MouseListener * > const &	_getMouseListeners ()
virtual void	_logic ()
virtual void	_setFocusHandler (FocusHandler *focusHandler)
virtual void	_setParent (Widget *parent)
void	adaptLayout ()
virtual void	adaptLayout (bool top)
void	addActionListener (ActionListener *actionListener)
void	addDeathListener (DeathListener *deathListener)
void	addDropTargetListener (DropTargetListener *listener)
void	addFocusListener (FocusListener *focusListener)
void	addKeyListener (KeyListener *keyListener)
void	addMouseListener (MouseListener *mouseListener)
void	addWidgetListener (WidgetListener *widgetListener)
bool	captureMouse ()
bool	contains (int x, int y) const
virtual void	drawBorder (Graphics *graphics)
void	drawBorder (Graphics *graphics, unsigned int sides)
virtual void	drawOutline (Graphics *graphics)
virtual void	drawSelectionFrame (Graphics *graphics)
void	expandContent ()
virtual void	focusNext ()
virtual void	focusPrevious ()
virtual void	fontChanged ()
virtual void	getAbsolutePosition (int &x, int &y) const
std::string const &	getActionEventId () const
Color const &	getBackgroundColor () const
Color const &	getBaseColor () const
Color const &	getBorderColor () const
unsigned int	getBorderSides () const
unsigned int	getBorderSize () const
unsigned int	getBorderStyle () const
unsigned int	getChildrenCount () const
Rectangle const &	getDimension () const
Size const &	getFixedSize () const
Font *	getFont () const
Color const &	getForegroundColor () const
int	getHeight () const
std::string const &	getId () const
void	getLastPosition (int &x, int &y) const
int	getMarginBottom () const
int	getMarginLeft () const
int	getMarginRight () const
int	getMarginTop () const
Size const &	getMaxSize () const
Size const &	getMinSize () const
Color const &	getOutlineColor () const
unsigned int	getOutlineSize () const
unsigned int	getPaddingBottom () const
unsigned int	getPaddingLeft () const
unsigned int	getPaddingRight () const
unsigned int	getPaddingTop () const
virtual Widget *	getParent () const
Color const &	getSelectionColor () const
SelectionMode	getSelectionMode () const
virtual Widget *	getTop () const
unsigned int	getVisibleChildrenCount () const
Widget *	getWidgetAt (int x, int y)
virtual Widget *	getWidgetAt (int x, int y, Widget *exclude)
std::list< Widget * >	getWidgetsIn (Rectangle const &area)
virtual std::list< Widget * >	getWidgetsIn (Rectangle const &area, Widget *ignore)
int	getWidth () const
int	getX () const
int	getY () const
bool	hasMouseCapture () const
bool	isDescendantOf (Widget const *ancestor) const noexcept
bool	isEnabled () const
bool	isFixedSize () const
bool	isFocusable () const
virtual bool	isFocused () const
bool	isHorizontalExpand () const
bool	isInsideActiveMouseModal () const noexcept
bool	isLastPositionSet () const
virtual bool	isModalFocusable () const
virtual bool	isModalFocused () const
virtual bool	isModalMouseInputFocusable () const
bool	isMouseInside (MouseEvent const &mouseEvent) const
bool	isSetVisible () const
bool	isTabInEnabled () const
bool	isTabOutEnabled () const
virtual bool	isUnderMouseModal () const
bool	isVerticalExpand () const
bool	isVisible () const
virtual void	logic ()
virtual void	moveToBottom (Widget *widget)
virtual void	moveToTop (Widget *widget)
virtual void	onFocusChanged ()
virtual void	onFocusGained ()
virtual void	onFocusLost ()
Widget &	operator= (Widget &&)=delete
Widget &	operator= (Widget const &)=delete
void	releaseMouse ()
void	removeActionListener (ActionListener *actionListener)
void	removeDeathListener (DeathListener *deathListener)
void	removeDropTargetListener (DropTargetListener *listener)
void	removeFocusListener (FocusListener *focusListener)
void	removeKeyListener (KeyListener *keyListener)
void	removeMouseListener (MouseListener *mouseListener)
void	removeWidgetListener (WidgetListener *widgetListener)
virtual void	requestFocus ()
virtual void	requestMoveToBottom ()
virtual void	requestMoveToTop ()
void	setActionEventId (std::string const &actionEventId)
virtual void	setBackgroundColor (Color const &color)
virtual void	setBaseColor (Color const &color)
void	setBorderBottom (unsigned int size, unsigned int style)
virtual void	setBorderColor (Color const &color)
void	setBorderSides (unsigned int sides)
void	setBorderSize (unsigned int size)
void	setBorderStyle (unsigned int style)
void	setBorderTop (unsigned int size, unsigned int style)
virtual void	setDimension (Rectangle const &dimension)
void	setEnabled (bool enabled)
void	setFixedSize (Size const &size)
void	setFocusable (bool focusable)
virtual void	setFocused (bool focused)
virtual void	setFont (Font *font)
virtual void	setForegroundColor (Color const &color)
virtual void	setHeight (int height)
void	setHorizontalExpand (bool expand)
void	setId (std::string const &id)
void	setInternalFocusHandler (FocusHandler *internalFocusHandler)
void	setLastPosition (int x, int y)
void	setMargin (int margin)
void	setMarginBottom (int margin)
void	setMarginLeft (int margin)
void	setMarginRight (int margin)
void	setMarginTop (int margin)
void	setMaxSize (Size const &size)
void	setMinSize (Size const &size)
virtual void	setOutlineColor (Color const &color)
void	setOutlineSize (unsigned int size)
void	setPadding (unsigned int padding)
void	setPaddingBottom (unsigned int padding)
void	setPaddingLeft (unsigned int padding)
void	setPaddingRight (unsigned int padding)
void	setPaddingTop (unsigned int padding)
void	setPosition (int x, int y)
virtual void	setSelectionColor (Color const &color)
virtual void	setSelectionMode (SelectionMode mode)
virtual void	setSize (int width, int height)
void	setTabInEnabled (bool enabled)
void	setTabOutEnabled (bool enabled)
void	setVerticalExpand (bool expand)
void	setVisible (bool visible)
virtual void	setWidth (int width)
void	setX (int x)
void	setY (int y)
virtual void	showPart (Rectangle rectangle)
virtual void	showWidgetPart (Widget *widget, Rectangle area)
	Widget ()
	Widget (Widget &&)=delete
	Widget (Widget const &)=delete

Protected Member Functions
void	draw (Graphics *graphics) override
Protected Member Functions inherited from fcn::Container
void	distributeWidgetAddedEvent (Widget *source)
void	distributeWidgetRemovedEvent (Widget *source)
Protected Member Functions inherited from fcn::Widget
void	add (Widget *widget)
void	calculateSize ()
void	distributeActionEvent ()
void	distributeAncestorHiddenEvent (Widget *ancestor)
void	distributeAncestorMovedEvent (Widget *ancestor)
void	distributeAncestorShownEvent (Widget *ancestor)
void	distributeDragDrop (DragEvent &event)
bool	distributeDragEnter (DragEvent &event)
void	distributeDragHover (DragEvent &event)
void	distributeDragLeave (DragEvent &event)
void	distributeHiddenEvent ()
void	distributeMovedEvent ()
void	distributeResizedEvent ()
void	distributeShownEvent ()
std::list< Widget * > const &	getChildren () const
void	resizeToChildren ()

Additional Inherited Members
Public Types inherited from fcn::HorizontalBar
enum class	Alignment { Start , Center , End }
Public Types inherited from fcn::Container
enum class	LayoutPolicy : uint8_t {   Absolute = 0 , AutoSize , Vertical , Horizontal ,   Circular }
Public Types inherited from fcn::Widget
enum	BorderSide : uint8_t {   BORDER_NONE = 0 , BORDER_LEFT = 1 << 0 , BORDER_TOP = 1 << 1 , BORDER_RIGHT = 1 << 2 ,   BORDER_BOTTOM = 1 << 3 , BORDER_ALL = BORDER_LEFT | BORDER_TOP | BORDER_RIGHT | BORDER_BOTTOM }
enum	BorderStyle : uint8_t { BORDER_STYLE_BEVEL = 0 , BORDER_STYLE_FLAT = 1 }
enum class	SelectionMode : uint8_t { None = 0 , Border = 1 , Background = 2 }
Static Public Member Functions inherited from fcn::Widget
static DeathListener *	_getGuiDeathListener ()
static VisibilityEventHandler *	_getVisibilityEventHandler ()
static void	_setGuiDeathListener (DeathListener *deathListener)
static void	_setVisibilityEventHandler (VisibilityEventHandler *visibilityEventHandler)
static Widget *	getMouseCapture ()
static void	resetGlobalFont ()
static void	setGlobalFont (Font *font)
static bool	widgetExists (Widget const *widget)
Protected Types inherited from fcn::Container
using	ContainerListenerIterator = ContainerListenerList::iterator
using	ContainerListenerList = std::list<ContainerListener*>
Protected Attributes inherited from fcn::HorizontalBar
bool	mClipping {true}
bool	mExpandChildren {false}
unsigned int	mFixedHeight {0}
unsigned int	mPadding {4}
unsigned int	mSpacing {4}
Protected Attributes inherited from fcn::Container
Widget *	mBackgroundWidget {nullptr}
ContainerListenerList	mContainerListeners
unsigned int	mHorizontalSpacing {2}
LayoutPolicy	mLayout {LayoutPolicy::Absolute}
float	mOpacity {1.0F}
bool	mOpaque {true}
bool	mUniform {false}
unsigned int	mVerticalSpacing {2}
Protected Attributes inherited from fcn::Widget
std::string	mActionEventId
std::list< ActionListener * >	mActionListeners
Color	mBackgroundColor {0xf9fafb}
Color	mBaseColor {0xe5e7eb}
Color	mBorderColor {0xd1d5db}
unsigned int	mBorderSides {BORDER_ALL}
unsigned int	mBorderSize {0}
unsigned int	mBorderStyle {BORDER_STYLE_FLAT}
std::list< Widget * >	mChildren
Font *	mCurrentFont {nullptr}
std::list< DeathListener * >	mDeathListeners
Rectangle	mDimension
std::list< DropTargetListener * >	mDropTargetListeners
bool	mEnabled {true}
Size	mFixedSize {-1, -1}
bool	mFixedSizeUsed {false}
bool	mFocusable {false}
bool	mFocused {false}
FocusHandler *	mFocusHandler {nullptr}
std::list< FocusListener * >	mFocusListeners
Color	mForegroundColor {0x1f2933}
bool	mHExpand {false}
std::string	mId
FocusHandler *	mInternalFocusHandler {nullptr}
std::list< KeyListener * >	mKeyListeners
int	mLastX {0}
int	mLastY {0}
int	mMarginBottom {0}
int	mMarginLeft {0}
int	mMarginRight {0}
int	mMarginTop {0}
Size	mMaxSize {std::numeric_limits<int>::max(), std::numeric_limits<int>::max()}
Size	mMinSize {0, 0}
std::list< MouseListener * >	mMouseListeners
Rectangle	mOffsetRect
Color	mOutlineColor {0x9ca3af}
unsigned int	mOutlineSize {0}
unsigned int	mPaddingBottom {0}
unsigned int	mPaddingLeft {0}
unsigned int	mPaddingRight {0}
unsigned int	mPaddingTop {0}
Widget *	mParent {nullptr}
Color	mSelectionColor {0x3b82f6}
SelectionMode	mSelectionMode {SelectionMode::None}
bool	mTabIn {true}
bool	mTabOut {true}
bool	mVExpand {false}
bool	mVisible {true}
std::list< WidgetListener * >	mWidgetListeners
Static Protected Attributes inherited from fcn::Widget
static DefaultFont	mDefaultFont
static Font *	mGlobalFont = nullptr
static DeathListener *	mGuiDeathListener = nullptr
static VisibilityEventHandler *	mVisibilityEventHandler = nullptr
static std::list< Widget * >	mWidgetInstances
static Widget *	sMouseCapture = nullptr

Detailed Description

A status bar widget that displays information at the bottom of a window.

Definition at line 24 of file statusbar.hpp.

Constructor & Destructor Documentation

StatusBar()

fcn::StatusBar::StatusBar

(

)

Constructor.

Definition at line 19 of file statusbar.cpp.

References fcn::Container::add(), fcn::HorizontalBar::setExpandChildren(), fcn::Widget::setHeight(), and fcn::Container::setLayout().

Member Function Documentation

draw()

void fcn::StatusBar::draw ( Graphics * graphics )

overrideprotectedvirtual

Draws the status bar.

Reimplemented from fcn::HorizontalBar.

Definition at line 59 of file statusbar.cpp.

References fcn::Container::draw(), fcn::Graphics::drawLine(), fcn::Graphics::drawText(), fcn::Widget::getFont(), fcn::Widget::getForegroundColor(), fcn::Widget::getHeight(), fcn::Widget::getPaddingBottom(), fcn::Widget::getPaddingTop(), fcn::Widget::getWidth(), fcn::Container::isOpaque(), fcn::Graphics::popClipArea(), fcn::Graphics::pushClipArea(), fcn::Graphics::setColor(), and fcn::Graphics::setFont().

getIconArea()

Container * fcn::StatusBar::getIconArea

(

)

const

Access to the icon area (fixed size, left).

Definition at line 161 of file statusbar.cpp.

getLeftArea()

Container * fcn::StatusBar::getLeftArea

(

)

const

Access to the left (flexible) area.

Definition at line 166 of file statusbar.cpp.

getRightArea()

Container * fcn::StatusBar::getRightArea

(

)

const

Access to the right (fixed) area.

Definition at line 171 of file statusbar.cpp.

getText()

std::string const & fcn::StatusBar::getText

(

)

const

Gets the status text.

Returns

The status text.

See also

setText

Definition at line 54 of file statusbar.cpp.

isShrinkPriorityEnabled()

bool fcn::StatusBar::isShrinkPriorityEnabled

(

)

const

Checks if shrink priority handling is enabled.

Returns

True if shrink priority is enabled.

See also

setShrinkPriorityEnabled

Definition at line 181 of file statusbar.cpp.

isTruncateWithEllipsis()

bool fcn::StatusBar::isTruncateWithEllipsis

(

)

const

Checks if truncation with ellipsis is enabled.

Returns

True if truncation with ellipsis is enabled.

See also

setTruncateWithEllipsis

Definition at line 191 of file statusbar.cpp.

setShrinkPriorityEnabled()

void fcn::StatusBar::setShrinkPriorityEnabled

(

bool

enabled

)

Enables or disables shrink priority handling.

When enabled, the status bar will shrink the leftArea first when width is constrained, before truncating text.

Parameters

enabled

True to enable shrink priority, false to disable.

See also

isShrinkPriorityEnabled

Definition at line 176 of file statusbar.cpp.

setText()

void fcn::StatusBar::setText

(

std::string const &

text

)

Sets the status text.

Parameters

text	The text to display.

See also

getText

Definition at line 49 of file statusbar.cpp.

setTruncateWithEllipsis()

void fcn::StatusBar::setTruncateWithEllipsis

(

bool

enabled

)

Enables or disables truncation with ellipsis.

When enabled and text needs to be truncated, "..." will be shown at the end of the truncated text.

Parameters

enabled

True to enable truncation with ellipsis.

See also

isTruncateWithEllipsis

Definition at line 186 of file statusbar.cpp.

---

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

• statusbar.hpp
• statusbar.cpp