CheckBoxWidget Class Reference

#include <CheckBoxWidget.h>

Inheritance diagram for CheckBoxWidget:

Collaboration diagram for CheckBoxWidget:

Public Types
enum	tick { Square_Tick = 0, Cross_Tick = 1 }

Public Member Functions
	CheckBoxWidget ()
	CheckBoxWidget (char *l, int x, int y, int w, int h, Widget *p)
virtual	~CheckBoxWidget ()
virtual void	invert ()
virtual bool	isticked (void)
virtual void	logic (CursorTask *mouse, KeyboardTask *keyboard) override
virtual void	render (SDL_Surface *screen, ColorEngine *colors, FontEngine *fonts) override
virtual void	settype (tick type)
virtual tick	gettype ()
Public Member Functions inherited from ButtonWidget
	ButtonWidget ()
	ButtonWidget (char *l, int x, int y, int w, int h, Widget *p)
	~ButtonWidget ()
virtual bool	ispressed ()
Public Member Functions inherited from Widget
	Widget (char *l, int x, int y, int w, int h, Widget *p)
virtual void	focus (Widget *emitter)
virtual void	unfocusup (Widget *emitter)
virtual void	unfocusdown (Widget *emitter)
virtual void	addchild (Widget *child)
virtual void	setdimensions (int mx, int my, int mw, int mh)
virtual void	setxpos (int mx)
virtual void	setypos (int my)
virtual void	setwidth (int mw)
virtual void	setheight (int mh)
virtual void	setlabel (char *l)
virtual void	setcontainerstatus (bool status)
virtual void	setparent (Widget *p)
virtual void	setvisible ()
virtual void	setinvisible ()
virtual void	enable ()
virtual void	disable ()
virtual void	adjust ()
virtual int	getxpos ()
virtual int	getypos ()
virtual int	getwidth ()
virtual int	getheight ()
virtual int	getuseablexpos ()
virtual int	getuseableypos ()
virtual int	getuseablewidth ()
virtual int	getuseableheight ()
virtual char *	getlabel ()
virtual bool	getcontainerstatus ()
virtual Widget *	getparent ()
virtual bool	getisenabled ()
virtual bool	isvisible ()
virtual char *	getwidgettype ()
virtual void	linkonclick (void(*func)(char *))
virtual void	linkonrelease (void(*func)(char *))
virtual void	linkonhover (void(*func)(char *))

Additional Inherited Members
Protected Member Functions inherited from Widget
virtual bool	cursoron (CursorTask *mouse)
Protected Attributes inherited from Widget
bool	has_focus = false
bool	is_enabled = true
bool	is_visible = true
char *	widgettype
char *	label
int	xpos
int	xrel
int	ypos
int	yrel
int	width
int	widrel
int	height
int	heirel
bool	is_container = false
bool	is_hovering = false
Widget *	parent = nullptr
int	nbchildren
std::vector< Widget * >	children
void(*	clickfunction )(char *) = nullptr
void(*	releasefunction )(char *) = nullptr
void(*	hoverfunction )(char *) = nullptr

Detailed Description

Example of program using CheckBoxWidget controls

The following simple example demonstrates how to use the CheckBoxWidget controls.

Examples of usage:

#include "Toolkit/GUIToolkit.h"
 
