Pebble Foundation Classes  0.2.0
C++ for Pebble
Pebble::GTextAttributes Class Reference
Collaboration diagram for Pebble::GTextAttributes:

Public Member Functions

 GTextAttributes ()
 Creates an instance of GTextAttributes for advanced control when rendering text.
 
 operator::GTextAttributes * ()
 Instances of this class can be automatically converted to Pebble GTextAttributes pointer.
 
 operator::GTextAttributes * () const
 
virtual ~GTextAttributes ()
 Destroys the underlying pebble GTextAttributes.
 
void RestoreDefaultTextFlow ()
 
void EnableScreenTextFlow (uint8_t inset)
 
void RestoreDefaultPaging ()
 
void EnablePaging (GPoint content_origin_on_screen, GRect paging_on_screen)
 

Protected Attributes

::GTextAttributestext_attributes_
 Underlying GTextAttributes.
 

Member Function Documentation

◆ EnablePaging()

void Pebble::GTextAttributes::EnablePaging ( GPoint  content_origin_on_screen,
GRect  paging_on_screen 
)
inline

Enables paging and locks the text flow calculation to a fixed point on the screen.

Parameters
content_origin_on_screenAbsolute coordinate on the screen where the text content starts before an animation or scrolling takes place. Usually the frame's origin of a layer in screen coordinates.
paging_on_screenRectangle in absolute coordinates on the screen that describes where text content pages. Usually the container's absolute frame in screen coordinates.
See also
graphics_text_attributes_restore_default_paging
graphics_text_attributes_enable_screen_text_flow
text_layer_enable_screen_text_flow_and_paging
layer_convert_point_to_screen

◆ EnableScreenTextFlow()

void Pebble::GTextAttributes::EnableScreenTextFlow ( uint8_t  inset)
inline

Enables text flow that follows the boundaries of the screen.

Parameters
insetAdditional amount of pixels to inset to the inside of the screen for text flow calculation. Can be zero.
See also
graphics_text_attributes_restore_default_text_flow
text_layer_enable_screen_text_flow_and_paging

◆ RestoreDefaultPaging()

void Pebble::GTextAttributes::RestoreDefaultPaging ( )
inline

Restores paging and locked content origin to the defaults.

See also
graphics_text_attributes_enable_paging
text_layer_restore_default_text_flow_and_paging

◆ RestoreDefaultTextFlow()

void Pebble::GTextAttributes::RestoreDefaultTextFlow ( )
inline

Restores text flow to the rectangular default.

See also
EnableScreenTextFlow
text_layer_restore_default_text_flow_and_paging

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