#include <progressindicator.h>

Inheritance diagram for ProgressIndicator:

Public Member Functions
	ProgressIndicator (const Widget2 *const widget)

	~ProgressIndicator ()

void	logic ()

void	draw (Graphics *const graphics)

void	safeDraw (Graphics *const graphics)

Public Member Functions inherited from Widget
	Widget (const Widget2 *const widget)

	~Widget ()

virtual void	drawFrame (Graphics *graphics)

virtual void	safeDrawFrame (Graphics *graphics)

void	setFrameSize (const unsigned int frameSize)

unsigned int	getFrameSize () const

Widget *	getParent () const

void	setWidth (const int width)

int	getWidth () const

void	setHeight (const int height)

int	getHeight () const

void	setSize (const int width, const int height)

void	setX (const int x)

int	getX () const

void	setY (const int y)

int	getY () const

void	setPosition (const int x, const int y)

void	setDimension (const Rect &dimension)

const Rect &	getDimension () const

void	setFocusable (const bool focusable)

bool	isFocusable () const

virtual bool	isFocused () const

void	setEnabled (const bool enabled)

bool	isEnabled () const

void	setVisible (Visible visible)

bool	isVisible () const

void	setBaseColor (const Color &color)

const Color &	getBaseColor () const

void	setForegroundColor (const Color &color)

const Color &	getForegroundColor () const

void	setBackgroundColor (const Color &color)

const Color &	getBackgroundColor () const

virtual void	requestFocus ()

virtual void	requestMoveToTop ()

virtual void	requestMoveToBottom ()

virtual void	setFocusHandler (FocusHandler *const focusHandler)

FocusHandler *	getFocusHandler ()

void	addActionListener (ActionListener *const actionListener)

void	removeActionListener (ActionListener *const actionListener)

void	addDeathListener (WidgetDeathListener *const deathListener)

void	removeDeathListener (WidgetDeathListener *const deathListener)

void	addMouseListener (MouseListener *const mouseListener)

void	removeMouseListener (MouseListener *const mouseListener)

void	addKeyListener (KeyListener *const keyListener)

void	removeKeyListener (KeyListener *const keyListener)

void	addFocusListener (FocusListener *const focusListener)

void	removeFocusListener (FocusListener *const focusListener)

void	addWidgetListener (WidgetListener *const widgetListener)

void	removeWidgetListener (WidgetListener *const widgetListener)

void	setActionEventId (const std::string &actionEventId)

const std::string &	getActionEventId () const

virtual void	getAbsolutePosition (int &x, int &y) const

virtual void	setParent (Widget *parent)

Font *	getFont () const

void	setFont (Font *const font)

virtual void	fontChanged ()

bool	isTabInEnabled () const

void	setTabInEnabled (const bool enabled)

bool	isTabOutEnabled () const

void	setTabOutEnabled (const bool enabled)

void	requestModalFocus ()

virtual void	requestModalMouseInputFocus ()

virtual void	releaseModalFocus ()

virtual void	releaseModalMouseInputFocus ()

virtual bool	isModalFocused () const

virtual bool	isModalMouseInputFocused () const

virtual Widget *	getWidgetAt (int x, int y)

const std::list< MouseListener * > &	getMouseListeners () const A_CONST

const std::list< KeyListener * > &	getKeyListeners () const A_CONST

const std::list< FocusListener * > &	getFocusListeners () const A_CONST

virtual Rect	getChildrenArea ()

virtual FocusHandler *	getInternalFocusHandler ()

void	setInternalFocusHandler (FocusHandler *const internalFocusHandler)

virtual void	moveToTop (Widget *widget)

virtual void	moveToBottom (Widget *widget)

virtual void	focusNext ()

virtual void	focusPrevious ()

virtual void	showWidgetPart (Widget *const widget, const Rect &area)

void	setId (const std::string &id)

const std::string &	getId () const

virtual void	showPart (const Rect &rectangle)

bool	isAllowLogic () const

void	setMouseConsume (const bool b)

bool	isMouseConsume () const

void	setRedraw (const bool b)

virtual bool	isSelectable () const

void	setSelectable (const bool selectable)

void	windowResized ()

virtual void	postInit ()

Public Member Functions inherited from Widget2
virtual	~Widget2 ()

const Color &	getThemeColor (const ThemeColorIdT type, const unsigned int alpha) const A_INLINE

const Color &	getThemeCharColor (const signed char c, bool &valid) const A_INLINE

virtual void	setWidget2 (const Widget2 *const widget)

void	setPalette (int palette)

void	checkPalette ()

void	setForegroundColor2 (const Color &color)

Widget *	getWindow () const

virtual void	setWindow (Widget *const window)

Private Attributes
SimpleAnimation *	mIndicator

Additional Inherited Members
Static Public Member Functions inherited from Widget
static void	setGlobalFont (Font *const font)

static Font *	getGloablFont ()

static void	cleanGlobalFont ()

static bool	widgetExists (const Widget *const widget)

static void	distributeWindowResizeEvent ()

static Widget *	callPostInit (Widget *const widget)

Data Fields inherited from Widget
Visible	mVisible

Protected Types inherited from Widget
typedef std::list< MouseListener * >	MouseListenerList

typedef MouseListenerList::iterator	MouseListenerIterator

typedef std::list< KeyListener * >	KeyListenerList

typedef KeyListenerList::iterator	KeyListenerIterator

typedef std::list< ActionListener * >	ActionListenerList

typedef ActionListenerList::iterator	ActionListenerIterator

typedef std::list< WidgetDeathListener * >	WidgetDeathListenerList

typedef WidgetDeathListenerList::iterator	WidgetDeathListenerIterator

typedef std::list< FocusListener * >	FocusListenerList