int main ( int argc, char** argv )
{
    bool done = false;
 
    WidgetApplication *MyApp = new WidgetApplication();
    MyApp->setuniformbackgroundcolor(0, 0, 0);
 
    DesktopWidget *desktop1 = new DesktopWidget( (char*) "First Desktop", 0, 0, SCREEN_WIDTH, SCREEN_HEIGHT, nullptr );
 
    WindowWidget *window = new WindowWidget( (char*) "Examples of ButtonWidgets", 20, 30, 250, 160, desktop1 );
 
    ContainerVWidget *contH = new ContainerVWidget( (char*) "ContainerH", 1, 1, 1, 1, window );
 
   CheckBoxWidget *check1 = new CheckBoxWidget();          // Simple constructor so we need to assign all the parameters
 
   // First the label to be written on the checkbox
   check1->setlabel( (char*) "Enabled CheckBox - Square tick" );
 
   // then the dimensions (one by one in that case)
   check1->setxpos( 5 );
   check1->setypos( 10 );
   check1->setwidth( 150 );
   check1->setheight( 15 );
   // note : we can also use the method checkbox->setdimensions( 5, 10, 150, 15 ) instead
 
   // We set the style to "Square_Tick"
   check1->settype( CheckBoxWidget::Square_Tick );
 
   // and finally we assign the parent by adding the checkbox as a child to conH
   contH->addchild( check1 );
 
   // This is a second checkbox with all parameters passed through the constructon
   CheckBoxWidget *check2 = new CheckBoxWidget( (char*) "Enabled CheckBox - Cross tick", 1, 1, 1, 1, contH );
   // We set the style to "Square_Tick"
   check2->settype( CheckBoxWidget::Cross_Tick );
 
   // This is a third checkbox with all parameters passed through the constructon
   CheckBoxWidget *check3 = new CheckBoxWidget( (char*) "Disabled CheckBox - Square tick", 1, 1, 1, 1, contH );
   // We set the style to "Square_Tick"
   check3->settype( CheckBoxWidget::Square_Tick );
   // We disable the checkbox by using the inherited method Wigdet::disable()
   check3->disable();
 
   // This is a third checkbox with all parameters passed through the constructon
   CheckBoxWidget *check4 = new CheckBoxWidget( (char*) "Disabled CheckBox - Square tick", 1, 1, 1, 1, contH );
   // We set the style to "Cross_Tick"
   check4->settype( CheckBoxWidget::Cross_Tick );
   // We disable the checkbox by using the inherited method Wigdet::disable()
   check4->disable();
 
    // the button to be clicked to quit
    ButtonWidget *buttonQuit = new ButtonWidget( (char*) "Quit [CTRL]+[ESC]", 1, 1, 1, 1, contH );
 
    // We ask for an automatic positioning of the widgets in the grid
    // Note : this will fully override the dimensions given to the Widgets manually
    window->adjust();
 
    MyApp->addchild( desktop1 );
 
    KeyboardTask *keyboard = MyApp->getkeyboardhandler();
 
    // We render the app for the first time so what we can see what's happening on the screen
    MyApp->render();
 
    while (!done)
    {
 
        MyApp->logic();
 
        if ((keyboard->kbCTRL && keyboard->kbESC) || buttonQuit->ispressed()) done = true;
 
    }
 
    return 0;
}

CheckBoxWidget class.

The class to be used for using a CheckBoxWidget control widget. CheckBoxWidget inherits from ButtonWidget class.

See also

ButtonWidget

Examples of usage:

CheckBoxWidget* myCheckBox = new CheckBoxWidget();        // Simple constructor, will need specific properties assignement later

CheckBoxWidget* myCheckBox = new CheckBoxWidget( "I am a CheckBox", 10, 50, 100, 15, parent );        // Full constructor

Member Enumeration Documentation

tick

enum CheckBoxWidget::tick

Enumerator for CheckBoxWidget style.

Gives the style of CheckBoxWidget (of the tickmark). Square_Tick style represents the tick by a rounded square Cross_Tick style represents the tick by a X / Cross

Constructor & Destructor Documentation

CheckBoxWidget() [1/2]

CheckBoxWidget::CheckBoxWidget ( )

inline

Simple constructor.

Widget properties are set to default, nothing more. Simple constructor, will need specific properties assignement later.

Parameters

None

Returns

Nothing

See also

ButtonWidget() or Widget()

CheckBoxWidget() [2/2]

CheckBoxWidget::CheckBoxWidget ( char *  l, int  x, int  y, int  w, int  h, Widget *  p  )

inline

Advanced constructor.

Widget properties are set with parameters values given at call.

Parameters

l	: text string (char*) that will be used as the widget textual content
x	: position x in pixels relatively to the parent widget usable drawspace
y	: position y in pixels relatively to the parent widget usable drawspace
w	: width in pixel of the widget
h	: height in pixel of the widget
p	: pointer type to a Widget* to create a link with the parent widget (if any).

Note

p should be set to nullptr if no parent exists

p can be omitted (i.e. set to nullptr) and parent-children link can be created with a call to the Widget::addchild() method of the parent Widget.

