Text label. More...

#include <Label.hpp>

Inheritance diagram for nocl::Label:

Collaboration diagram for nocl::Label:

[legend]

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...

Detailed Description

Text label.

This corresponds to GtkLabel.

Example:

#include <nocl/nocl.hpp>
// This example places a single text label within a frame window.
class MyApp : public nocl::Application
{
    public:
        virtual MyApp & initialize(void) override
        {
            label.text("Hello!");
            frame_window.initialize(*this, "Example");
            frame_window.add_child(label);
            frame_window.show_all();
            return *this;
        }
        nocl::FrameWindow   frame_window;
        nocl::Label         label;
};
int main()
{
    MyApp app;
    return app.run_message_loop();
}

See also: https://developer.gnome.org/gtk3/stable/GtkLabel.html

Constructor & Destructor Documentation

◆ ~Label()

nocl::Label::~Label ( void )

virtual

Destructor.

◆ Label() [1/2]

nocl::Label::Label ( void )

Constructor. Creates a button with a blank label.

See also: text()

◆ Label() [2/2]

nocl::Label::Label ( const std::string & new_text )

Constructor.

Exceptions

nocl::Exception Throws if GTK+ fails to create a new label.

References nocl::GUIComponent::gtk_widget, and NOCL_WHERE.

Member Function Documentation

◆ operator GtkLabel *()

nocl::Label::operator GtkLabel * ( void ) const

virtual

Convert an instance of Label to GtkLabel*.

Exceptions

nocl::Exception Object was not created correctly and cannot be converted to GtkLabel*.

References nocl::GUIComponent::gtk_widget, and NOCL_WHERE.

◆ text() [1/2]

std::string nocl::Label::text ( void ) const

Get the text label.

◆ text() [2/2]

nocl::Label & nocl::Label::text ( const std::string & new_text )

Set the text label.

◆ line_wrap() [1/2]

bool nocl::Label::line_wrap ( void ) const

Get the line wrap setting.

◆ line_wrap() [2/2]

nocl::Label & nocl::Label::line_wrap ( const bool toggle )

Set line wrap.

◆ operator GtkWidget *()

nocl::GUIComponent::operator GtkWidget * ( void ) const

virtualinherited

Convert an instance of GUIComponent to GtkWidget*.

References nocl::GUIComponent::gtk_widget.

◆ move_to()

nocl::GUIComponent & nocl::GUIComponent::move_to ( const Point & p )

virtualinherited

Move to the specified coordinates.

Todo:

◆ natural_size()

nocl::Size nocl::GUIComponent::natural_size ( void )

virtualinherited

Get the natural size of a widget.

References nocl::GUIComponent::minimum_size().

Referenced by nocl::GUIComponent::minimum_size().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ minimum_size() [1/3]

nocl::Size nocl::GUIComponent::minimum_size ( void )

virtualinherited

Get the minimum size of a widget.

References nocl::GUIComponent::natural_size().

Referenced by nocl::GUIComponent::minimum_size(), and nocl::GUIComponent::natural_size().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ minimum_size() [2/3]

nocl::GUIComponent & nocl::GUIComponent::minimum_size ( const Size & s )

virtualinherited

Set the minimum size of a widget.

References nocl::Size::height, nocl::GUIComponent::minimum_size(), and nocl::Size::width.

Here is the call graph for this function:

◆ minimum_size() [3/3]

nocl::GUIComponent & nocl::GUIComponent::minimum_size	(	const int	width,
		const int	height
	)

virtualinherited

Set the minimum size of a widget.

◆ show()

nocl::GUIComponent & nocl::GUIComponent::show ( const bool toggle = true )

virtualinherited

Make the immediate component visible.

Parameters

[in] toggle Set to true to show the widget, or to false to hide the widget.

See also: hide(); show_all(); is_visible()

References nocl::GUIComponent::gtk_widget, and nocl::GUIComponent::hide().

Here is the call graph for this function:

◆ show_all()

nocl::GUIComponent & nocl::GUIComponent::show_all ( const bool toggle = true )

virtualinherited

Make the component and all child components visible.

Parameters

[in] toggle Set to true to show the widget and all children, or to false to hide the widget.

See also: show(); hide(); is_visible()

References nocl::GUIComponent::gtk_widget, and nocl::GUIComponent::hide().

Here is the call graph for this function:

◆ hide()

nocl::GUIComponent & nocl::GUIComponent::hide ( void )

virtualinherited

Hide a single component.

See also: show(); show_all(); is_visible()

References nocl::GUIComponent::gtk_widget.

Referenced by nocl::GUIComponent::show(), and nocl::GUIComponent::show_all().

Here is the caller graph for this function:

◆ is_visible()

bool nocl::GUIComponent::is_visible ( void ) const

virtualinherited

Determine if the widget is shown.

See also: show(); show_all(); hide()

References nocl::GUIComponent::gtk_widget.

◆ widget_to_gui_component_map()

nocl::WidgetToGUIComponentMap & nocl::GUIComponent::widget_to_gui_component_map ( void )

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.

Note: This is not intended for end-users to access directly!

Referenced by nocl::ButtonHandler::handle_button_events_for(), and nocl::GUIComponent::~GUIComponent().

Here is the caller graph for this function:

Member Data Documentation

◆ parent

Container* nocl::GUIComponent::parent

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().

◆ gtk_widget

GtkWidget* nocl::GUIComponent::gtk_widget

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().

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

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~Label()

◆ Label() [1/2]

◆ Label() [2/2]

Member Function Documentation

◆ operator GtkLabel *()

◆ text() [1/2]

◆ text() [2/2]

◆ line_wrap() [1/2]

◆ line_wrap() [2/2]

◆ operator GtkWidget *()

◆ move_to()

◆ natural_size()

◆ minimum_size() [1/3]

◆ minimum_size() [2/3]

◆ minimum_size() [3/3]

◆ show()

◆ show_all()

◆ hide()

◆ is_visible()

◆ widget_to_gui_component_map()

Member Data Documentation

◆ parent

◆ gtk_widget