Embedded Artists
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
ImageButton Class Reference
The ImageButton is used in the same way as the Button so see it for an example. More...
#include <ImageButton.h>
Inherits Clickable.
Public Member Functions | |
| ImageButton (COLOR_T *fb, uint16_t x, uint16_t y, uint16_t width, uint16_t height, const char *caption=NULL, COLOR_T color=BLACK) | |
| Creates a new button. | |
| bool | loadImages (const char *imgUp, const char *imgDown=0) |
| Loads the mandatory "normal" state image and the optional "pressed" state image. | |
| bool | loadImages (const unsigned char *imgUp, unsigned int imgUpSize, const unsigned char *imgDown=0, unsigned int imgDownSize=0) |
| Loads the mandatory "normal" state image and the optional "pressed" state image. | |
| bool | loadImages (Resource *resImgUp, Resource *resImgDown=0) |
| Loads the mandatory "normal" state image and the optional "pressed" state image. | |
| void | setTransparency (COLOR_T tColor) |
| Specifys a color that will be considered transparent (i.e. | |
| virtual void | draw (COLOR_T *fb=0) |
| Draws the button (on a new framebuffer if one is specified) | |
| 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) | |
Detailed Description
The ImageButton is used in the same way as the Button so see it for an example.
Definition at line 27 of file ImageButton.h.
Constructor & Destructor Documentation
| ImageButton | ( | COLOR_T * | fb, |
| uint16_t | x, | ||
| uint16_t | y, | ||
| uint16_t | width, | ||
| uint16_t | height, | ||
| const char * | caption = NULL, |
||
| COLOR_T | color = BLACK |
||
| ) |
Creates a new button.
This button will use a SWIM window to draw on. That window will use part of the full size frame buffer to draw on.
- Parameters:
-
fb the frame buffer x the upper left corner of the button y the upper left corner of the button width the width of the button height the height of the button caption optional text to put below the image color text color
Definition at line 25 of file ImageButton.cpp.
Member Function Documentation
| void draw | ( | COLOR_T * | fb = 0 ) |
[virtual] |
Draws the button (on a new framebuffer if one is specified)
- Parameters:
-
fb the frame buffer
Implements Clickable.
Definition at line 138 of file ImageButton.cpp.
| bool handle | ( | uint16_t | x, |
| uint16_t | y, | ||
| bool | pressed | ||
| ) | [inherited] |
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:
-
x the touched x coordinate y the touched y coordinate pressed true 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 loadImages | ( | const char * | imgUp, |
| const char * | imgDown = 0 |
||
| ) |
Loads the mandatory "normal" state image and the optional "pressed" state image.
- Parameters:
-
imgUp the file with the image for the normal state imgDown the file with the image for the pressed state (or NULL to use the same)
- Returns:
- true on success false on failure
Definition at line 61 of file ImageButton.cpp.
| bool loadImages | ( | const unsigned char * | imgUp, |
| unsigned int | imgUpSize, | ||
| const unsigned char * | imgDown = 0, |
||
| unsigned int | imgDownSize = 0 |
||
| ) |
Loads the mandatory "normal" state image and the optional "pressed" state image.
- Parameters:
-
imgUp the image for the normal state imgUpSize the size of the imgUp data imgDown the image for the pressed state (or NULL to use the same) imgUpSize the size of the imgDown data
- Returns:
- true on success false on failure
Definition at line 84 of file ImageButton.cpp.
Loads the mandatory "normal" state image and the optional "pressed" state image.
- Parameters:
-
resImgUp the resource for the normal state image resImgDown the resource for the pressed state image (or NULL to use the same)
- Returns:
- true on success false on failure
Definition at line 108 of file ImageButton.cpp.
| bool pressed | ( | ) | [inherited] |
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 | ||
| ) | [inherited] |
Set the function to call when clicked.
Note that this function can be called with NULL as func to unregister the callback function.
- Parameters:
-
func the function to call arc the argument to pass to the function when calling
Definition at line 50 of file Clickable.h.
| void setTransparency | ( | COLOR_T | tColor ) |
Specifys a color that will be considered transparent (i.e.
will not be drawn)
- Parameters:
-
tColor the transparent color
Definition at line 132 of file ImageButton.cpp.
Generated on Tue Jul 12 2022 21:27:04 by
1.7.2