Returns

Nothing

See also

ButtonWidget( char*, int, int, int, int, Widget* ) or Widget( char*, int, int, int, int, Widget* )

~CheckBoxWidget()

virtual CheckBoxWidget::~CheckBoxWidget ( )

inlinevirtual

Object destructor

Object destructor, remove all trace of the object and free allocated memory

Parameters

None

Returns

Nothing

See also

~Widget()

Member Function Documentation

gettype()

virtual tick CheckBoxWidget::gettype ( )

inlinevirtual

CheckBoxWidget style getter.

Gives the style of CheckBoxWidget (of the tickmark)

Parameters

None

Returns

The corresponding type of CheckBoxWidget style

See also

tick

invert()

virtual void CheckBoxWidget::invert ( )

inlinevirtual

Invert the CheckBox status

Invert the CheckBoxWidget status, if unticked --> ticked and if ticked --> unticked

Parameters

None

Returns

None

Note

It changes the internal property is_ticked of the CheckBoxWidget

isticked()

virtual bool CheckBoxWidget::isticked ( void  )

inlinevirtual

Is the CheckBox ticked ?

Gives the status of the CheckBoxWidget (ticked or not).

Parameters

None

Returns

Boolean value : true if the CheckBox is ticked, false otherwise

logic()

void CheckBoxWidget::logic ( CursorTask *  mouse, KeyboardTask *  keyboard  )

overridevirtual

The CheckBoxWidget logic mechanism

Method to be launched to drive the the mechanics behind the CheckBoxWidget behavior.

Parameters

mouse	: pointer to a CursorTask handler object serving at passing the mouse (Touchpad) state and position
keyboard	: pointer to a KeyboardTask handler object serving at passing the keyboard state

Returns

Nothing, but will launch the logic() method of all the widgets belonging to chidren (vector<Widget*>)

Note

This method overrides Widget::logic( CursorTask*, KeyboardTask*)

This method is not intended to be used by a direct call from the user, it is normally called through cascaded calls to children->logic() from the WidgetApplication class

Direct call can be used when the Widget is used out of the WidgetApplication 'ecosystem', for example in an application that just use few individual widgets (not recommended cause it may need intensive work from the developper to create adequate working conditions).

Warning

Before calling the logic method, a mouse handler and a keyboard handler must be instancied and properly updated through their respective logic() methods. This is normally done by using the WidgetApplication class.

Reimplemented from ButtonWidget.

render()

void CheckBoxWidget::render ( SDL_Surface *  screen, ColorEngine *  colors, FontEngine *  fonts  )

overridevirtual

The CheckBoxWidget render method.

Method to be launched to draw the widget.

Parameters

screen	: pointer to a SDL_Surface object where we would like to draw the widget
colors	: pointer to a ColorEngine object giving all the color options to be used (theme) for drawing the widget
fonts	: pointer to a FontEngine object giving all the fonts options to be used (theme) for drawing the widget

Returns

Nothing, but will launch the render() method of all the Widgets belonging to chidren (vector<Widget*>)

Note

This method overrides Widget::render( SDL_Surface*, ColorEngine*, FontEngine*)

This method is not intended to be used by a direct call from the user, it is normally called through cascaded calls to children->render() from the WidgetApplication class.

Direct call can be used when the Widget is used out of the WidgetApplication 'ecosystem', for example in an application that just use few individual widgets (not recommended cause it may need intensive work from the developper to create adequate working conditions).

Warning

Before calling the render method, a SDL_Surface (i.e. a rendering context) as well as a ColorEngine and FontEngine objects must be properly instancied. This is normally done by using the WidgetApplication class.

Reimplemented from ButtonWidget.

settype()

virtual void CheckBoxWidget::settype ( tick  type )

inlinevirtual

CheckBoxWidget style setter.

Gives the style of CheckBoxWidget (of the tickmark)

Parameters

type	refers to one of the styles given by the tick enumerator

Returns

Nothing

See also

tick

---

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

• /home/sylvain/NSpire_Programming/Widgets/Widgets/Toolkit/CheckBoxWidget.h
• /home/sylvain/NSpire_Programming/Widgets/Widgets/Toolkit/CheckBoxWidget.cpp