#include <icon.hpp>

Inheritance diagram for fcn::Icon:

Public Member Functions
void	adjustSize () override
void	draw (Graphics *graphics) override
Image const *	getImage () const
	Icon (Icon &&)=delete
	Icon (Icon const &)=delete
	Icon (Image const *image)
	Icon (std::string const &filename)
bool	isOpaque () const
bool	isScaling () const
bool	isTiling () const
Icon &	operator= (Icon &&)=delete
Icon &	operator= (Icon const &)=delete
void	resizeToContent ()
void	resizeToContent (bool recursion) override
void	setImage (Image const *image)
void	setImage (std::string const &filename)
void	setOpaque (bool opaque)
void	setScaling (bool scale)
void	setTiling (bool tile)
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	addFocusListener (FocusListener *focusListener)
void	addKeyListener (KeyListener *keyListener)
void	addMouseListener (MouseListener *mouseListener)
void	addWidgetListener (WidgetListener *widgetListener)
virtual void	drawBorder (Graphics *graphics)
virtual void	drawOutline (Graphics *graphics)
virtual void	drawSelectionFrame (Graphics *graphics)
void	expandContent ()
virtual void	expandContent (bool recursion)
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	getBorderSize () const
virtual Rectangle	getChildrenArea ()
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	isEnabled () const
bool	isFixedSize () const
bool	isFocusable () const
virtual bool	isFocused () const
bool	isHorizontalExpand () const
bool	isLastPositionSet () const
virtual bool	isLayouted ()
virtual bool	isModalFocusable () const
virtual bool	isModalFocused () const
virtual bool	isModalMouseInputFocusable () const
virtual bool	isModalMouseInputFocused () const
bool	isSetVisible () const
bool	isTabInEnabled () const
bool	isTabOutEnabled () const
bool	isVerticalExpand () const
bool	isVisible () const
virtual void	logic ()
virtual void	moveToBottom (Widget *widget)
virtual void	moveToTop (Widget *widget)
Widget &	operator= (Widget &&)=delete
Widget &	operator= (Widget const &)=delete
virtual void	releaseModalFocus ()
virtual void	releaseModalMouseInputFocus ()
void	removeActionListener (ActionListener *actionListener)
void	removeDeathListener (DeathListener *deathListener)
void	removeFocusListener (FocusListener *focusListener)
void	removeKeyListener (KeyListener *keyListener)
void	removeMouseListener (MouseListener *mouseListener)
void	removeWidgetListener (WidgetListener *widgetListener)
virtual void	requestFocus ()
virtual void	requestModalFocus ()
virtual void	requestModalMouseInputFocus ()
virtual void	requestMoveToBottom ()
virtual void	requestMoveToTop ()
void	resizeToContent ()
void	setActionEventId (std::string const &actionEventId)
virtual void	setBackgroundColor (Color const &color)
virtual void	setBaseColor (Color const &color)
virtual void	setBorderColor (Color const &color)
void	setBorderSize (unsigned int size)
void	setDimension (Rectangle const &dimension)
void	setEnabled (bool enabled)
void	setFixedSize (Size const &size)
void	setFocusable (bool focusable)
virtual void	setFont (Font *font)
virtual void	setForegroundColor (Color const &color)
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)
void	setSize (int width, int height)
void	setTabInEnabled (bool enabled)
void	setTabOutEnabled (bool enabled)
void	setVerticalExpand (bool expand)
void	setVisible (bool visible)
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	adjustSizeImpl ()
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	distributeHiddenEvent ()
void	distributeMovedEvent ()
void	distributeResizedEvent ()
void	distributeShownEvent ()
virtual Widget *	findWidgetById (std::string const &id)
std::list< Widget * > const &	getChildren () const
virtual void	remove (Widget *widget)
virtual void	removeAllChildren ()
void	resizeToChildren ()

