Ewl_Label: A fully-themable text label
Detailed Description
Defines a class for a fullty-themable text label
- Remarks:
- Inherits from Ewl_Widget.
Tutorial
Data Structures | |
struct | Ewl_Label |
Inherits from Ewl_Widget class to provide a simple label. More... | |
Defines | |
#define | EWL_LABEL(label) ((Ewl_Label *)label) |
#define | EWL_LABEL_IS(w) (ewl_widget_type_is(EWL_WIDGET(w), EWL_LABEL_TYPE)) |
#define | EWL_LABEL_TYPE "label" |
Typedefs | |
typedef struct Ewl_Label | Ewl_Label |
Functions | |
int | ewl_label_init (Ewl_Label *la) |
Initializes the la widget. | |
Ewl_Widget * | ewl_label_new (void) |
Creates a new Ewl_Label widget with the text text in it. | |
const char * | ewl_label_text_get (Ewl_Label *la) |
Gets the current text set into the label. Note, this pointer will only be valid until the next time ewl_label_text_set() is called. | |
void | ewl_label_text_set (Ewl_Label *la, const char *text) |
Sets the given text into the widget la. | |
Ewl_View * | ewl_label_view_get (void) |
Creates and returns a view to be used by Ewl_Label widgets. |
Define Documentation
Typecasts a pointer to an Ewl_Label pointer
Referenced by ewl_border_label_get(), ewl_border_label_set(), ewl_button_label_get(), ewl_button_label_set(), ewl_colorpicker_init(), ewl_filelist_view_header_fetch(), ewl_icon_alt_text_get(), ewl_icon_alt_text_set(), ewl_notebook_page_tab_text_get(), ewl_notebook_page_tab_text_set(), ewl_progressbar_cb_value_changed(), ewl_progressbar_custom_label_set(), ewl_progressbar_init(), ewl_progressbar_label_hide(), ewl_progressbar_label_set(), and ewl_statusbar_push().
#define EWL_LABEL_IS | ( | w | ) | (ewl_widget_type_is(EWL_WIDGET(w), EWL_LABEL_TYPE)) |
Returns TRUE if the widget is an Ewl_Label, FALSE otherwise
#define EWL_LABEL_TYPE "label" |
- Widget Theme Keys:
- /label
Referenced by ewl_label_init(), ewl_label_text_get(), and ewl_label_text_set().
Typedef Documentation
Function Documentation
int ewl_label_init | ( | Ewl_Label * | la | ) |
Initializes the la widget.
- Parameters:
-
la,: The Ewl_Label to initialize
- Returns:
- Returns TRUE on success, FALSE on falure
References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_FLAG_ALIGN_LEFT, EWL_FLAG_FILL_NONE, EWL_LABEL_TYPE, EWL_OBJECT, ewl_object_alignment_set(), ewl_object_fill_policy_set(), EWL_WIDGET, ewl_widget_appearance_set(), ewl_widget_focusable_set(), ewl_widget_inherit(), and ewl_widget_init().
Referenced by ewl_label_new().
Ewl_Widget* ewl_label_new | ( | void | ) |
Creates a new Ewl_Label widget with the text text in it.
- Returns:
- Returns a new Ewl_Widget if successful, NULL on failure
References DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, ewl_label_init(), EWL_WIDGET, ewl_widget_destroy(), label, and NEW.
Referenced by ewl_border_init(), ewl_button_label_set(), ewl_calendar_init(), ewl_colorpicker_init(), ewl_filelist_view_header_fetch(), ewl_icon_alt_text_set(), ewl_notebook_page_tab_text_set(), ewl_progressbar_init(), and ewl_statusbar_push().
const char* ewl_label_text_get | ( | Ewl_Label * | la | ) |
Gets the current text set into the label. Note, this pointer will only be valid until the next time ewl_label_text_set() is called.
- Parameters:
-
la,: The Ewl_Label to get the text from
- Returns:
- Returns no value.
References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, EWL_LABEL_TYPE, EWL_WIDGET, and ewl_widget_appearance_text_get().
Referenced by ewl_border_label_get(), ewl_button_label_get(), ewl_icon_alt_text_get(), and ewl_notebook_page_tab_text_get().
void ewl_label_text_set | ( | Ewl_Label * | la, | |
const char * | text | |||
) |
Sets the given text into the widget la.
- Parameters:
-
la,: The Ewl_Widget to set the text on text,: The text to set into the widget
- Returns:
- Returns no value
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_LABEL_TYPE, EWL_WIDGET, and ewl_widget_appearance_text_set().
Referenced by ewl_border_label_set(), ewl_button_label_set(), ewl_colorpicker_init(), ewl_filelist_view_header_fetch(), ewl_icon_alt_text_set(), ewl_notebook_page_tab_text_set(), ewl_progressbar_cb_value_changed(), ewl_progressbar_custom_label_set(), ewl_progressbar_init(), ewl_progressbar_label_hide(), ewl_progressbar_label_set(), and ewl_statusbar_push().
Ewl_View* ewl_label_view_get | ( | void | ) |
Creates and returns a view to be used by Ewl_Label widgets.
- Returns:
- Returns a view that can be used to display Ewl_Label widgets
References DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, ewl_view_header_fetch_set(), ewl_view_new(), and ewl_view_widget_fetch_set().
Referenced by ewl_filepicker_init().