David Prentice / ADA_GFX_kbv_R1107

Dependents:   TFT_Touch_botao_v1 TFT_Touch_exemplo5_git_touch TESTE_1 TFT_Touch_exemplo6_git_touch_button_3_ ... more

Embed: (wiki syntax)

« Back to documentation index

Adafruit_GFX_Button Class Reference

Adafruit_GFX_Button Class Reference

A simple drawn button UI element. More...

#include <Adafruit_GFX.h>

Public Member Functions

 Adafruit_GFX_Button (void)
 Create a simple drawn button UI element.
void initButton (Adafruit_GFX *gfx, int16_t x, int16_t y, uint16_t w, uint16_t h, uint16_t outline, uint16_t fill, uint16_t textcolor, char *label, uint8_t textsize)
 Initialize button with our desired color/size/settings.
void initButton (Adafruit_GFX *gfx, int16_t x, int16_t y, uint16_t w, uint16_t h, uint16_t outline, uint16_t fill, uint16_t textcolor, char *label, uint8_t textsize_x, uint8_t textsize_y)
 Initialize button with our desired color/size/settings.
void initButtonUL (Adafruit_GFX *gfx, int16_t x1, int16_t y1, uint16_t w, uint16_t h, uint16_t outline, uint16_t fill, uint16_t textcolor, char *label, uint8_t textsize)
 Initialize button with our desired color/size/settings, with upper-left coordinates.
void initButtonUL (Adafruit_GFX *gfx, int16_t x1, int16_t y1, uint16_t w, uint16_t h, uint16_t outline, uint16_t fill, uint16_t textcolor, char *label, uint8_t textsize_x, uint8_t textsize_y)
 Initialize button with our desired color/size/settings, with upper-left coordinates.
void drawButton (bool inverted=false)
 Draw the button on the screen.
bool contains (int16_t x, int16_t y)
 Helper to let us know if a coordinate is within the bounds of the button.
void press (bool p)
 Sets button state, should be done by some touch function.
bool justPressed ()
 Query whether the button was pressed since we last checked state.
bool justReleased ()
 Query whether the button was released since we last checked state.
bool isPressed (void)
 Query whether the button is currently pressed.

Detailed Description

A simple drawn button UI element.

Definition at line 249 of file Adafruit_GFX.h.


Constructor & Destructor Documentation

Adafruit_GFX_Button ( void   )

Create a simple drawn button UI element.

Definition at line 1554 of file Adafruit_GFX.cpp.


Member Function Documentation

bool contains ( int16_t  x,
int16_t  y 
)

Helper to let us know if a coordinate is within the bounds of the button.

Parameters:
xThe X coordinate to check
yThe Y coordinate to check
Returns:
True if within button graphics outline

Definition at line 1708 of file Adafruit_GFX.cpp.

void drawButton ( bool  inverted = false )

Draw the button on the screen.

Parameters:
invertedWhether to draw with fill/text swapped to indicate 'pressed'

Definition at line 1675 of file Adafruit_GFX.cpp.

void initButton ( Adafruit_GFX gfx,
int16_t  x,
int16_t  y,
uint16_t  w,
uint16_t  h,
uint16_t  outline,
uint16_t  fill,
uint16_t  textcolor,
char *  label,
uint8_t  textsize 
)

Initialize button with our desired color/size/settings.

Parameters:
gfxPointer to our display so we can draw to it!
xThe X coordinate of the center of the button
yThe Y coordinate of the center of the button
wWidth of the buttton
hHeight of the buttton
outlineColor of the outline (16-bit 5-6-5 standard)
fillColor of the button fill (16-bit 5-6-5 standard)
textcolorColor of the button label (16-bit 5-6-5 standard)
labelAscii string of the text inside the button
textsizeThe font magnification of the label text

Definition at line 1572 of file Adafruit_GFX.cpp.

void initButton ( Adafruit_GFX gfx,
int16_t  x,
int16_t  y,
uint16_t  w,
uint16_t  h,
uint16_t  outline,
uint16_t  fill,
uint16_t  textcolor,
char *  label,
uint8_t  textsize_x,
uint8_t  textsize_y 
)

Initialize button with our desired color/size/settings.

Parameters:
gfxPointer to our display so we can draw to it!
xThe X coordinate of the center of the button
yThe Y coordinate of the center of the button
wWidth of the buttton
hHeight of the buttton
outlineColor of the outline (16-bit 5-6-5 standard)
fillColor of the button fill (16-bit 5-6-5 standard)
textcolorColor of the button label (16-bit 5-6-5 standard)
labelAscii string of the text inside the button
textsize_xThe font magnification in X-axis of the label text
textsize_yThe font magnification in Y-axis of the label text

Definition at line 1598 of file Adafruit_GFX.cpp.

void initButtonUL ( Adafruit_GFX gfx,
int16_t  x1,
int16_t  y1,
uint16_t  w,
uint16_t  h,
uint16_t  outline,
uint16_t  fill,
uint16_t  textcolor,
char *  label,
uint8_t  textsize_x,
uint8_t  textsize_y 
)

Initialize button with our desired color/size/settings, with upper-left coordinates.

Parameters:
gfxPointer to our display so we can draw to it!
x1The X coordinate of the Upper-Left corner of the button
y1The Y coordinate of the Upper-Left corner of the button
wWidth of the buttton
hHeight of the buttton
outlineColor of the outline (16-bit 5-6-5 standard)
fillColor of the button fill (16-bit 5-6-5 standard)
textcolorColor of the button label (16-bit 5-6-5 standard)
labelAscii string of the text inside the button
textsize_xThe font magnification in X-axis of the label text
textsize_yThe font magnification in Y-axis of the label text

Definition at line 1650 of file Adafruit_GFX.cpp.

void initButtonUL ( Adafruit_GFX gfx,
int16_t  x1,
int16_t  y1,
uint16_t  w,
uint16_t  h,
uint16_t  outline,
uint16_t  fill,
uint16_t  textcolor,
char *  label,
uint8_t  textsize 
)

Initialize button with our desired color/size/settings, with upper-left coordinates.

Parameters:
gfxPointer to our display so we can draw to it!
x1The X coordinate of the Upper-Left corner of the button
y1The Y coordinate of the Upper-Left corner of the button
wWidth of the buttton
hHeight of the buttton
outlineColor of the outline (16-bit 5-6-5 standard)
fillColor of the button fill (16-bit 5-6-5 standard)
textcolorColor of the button label (16-bit 5-6-5 standard)
labelAscii string of the text inside the button
textsizeThe font magnification of the label text

Definition at line 1624 of file Adafruit_GFX.cpp.

bool isPressed ( void   )

Query whether the button is currently pressed.

Returns:
True if pressed

Definition at line 292 of file Adafruit_GFX.h.

bool justPressed (  )

Query whether the button was pressed since we last checked state.

Returns:
True if was not-pressed before, now is.

Definition at line 1719 of file Adafruit_GFX.cpp.

bool justReleased (  )

Query whether the button was released since we last checked state.

Returns:
True if was pressed before, now is not.

Definition at line 1727 of file Adafruit_GFX.cpp.

void press ( bool  p )

Sets button state, should be done by some touch function.

Parameters:
pTrue for pressed, false for not.

Definition at line 278 of file Adafruit_GFX.h.