Protected Attributes
Image const *	mImage {nullptr}
bool	mInternalImage {false}
bool	mOpaque {true}
bool	mScale {false}
bool	mTile {false}
Protected Attributes inherited from fcn::Widget
std::string	mActionEventId
std::list< ActionListener * >	mActionListeners
Color	mBackgroundColor {0xf9fafb}
Color	mBaseColor {0xe5e7eb}
Color	mBorderColor {0xd1d5db}
unsigned int	mBorderSize {0}
std::list< Widget * >	mChildren
Font *	mCurrentFont {nullptr}
std::list< DeathListener * >	mDeathListeners
Rectangle	mDimension
bool	mEnabled {true}
Size	mFixedSize {-1, -1}
bool	mFixedSizeUsed {false}
bool	mFocusable {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

Additional Inherited Members
Public Types inherited from fcn::Widget
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 void	setGlobalFont (Font *font)
static bool	widgetExists (Widget const *widget)
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

Detailed Description

Displays a static image icon.

Definition at line 21 of file icon.hpp.

Constructor & Destructor Documentation

◆ Icon() [1/3]

fcn::Icon::Icon ( )

Definition at line 15 of file icon.cpp.

◆ Icon() [2/3]

fcn::Icon::Icon ( std::string const & filename )

explicit

Constructor.

Parameters

filename The filename of the image to display.

Definition at line 21 of file icon.cpp.

References adjustSizeImpl(), mImage, and mInternalImage.

◆ Icon() [3/3]

fcn::Icon::Icon ( Image const * image )

explicit

Constructor.

Parameters

image The image to display.

Definition at line 27 of file icon.cpp.

References adjustSizeImpl(), mImage, and mInternalImage.

◆ ~Icon()

fcn::Icon::~Icon ( )

override

Definition at line 33 of file icon.cpp.

Member Function Documentation

◆ adjustSize()

void fcn::Icon::adjustSize ( )

overridevirtual

Resizes the widget's size to fit the content exactly.

Reimplemented from fcn::Widget.

Definition at line 103 of file icon.cpp.

References adjustSizeImpl().

◆ adjustSizeImpl()

void fcn::Icon::adjustSizeImpl ( )

protected

Adjusts the size of the icon to fit the image.

The public adjustSize() method serves as a virtual entry point for polymorphism, while this adjustSizeImpl() method contains the concrete implementation of the resizing logic.

See also: adjustSize (virtual entry point for polymorphism)

Definition at line 108 of file icon.cpp.

References fcn::Widget::getBorderSize(), fcn::Widget::getPaddingBottom(), fcn::Widget::getPaddingLeft(), fcn::Widget::getPaddingRight(), fcn::Widget::getPaddingTop(), mImage, mScale, mTile, and fcn::Widget::setSize().

Referenced by adjustSize(), Icon(), Icon(), resizeToContent(), setImage(), and setImage().

◆ draw()

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

overridevirtual

Draws the widget.

The call to draw is initiated by the widget's parent. The graphics object is set up so that all drawing is relative to the widget, i.e coordinate (0,0) is the top left corner of the widget. It is not possible to draw outside of a widget's dimension. If a widget has children, the parent's draw function will always be called before the children's draw functions are called.

NOTE: A widget with children won't draw its children unless the children area given by Widget::getChildrenArea returns a none empty rectangle inside the widgets dimension. The children area is considered relative to the widget's position.

Parameters

Graphics & Rendering A graphics object to draw with.

See also: getChildrenArea, drawOutline, drawBorder

Implements fcn::Widget.

Definition at line 123 of file icon.cpp.

◆ getImage()

Image const * fcn::Icon::getImage ( ) const

Gets the current image.

Returns: The current image.

Definition at line 62 of file icon.cpp.

References mImage.

◆ isOpaque()

bool fcn::Icon::isOpaque ( ) const

Returns: Whether this icons background is opaque or not.

Definition at line 92 of file icon.cpp.

References mOpaque.

◆ isScaling()

bool fcn::Icon::isScaling ( ) const

Gets if the image is scaled to widget size.

Returns: True if the image is scaled to widget size, otherwise false.

Definition at line 67 of file icon.cpp.

References mScale.

◆ isTiling()

bool fcn::Icon::isTiling ( ) const

Gets if the image is tiled to widget size.

Returns: True if the image is tiled to widget size, otherwise false.

Definition at line 77 of file icon.cpp.

References mTile.

◆ resizeToContent() [1/2]

void fcn::Widget::resizeToContent ( )

inline

Resizes the widget's size to fit the content exactly, calls recursively all childs.

This is a convenience wrapper that calls resizeToContent(true).

Definition at line 1417 of file widget.hpp.

◆ resizeToContent() [2/2]

void fcn::Icon::resizeToContent ( bool recursion )

overridevirtual

Resize this widget to fit its content.

Parameters

recursion If true, perform the resize operation recursively on children.

Reimplemented from fcn::Widget.

Definition at line 97 of file icon.cpp.

References adjustSizeImpl().

◆ setImage() [1/2]

void fcn::Icon::setImage ( Image const * image )

Sets the image to display.

Existing image is freed automatically if it was loaded internally.

Parameters

image The image to display.

Definition at line 51 of file icon.cpp.

References adjustSizeImpl(), mImage, and mInternalImage.

◆ setImage() [2/2]

void fcn::Icon::setImage ( std::string const & filename )

Sets the image to display.

Existing image is freed automatically if it was loaded internally.

Parameters

filename The image to display.

Definition at line 40 of file icon.cpp.

References adjustSizeImpl(), fcn::Image::load(), mImage, and mInternalImage.

◆ setOpaque()

void fcn::Icon::setOpaque ( bool opaque )

Sets the opacity of the background.

Parameters

opaque True if opaque, false otherwise.

Definition at line 87 of file icon.cpp.

References mOpaque.

◆ setScaling()

void fcn::Icon::setScaling ( bool scale )

Sets if the image should be scaled to widget size.

Parameters

scale True if the image should be scaled.

Definition at line 72 of file icon.cpp.

References mScale.

◆ setTiling()

void fcn::Icon::setTiling ( bool tile )

Sets if the image should be tiled to widget size.

Parameters

tile	True if the image should be tiled.

Definition at line 82 of file icon.cpp.

References mTile.

Member Data Documentation

◆ mImage

Image const* fcn::Icon::mImage {nullptr}

protected

The image to display.

Definition at line 122 of file icon.hpp.

Referenced by adjustSizeImpl(), draw(), getImage(), Icon(), Icon(), setImage(), and setImage().

◆ mInternalImage

bool fcn::Icon::mInternalImage {false}

protected

True if the image has been loaded internally, false otherwise.

An image not loaded internally should not be deleted in the destructor.

Definition at line 129 of file icon.hpp.

Referenced by Icon(), Icon(), setImage(), and setImage().

◆ mOpaque

bool fcn::Icon::mOpaque {true}

protected

True if opaque, otherwise false.

Definition at line 138 of file icon.hpp.

Referenced by draw(), isOpaque(), and setOpaque().

◆ mScale

bool fcn::Icon::mScale {false}

protected

True if scaling is enabled, otherwise false.

Definition at line 132 of file icon.hpp.

Referenced by adjustSizeImpl(), draw(), isScaling(), and setScaling().

◆ mTile

bool fcn::Icon::mTile {false}

protected

True if tiling is enabled, otherwise false.

Definition at line 135 of file icon.hpp.

Referenced by adjustSizeImpl(), draw(), isTiling(), and setTiling().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Icon() [1/3]

◆ Icon() [2/3]

◆ Icon() [3/3]

◆ ~Icon()

Member Function Documentation

◆ adjustSize()

◆ adjustSizeImpl()

◆ draw()

◆ getImage()

◆ isOpaque()

◆ isScaling()

◆ isTiling()

◆ resizeToContent() [1/2]

◆ resizeToContent() [2/2]

◆ setImage() [1/2]

◆ setImage() [2/2]

◆ setOpaque()

◆ setScaling()

◆ setTiling()

Member Data Documentation

◆ mImage

◆ mInternalImage

◆ mOpaque

◆ mScale

◆ mTile