lecui/html/label_8h_source.html

//

// label.h - label widget interface

//

// lecui user interface library, part of the liblec library

// Copyright (c) 2019 Alec Musasa (alecmus at live dot com)

//

// Released under the MIT license. For full details see the

// file LICENSE.txt

//


#pragma once


#if defined(LECUI_EXPORTS)

#include "widget.h"

#else

#include <liblec/lecui/widgets/widget.h>

#endif


namespace liblec {

    namespace lecui {

        namespace widgets {

            // This widget supports two kinds of formatting:

            //

            // 1. HTML formatting with CSS style tags

            //

            // e.g. "<html>This is <span style='font-size: 16.5pt; font-style: italic; color: 0x0000FFFF;'>good</span>.</html>";

            //

            // The supported tags are as follows:

            //

            // strong           Bold text

            // em               Italic text

            // u                Underline text

            // s                Strikethrough text

            // span         Use CSS style tags

            //

            // The span tag supports the style attribute and the following properties:

            //

            // font-family      The font name

            // font-size        The font size, either in pt or in px

            // font-weight      The font weight, either 'none' or 'bold'

            // font-style       The font style, either 'none' or 'italic'

            // text-decoration  The text decoration, either 'none' or 'underline' or 'line-through'

            // color            The text color, either in the form rgb(255, 0, 0) or 0xFF0000FF or #FF0000FF

            //

            // Note: the strong, em and u html tags are automatically converted to CSS style tags internally.

            //

            // 2. Custom formatting

            //

            // Start and end of XML formatting is marked by the 'text' tag: <text></text>

            //

            // The supported attributes of the text are:

            //

            // font         The font name

            // size         The font size, in points

            // bold         'true' or 'false'

            // italic           'true' or 'false'

            // underline        'true' or 'false'

            // strikethrough    'true' or 'false'

            // color            0xAABBCCDD where r = AA, g = BB, b=CC, a=DD

            //

            // e.g. "This is <text size='16.5' italic='true' color='0x0000FFFF'>good</text>.";

            //

            // Both of the above two methods of formatting will display a label with the sentence:

            //

            // This is good.

            //

            // The word 'good' will be of size 16.5, italic and blue, while the rest

            // of the text will use the widget specifications.

            //


            class lecui_api label : public widget {

                color _color_hot_pressed;

                bool _multiline = false;

                text_alignment _alignment = text_alignment::left;

                paragraph_alignment _paragraph_alignment = paragraph_alignment::top;


            public:

                label() {

                    _rect.size({ 200.f, 20.f });

                };


                bool operator==(const label& param);


                bool operator!=(const label& param);


                // generic widget


                std::string& text() override;


                label& text(const std::string& text);


                std::string& tooltip() override;


                label& tooltip(const std::string& tooltip);


                lecui::rect& rect() override;


                label& rect(const lecui::rect& rect);


                resize_params& on_resize() override;


                label& on_resize(const resize_params& on_resize);


                cursor_type& cursor() override;


                label& cursor(const cursor_type cursor);


                std::string& font() override;


                label& font(const std::string& font);


                float& font_size() override;


                label& font_size(const float& font_size);


                color& color_text() override;


                label& color_text(const color& color_text);


                color& color_fill() override;


                label& color_fill(const color& color_fill);


                color& color_hot() override;


                label& color_hot(const color& color_hot);


                color& color_selected() override;


                label& color_selected(const color& color_selected);


                color& color_disabled() override;


                label& color_disabled(const color& color_disabled);


                // widget specific widget


                color& color_hot_pressed();


                label& color_hot_pressed(const color& color_hot_pressed);


                bool& multiline();


                label& multiline(const bool& multiline);


                text_alignment& alignment();


                label& alignment(const text_alignment& alignment);


                lecui::paragraph_alignment& paragraph_alignment();


                label& paragraph_alignment(const lecui::paragraph_alignment& paragraph_alignment);


            public:

                [[nodiscard]]

                static label& add(containers::page& page, const std::string& alias = std::string());


                [[nodiscard]]

                static label& get(form& fm, const std::string& path);

            };

        }

    }

}


#if defined(lecui_helper)

#define get_label(path) liblec::lecui::widgets::label::get(*this, path)

#endif

liblec::lecui::color
RGBA color on a standard 0 to 255 scale. For the alpha channel 0 is transparent and 255 is opaque.
Definition: lecui.h:583

liblec::lecui::containers::page
Page container.
Definition: page.h:32

liblec::lecui::form
Form base class. The user must inherit from this class and call one of the two constructors from its ...
Definition: form.h:122

liblec::lecui::rect
Rectangle class.
Definition: lecui.h:158

liblec::lecui::resize_params
Resize parameters.
Definition: lecui.h:363

liblec::lecui::widgets::label
Label widget. To instantiate and add to a container use the add static method.
Definition: label.h:73

liblec::lecui::widgets::label::cursor
cursor_type & cursor() override
Get or set the mouse cursor to use then over the widget.

