A basic graphics package for the LPC4088 Display Module.

Dependents:   lpc4088_displaymodule_demo_sphere sampleGUI sampleEmptyGUI lpc4088_displaymodule_fs_aid ... more

Fork of DMBasicGUI by EmbeddedArtists AB

Embed: (wiki syntax)

« Back to documentation index

Clickable Class Reference

Clickable Class Reference

Clickable is an abstract base class for the Button and ImageButton. More...

#include <Clickable.h>

Inherited by Button, DigitButton, and ImageButton.

Public Member Functions

 Clickable (COLOR_T *fb, uint16_t x, uint16_t y, uint16_t width, uint16_t height)
 Creates a new clickable.
void setAction (void(*func)(uint32_t arg), uint32_t arg)
 Set the function to call when clicked.
bool handle (uint16_t x, uint16_t y, bool pressed)
 Process the touch event.
bool pressed ()
 Test if the button is held down (usable for repeated presses)
virtual void draw (COLOR_T *fb=0)=0
 Draws the button (on a new framebuffer if one is specified)

Detailed Description

Clickable is an abstract base class for the Button and ImageButton.

Definition at line 25 of file Clickable.h.


Constructor & Destructor Documentation

Clickable ( COLOR_T *  fb,
uint16_t  x,
uint16_t  y,
uint16_t  width,
uint16_t  height 
)

Creates a new clickable.

This clickable will use a SWIM window to draw on. That window will use part of the full size frame buffer to draw on.

Parameters:
fbthe frame buffer
xthe upper left corner of the button
ythe upper left corner of the button
widththe width of the button
heightthe height of the button

Definition at line 23 of file Clickable.cpp.


Member Function Documentation

virtual void draw ( COLOR_T *  fb = 0 ) [pure virtual]

Draws the button (on a new framebuffer if one is specified)

Parameters:
fbthe frame buffer

Implemented in Button, DigitButton, and ImageButton.

bool handle ( uint16_t  x,
uint16_t  y,
bool  pressed 
)

Process the touch event.

This function will detect if and how the touch event affects it. If the event causes a click then the registered callback function is called before handle() returns.

The return value is to let the caller now if the button should be redrawn or not.

Parameters:
xthe touched x coordinate
ythe touched y coordinate
pressedtrue if the user pressed the display
Returns:
true if the button should be redrawn false if the event did not affect the button

Definition at line 40 of file Clickable.cpp.

bool pressed (  )

Test if the button is held down (usable for repeated presses)

Returns:
true if the button is pressed false otherwise

Definition at line 77 of file Clickable.h.

void setAction ( void(*)(uint32_t arg)  func,
uint32_t  arg 
)

Set the function to call when clicked.

Note that this function can be called with NULL as func to unregister the callback function.

Parameters:
functhe function to call
arcthe argument to pass to the function when calling

Definition at line 50 of file Clickable.h.