PNTK
Public Member Functions | Public Attributes | Friends | List of all members
pntk::gui_tool Class Reference

#include <gui_tool.h>

Inheritance diagram for pntk::gui_tool:
pntk::gui_widget pntk::gui_object

Public Member Functions

 gui_tool (int type, std::string text="", gui_image *image=nullptr, int style=GUI_STYLE_DEFAULT)
 
virtual void set_label (const std::string &text)
 
virtual std::string get_label ()
 
int get_tool_type ()
 
void set_icon (gui_image *icon)
 
gui_imageget_icon ()
 
void set (bool state)
 
bool get ()
 
- Public Member Functions inherited from pntk::gui_widget
virtual void init (bool visible=true)
 
virtual void set_configuration (gui_configuration &configuration)
 
virtual gui_configuration get_configuration ()
 
virtual void set_position (gui_point pos)
 
virtual void set_actual_position (gui_point pos)
 
gui_point get_position ()
 
gui_point get_actual_position ()
 
gui_point get_screen_position ()
 
virtual void set_size (gui_size size)
 
virtual void set_actual_size (gui_size size)
 
virtual gui_size get_size ()
 
gui_size get_actual_size ()
 
virtual gui_size get_min_size ()
 
virtual gui_size get_actual_min_size ()
 
virtual void show (bool state)
 
virtual bool is_owned ()
 
virtual void set_border (int border)
 
virtual int get_border ()
 
virtual void set_border_style (int style)
 
virtual int get_border_style ()
 
virtual void set_weight (int weight)
 
virtual int get_weight ()
 
virtual void set_alignment (int alignment)
 
virtual int get_alignment ()
 
virtual void set_style (int style)
 
virtual int get_style ()
 
virtual void set_font (gui_font *font)
 
virtual gui_fontget_font ()
 
virtual void set_system_cursor (gui_system_cursors cursor)
 
virtual gui_widgetget_parent ()
 
gui_widgetget_sibling (bool next)
 
gui_widgetget_sequential (bool next, bool wrap=false)
 
virtual void reparent (gui_widget *parent)
 
virtual bool is_container ()
 
virtual native_widget get_native_widget ()
 
virtual std::string get_self_name ()
 
virtual widget_types get_self_type ()
 
virtual void set_bg_color (gui_color color)
 
virtual void set_fg_color (gui_color color)
 
virtual gui_color get_bg_color ()
 
virtual gui_color get_fg_color ()
 
virtual void set_enabled (bool state)
 
virtual bool get_enabled ()
 
virtual bool is_visible ()
 
virtual bool is_ok ()
 
virtual void refresh (int flags=0, const gui_rect *area=nullptr)
 
gui_extra_data & get_extra_data ()
 
virtual void set_focus ()
 
virtual bool has_focus ()
 
void set_default ()
 
gui_size bound_by_requested (gui_size size)
 
void feed_mouse (int base_event, int events, bool &veto, gui_point cursor, int button)
 
virtual void set_tooltip (std::string label)
 
virtual std::string get_tooltip ()
 
virtual void __internal_set_size (gui_size size, bool propagate_to_os=true)
 
virtual void __internal_set_actual_size (gui_size size, bool propagate_to_os=true)
 
virtual void __internal_set_os_actual (gui_size size)
 
- Public Member Functions inherited from pntk::gui_object
void set_data (void *user_data)
 
void * get_data ()
 
virtual void connect (gui_event_listener *call_back, void *data=nullptr, bool managed=false)
 
virtual void disconnect (gui_event_listener *call_back, void *data=nullptr)
 
pntk::gui_listener_chain__internal_disconnect (pntk::gui_listener_chain *matching_chain)
 

Public Attributes

 GUI_DECLARE_CLASS_FUNCTIONS
 
- Public Attributes inherited from pntk::gui_widget
gui_fontfont
 
gui_system_cursors system_cursor
 
gui_size requested_size
 
gui_size extent
 
gui_extra_data extra_data
 

Friends

class gui_toolbar_native_provider
 

Additional Inherited Members

- Public Types inherited from pntk::gui_object
typedef std::map< gui_object *, gui_listener_chain * > event_map
 
- Static Public Member Functions inherited from pntk::gui_widget
static void get_widget_geometry (int alignment, gui_point base, gui_size max, gui_point &child_pos, gui_size &child_size)
 
- Static Public Attributes inherited from pntk::gui_object
static event_map windowing_events
 

Detailed Description

A generic tool to be added to toolbars.

Constructor & Destructor Documentation

◆ gui_tool()

pntk::gui_tool::gui_tool ( int  type,
std::string  text = "",
gui_image image = nullptr,
int  style = GUI_STYLE_DEFAULT 
)

Creates a new button using the (optional) given label and an (optional) given image.

Member Function Documentation

◆ get()

bool pntk::gui_tool::get ( )

Returns the check state of the radio or toggle button

◆ get_icon()

gui_image* pntk::gui_tool::get_icon ( )

Returns the text on the label of the button.

◆ get_label()

virtual std::string pntk::gui_tool::get_label ( )
virtual

Returns the text on the label of the button.

Reimplemented from pntk::gui_widget.

◆ get_tool_type()

int pntk::gui_tool::get_tool_type ( )

Returns the type of button it is.

◆ set()

void pntk::gui_tool::set ( bool  state)

Sets the check state of the radio or toggle button

◆ set_icon()

void pntk::gui_tool::set_icon ( gui_image icon)

Changes the icon of the button.

◆ set_label()

virtual void pntk::gui_tool::set_label ( const std::string &  text)
virtual

Changes the text on the label of the button.

Reimplemented from pntk::gui_widget.


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