liblec::lecui::widgets::label::color_hot_pressed
label & color_hot_pressed(const color &color_hot_pressed)
Set the color used when the label is pressed and the mouse is over it.

liblec::lecui::widgets::label::add
static label & add(containers::page &page, const std::string &alias=std::string())
Add a label to a container.

liblec::lecui::widgets::label::color_disabled
color & color_disabled() override
Get or set the widget's color when it is disabled.

liblec::lecui::widgets::label::on_resize
label & on_resize(const resize_params &on_resize)
Set the behaviour of the widget when its container is resized.

liblec::lecui::widgets::label::text
std::string & text() override
Get or set the widget text.

liblec::lecui::widgets::label::paragraph_alignment
label & paragraph_alignment(const lecui::paragraph_alignment &paragraph_alignment)
Set the paragraph alignment.

liblec::lecui::widgets::label::rect
label & rect(const lecui::rect &rect)
Set the position and dimensions of the widget.

liblec::lecui::widgets::label::multiline
label & multiline(const bool &multiline)
Set the property for whether to allow multiple lines.

liblec::lecui::widgets::label::get
static label & get(form &fm, const std::string &path)
Get the specifications of a label.

liblec::lecui::widgets::label::color_hot
color & color_hot() override
Get or set the widget's color when the mouse is hovered over it.

liblec::lecui::widgets::label::font_size
label & font_size(const float &font_size)
Set the widget's font size.

liblec::lecui::widgets::label::font
label & font(const std::string &font)
Set the default widget font.

liblec::lecui::widgets::label::color_hot
label & color_hot(const color &color_hot)
Set the widget's color when the mouse is hovered over it.

liblec::lecui::widgets::label::color_hot_pressed
color & color_hot_pressed()
Get or set the color used when the label is pressed and the mouse is over it.

liblec::lecui::widgets::label::alignment
label & alignment(const text_alignment &alignment)
Set the text alignment.

liblec::lecui::widgets::label::color_text
label & color_text(const color &color_text)
Set the color of the widget's text.

liblec::lecui::widgets::label::color_fill
color & color_fill() override
Get or set the fill color of the widget.

liblec::lecui::widgets::label::paragraph_alignment
lecui::paragraph_alignment & paragraph_alignment()
Get or set the paragraph alignment.

liblec::lecui::widgets::label::operator!=
bool operator!=(const label &param)
Check whether widget specs are NOT equal. Only those properties that require the widget resources to ...

liblec::lecui::widgets::label::color_selected
label & color_selected(const color &color_selected)
Set the widget's color when selected.

liblec::lecui::widgets::label::multiline
bool & multiline()
Get or set the property for whether to allow multiple lines.

liblec::lecui::widgets::label::on_resize
resize_params & on_resize() override
Get or set the behaviour of the widget when its container is resized.

liblec::lecui::widgets::label::tooltip
label & tooltip(const std::string &tooltip)
Set the tooltip text.

liblec::lecui::widgets::label::color_text
color & color_text() override
Get or set the color of the widget's text.

liblec::lecui::widgets::label::label
label()
Constructor.
Definition: label.h:81

liblec::lecui::widgets::label::rect
lecui::rect & rect() override
Get or set the position and dimensions of the widget.

liblec::lecui::widgets::label::color_disabled
label & color_disabled(const color &color_disabled)
Set the widget's color when it is disabled.

liblec::lecui::widgets::label::alignment
text_alignment & alignment()
Get or set the text alignment.

liblec::lecui::widgets::label::cursor
label & cursor(const cursor_type cursor)
Set the mouse cursor to use when over the widget.

liblec::lecui::widgets::label::text
label & text(const std::string &text)
Set the widget's text.

liblec::lecui::widgets::label::font
std::string & font() override
Get or set the default widget font, e.g. "Georgia".

liblec::lecui::widgets::label::color_selected
color & color_selected() override
Get or set the widget's color when selected.

liblec::lecui::widgets::label::color_fill
label & color_fill(const color &color_fill)
Set the fill color of the widget.

liblec::lecui::widgets::label::font_size
float & font_size() override
Get or set the default widget font size in points, e.g. 9.0f.

liblec::lecui::widgets::label::tooltip
std::string & tooltip() override
Get or set the widget's tooltip text.

liblec::lecui::widgets::label::operator==
bool operator==(const label &param)
Check whether widget specs are equal. Only those properties that require the widget resources to be r...

liblec::lecui::widgets::widget
Base class for all widgets.
Definition: widget.h:24

liblec::lecui::widgets::widget::cursor_type
cursor_type
Mouse cursor type.
Definition: widget.h:27

liblec::lecui::text_alignment
text_alignment
Text alignment.
Definition: lecui.h:951

liblec::lecui::text_alignment::left
@ left
Align text to the left edge.

liblec::lecui::paragraph_alignment
paragraph_alignment
Paragraph alignment.
Definition: lecui.h:966

liblec::lecui::paragraph_alignment::top
@ top
Align paragraph to the top.

liblec
Top level namespace for the liblec libraries.
Definition: appearance.h:19