typedef FocusListenerList::iterator	FocusListenerIterator

typedef std::list< WidgetListener * >	WidgetListenerList

typedef WidgetListenerList::iterator	WidgetListenerIterator

Protected Member Functions inherited from Widget
void	distributeActionEvent ()

void	distributeResizedEvent ()

void	distributeMovedEvent ()

void	distributeHiddenEvent ()

void	distributeShownEvent ()

Protected Member Functions inherited from Widget2
	Widget2 (const Widget2 *const widget)

Protected Attributes inherited from Widget
MouseListenerList	mMouseListeners

KeyListenerList	mKeyListeners

ActionListenerList	mActionListeners

WidgetDeathListenerList	mDeathListeners

FocusListenerList	mFocusListeners

WidgetListenerList	mWidgetListeners

Color	mForegroundColor

Color	mBackgroundColor

Color	mBaseColor

Rect	mDimension

std::string	mActionEventId

std::string	mId

FocusHandler *	mFocusHandler

FocusHandler *	mInternalFocusHandler

Widget *	mParent

Font *	mCurrentFont

unsigned int	mFrameSize

bool	mFocusable

bool	mTabIn

bool	mTabOut

bool	mEnabled

bool	mAllowLogic

bool	mMouseConsume

bool	mRedraw

bool	mSelectable

Protected Attributes inherited from Widget2
int	mPaletteOffset

Widget *	mWindow

Color	mForegroundColor2

Static Protected Attributes inherited from Widget
static Font *	mGlobalFont = 0

Detailed Description

A widget that indicates progress. Suitable to use instead of a progress bar in cases where it is unknown how long something is going to take.

Definition at line 36 of file progressindicator.h.

Constructor & Destructor Documentation

◆ ProgressIndicator()

ProgressIndicator::ProgressIndicator ( const Widget2 *const widget )

explicit

Definition at line 36 of file progressindicator.cpp.

                                                                 :
     Widget(widget),
     mIndicator(nullptr)
 {
     ImageSet *const images = Theme::getImageSetFromTheme(
         "progress-indicator.png", 32, 32);
  
     if (images != nullptr)
     {
         Animation *const anim = new Animation("progress indicator");
         for (ImageSet::size_type i = 0, fsz = images->size();
              i < fsz;
              ++i)
         {
             anim->addFrame(images->get(i), 100, 0, 0, 100);
         }
         mIndicator = new SimpleAnimation(anim);
         images->decRef();
     }
  
     setSize(32, 32);
 }

References Animation::addFrame(), ParticleType::Animation, Resource::decRef(), ImageSet::get(), Theme::getImageSetFromTheme(), mIndicator, Widget::setSize(), and ImageSet::size().

◆ ~ProgressIndicator()

ProgressIndicator::~ProgressIndicator ( )

Definition at line 59 of file progressindicator.cpp.

 {
     if (gui != nullptr)
         gui->removeDragged(this);
  
     delete2(mIndicator)
 }

References delete2, gui, mIndicator, and Gui::removeDragged().

Member Function Documentation

◆ draw()

void ProgressIndicator::draw ( Graphics *const graphics )

virtual

Draws the widget. It is called by the parent widget when it is time for the widget to draw itself. 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.

Parameters

graphics aA graphics object to draw with.

Implements Widget.

Definition at line 75 of file progressindicator.cpp.

 {
     BLOCK_START("ProgressIndicator::draw")
     if (mIndicator != nullptr)
     {
         // Draw the indicator centered on the widget
         const int x = (mDimension.width - 32) / 2;
         const int y = (mDimension.height - 32) / 2;
         mIndicator->draw(graphics, x, y);
     }
     BLOCK_END("ProgressIndicator::draw")
 }

References BLOCK_END, BLOCK_START, SimpleAnimation::draw(), Rect::height, Widget::mDimension, mIndicator, Rect::width, x, and y.

◆ logic()

void ProgressIndicator::logic ( )

virtual

Called for all widgets in the gui each time Gui::logic is called. You can do logic stuff here like playing an animation.

See also: Gui::logic

Reimplemented from Widget.

Definition at line 67 of file progressindicator.cpp.

 {
     BLOCK_START("ProgressIndicator::logic")
     if (mIndicator != nullptr)
         mIndicator->update(10);
     BLOCK_END("ProgressIndicator::logic")
 }

References BLOCK_END, BLOCK_START, mIndicator, and SimpleAnimation::update().

◆ safeDraw()

void ProgressIndicator::safeDraw ( Graphics *const graphics )

virtual

Implements Widget.

Definition at line 88 of file progressindicator.cpp.

 {
     BLOCK_START("ProgressIndicator::draw")
     if (mIndicator != nullptr)
     {
         // Draw the indicator centered on the widget
         const int x = (mDimension.width - 32) / 2;
         const int y = (mDimension.height - 32) / 2;
         mIndicator->draw(graphics, x, y);
     }
     BLOCK_END("ProgressIndicator::draw")
 }

References BLOCK_END, BLOCK_START, SimpleAnimation::draw(), Rect::height, Widget::mDimension, mIndicator, Rect::width, x, and y.

Field Documentation

◆ mIndicator

SimpleAnimation* ProgressIndicator::mIndicator

private

Definition at line 52 of file progressindicator.h.

Referenced by draw(), logic(), ProgressIndicator(), safeDraw(), and ~ProgressIndicator().

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

src/gui/widgets/progressindicator.h (986a3bf)
src/gui/widgets/progressindicator.cpp (986a3bf)

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ProgressIndicator()

◆ ~ProgressIndicator()

Member Function Documentation

◆ draw()

◆ logic()

◆ safeDraw()

Field Documentation

◆ mIndicator