Text label. More...
#include <Label.hpp>
Public Member Functions | |
virtual | ~Label (void) |
Destructor. More... | |
Label (void) | |
Constructor. Creates a button with a blank label. More... | |
Label (const std::string &new_text) | |
Constructor. More... | |
virtual | operator GtkLabel * (void) const |
Convert an instance of Label to GtkLabel* . More... | |
std::string | text (void) const |
Get the text label. More... | |
Label & | text (const std::string &new_text) |
Set the text label. More... | |
bool | line_wrap (void) const |
Get the line wrap setting. More... | |
Label & | line_wrap (const bool toggle) |
Set line wrap. More... | |
virtual | operator GtkWidget * (void) const |
Convert an instance of GUIComponent to GtkWidget* . More... | |
virtual GUIComponent & | move_to (const Point &p) |
Move to the specified coordinates. More... | |
virtual Size | natural_size (void) |
Get the natural size of a widget. More... | |
virtual Size | minimum_size (void) |
Get the minimum size of a widget. More... | |
virtual GUIComponent & | minimum_size (const Size &s) |
Set the minimum size of a widget. More... | |
virtual GUIComponent & | minimum_size (const int width, const int height) |
Set the minimum size of a widget. More... | |
virtual GUIComponent & | show (const bool toggle=true) |
Make the immediate component visible. More... | |
virtual GUIComponent & | show_all (const bool toggle=true) |
Make the component and all child components visible. More... | |
virtual GUIComponent & | hide (void) |
Hide a single component. More... | |
virtual bool | is_visible (void) const |
Determine if the widget is shown. More... | |
Static Public Member Functions | |
static WidgetToGUIComponentMap & | widget_to_gui_component_map (void) |
There are times when we have a pointer to a Gtk+ widget, and we need to map it back to the corresponding NOCL GUI component. More... | |
Public Attributes | |
Container * | parent |
Pointer to the parent to which we've been added. Will be nullptr if this object hasn't been added to a parent container. More... | |
GtkWidget * | gtk_widget |
Pointer to the underlying GTK framework. More... | |
Text label.
This corresponds to GtkLabel
.
Example:
|
virtual |
Destructor.
nocl::Label::Label | ( | void | ) |
Constructor. Creates a button with a blank label.
nocl::Label::Label | ( | const std::string & | new_text | ) |
Constructor.
nocl::Exception | Throws if GTK+ fails to create a new label. |
References nocl::GUIComponent::gtk_widget, and NOCL_WHERE.
|
virtual |
Convert an instance of Label to GtkLabel*
.
nocl::Exception | Object was not created correctly and cannot be converted to GtkLabel*. |
References nocl::GUIComponent::gtk_widget, and NOCL_WHERE.
std::string nocl::Label::text | ( | void | ) | const |
Get the text label.
nocl::Label & nocl::Label::text | ( | const std::string & | new_text | ) |
Set the text label.
bool nocl::Label::line_wrap | ( | void | ) | const |
Get the line wrap setting.
nocl::Label & nocl::Label::line_wrap | ( | const bool | toggle | ) |
Set line wrap.
|
virtualinherited |
Convert an instance of GUIComponent to GtkWidget*
.
References nocl::GUIComponent::gtk_widget.
|
virtualinherited |
Move to the specified coordinates.
|
virtualinherited |
Get the natural size of a widget.
References nocl::GUIComponent::minimum_size().
Referenced by nocl::GUIComponent::minimum_size().
|
virtualinherited |
Get the minimum size of a widget.
References nocl::GUIComponent::natural_size().
Referenced by nocl::GUIComponent::minimum_size(), and nocl::GUIComponent::natural_size().
|
virtualinherited |
Set the minimum size of a widget.
References nocl::Size::height, nocl::GUIComponent::minimum_size(), and nocl::Size::width.
|
virtualinherited |
Set the minimum size of a widget.
|
virtualinherited |
Make the immediate component visible.
[in] | toggle | Set to true to show the widget, or to false to hide the widget. |
References nocl::GUIComponent::gtk_widget, and nocl::GUIComponent::hide().
|
virtualinherited |
Make the component and all child components visible.
[in] | toggle | Set to true to show the widget and all children, or to false to hide the widget. |
References nocl::GUIComponent::gtk_widget, and nocl::GUIComponent::hide().
|
virtualinherited |
Hide a single component.
References nocl::GUIComponent::gtk_widget.
Referenced by nocl::GUIComponent::show(), and nocl::GUIComponent::show_all().
|
virtualinherited |
Determine if the widget is shown.
References nocl::GUIComponent::gtk_widget.
|
staticinherited |
There are times when we have a pointer to a Gtk+ widget, and we need to map it back to the corresponding NOCL GUI component.
For example, during event handling, Gtk+ tells us which Gtk+ widget generated the event, but we need the corresponding NOCL object so we can call the event handler with a reference to the correct object.
Referenced by nocl::ButtonHandler::handle_button_events_for(), and nocl::GUIComponent::~GUIComponent().
|
inherited |
Pointer to the parent to which we've been added. Will be nullptr
if this object hasn't been added to a parent container.
Referenced by nocl::Container::add_child(), nocl::Grid::add_child(), nocl::Container::remove_child(), and nocl::GUIComponent::~GUIComponent().
|
inherited |
Pointer to the underlying GTK framework.
Referenced by nocl::Box::Box(), nocl::ButtonBox::ButtonBox(), nocl::Grid::Grid(), nocl::ButtonHandler::handle_button_events_for(), nocl::GUIComponent::hide(), nocl::FrameWindow::initialize(), nocl::Window::is_resizable(), nocl::GUIComponent::is_visible(), Label(), nocl::FrameWindow::operator GtkApplicationWindow *(), nocl::Box::operator GtkBox *(), nocl::Button::operator GtkButton *(), nocl::ButtonBox::operator GtkButtonBox *(), nocl::Container::operator GtkContainer *(), nocl::TextField::operator GtkEntry *(), nocl::Fixed::operator GtkFixed *(), nocl::Grid::operator GtkGrid *(), operator GtkLabel *(), nocl::Layout::operator GtkLayout *(), nocl::SpinButton::operator GtkSpinButton *(), nocl::ToggleSwitch::operator GtkSwitch *(), nocl::TextEditor::operator GtkTextView *(), nocl::GUIComponent::operator GtkWidget *(), nocl::Window::operator GtkWindow *(), nocl::Window::resizable(), nocl::GUIComponent::show(), nocl::GUIComponent::show_all(), nocl::SpinButton::SpinButton(), nocl::TextButton::TextButton(), nocl::TextEditor::TextEditor(), nocl::TextField::TextField(), nocl::ToggleSwitch::ToggleSwitch(), and nocl::GUIComponent::~GUIComponent().