// Generated by gmmproc 2.66.7 -- DO NOT MODIFY! #ifndef _GTKMM_LABEL_H #define _GTKMM_LABEL_H #include #include /* Copyright (C) 1998-2002 The gtkmm Development Team * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or(at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #include #include #ifndef DOXYGEN_SHOULD_SKIP_THIS using GtkLabel = struct _GtkLabel; using GtkLabelClass = struct _GtkLabelClass; #endif /* DOXYGEN_SHOULD_SKIP_THIS */ #ifndef DOXYGEN_SHOULD_SKIP_THIS namespace Gtk { class GTKMM_API Label_Class; } // namespace Gtk #endif //DOXYGEN_SHOULD_SKIP_THIS namespace Gtk { class GTKMM_API Menu; /** A widget that displays a small to medium amount of text. * * A simple setable widget for holding a Glib::ustring. * * Key values are the codes which are sent whenever a key is pressed or released. * The complete list of key values can be found in the * gdk/gdkkeysyms.h * header file. They are prefixed with GDK_KEY_. * * The Label widget looks like this: * @image html label1.png * * @ingroup Widgets */ class GTKMM_API Label : public Misc { public: #ifndef DOXYGEN_SHOULD_SKIP_THIS typedef Label CppObjectType; typedef Label_Class CppClassType; typedef GtkLabel BaseObjectType; typedef GtkLabelClass BaseClassType; #endif /* DOXYGEN_SHOULD_SKIP_THIS */ Label(Label&& src) noexcept; Label& operator=(Label&& src) noexcept; // noncopyable Label(const Label&) = delete; Label& operator=(const Label&) = delete; ~Label() noexcept override; #ifndef DOXYGEN_SHOULD_SKIP_THIS private: friend class GTKMM_API Label_Class; static CppClassType label_class_; protected: explicit Label(const Glib::ConstructParams& construct_params); explicit Label(GtkLabel* castitem); #endif /* DOXYGEN_SHOULD_SKIP_THIS */ public: /** Get the GType for this class, for use with the underlying GObject type system. */ static GType get_type() G_GNUC_CONST; #ifndef DOXYGEN_SHOULD_SKIP_THIS static GType get_base_type() G_GNUC_CONST; #endif /// Provides access to the underlying C GObject. GtkLabel* gobj() { return reinterpret_cast(gobject_); } /// Provides access to the underlying C GObject. const GtkLabel* gobj() const { return reinterpret_cast(gobject_); } public: //C++ methods used to invoke GTK+ virtual functions: protected: //GTK+ Virtual Functions (override these to change behaviour): //Default Signal Handlers:: /// This is a default handler for the signal signal_populate_popup(). virtual void on_populate_popup(Menu* menu); private: public: Label(); explicit Label(const Glib::ustring& label, bool mnemonic = false); #ifndef GTKMM_DISABLE_DEPRECATED /** This constructor is a shortcut for often used code * when you want to create a label with alignment different * than default one. * @code * Gtk::Label label(text, x, y, mnemonic); * @endcode * is equivalent to: * @code * Gtk::Label label(text, mnemonic); * label.set_alignment(x, y); * @endcode * * @deprecated Use another constructor. */ Label(const Glib::ustring& label, float xalign, float yalign, bool mnemonic = false); #endif // GTKMM_DISABLE_DEPRECATED /** This constructor is a shortcut to create a Label with Widget * alignment properties different from the default ALIGN_FILL. * @code * Gtk::Label label(text, h, v, mnemonic); * @endcode * is equivalent to: * @code * Gtk::Label label(text, mnemonic); * label.set_halign(h); * label.set_valign(v); * @endcode */ Label(const Glib::ustring& label, Align halign, Align valign = ALIGN_CENTER, bool mnemonic = false); /** Doesn't use markup. */ void set_text(const Glib::ustring & str); /** Fetches the text from a label widget, as displayed on the * screen. This does not include any embedded underlines * indicating mnemonics or Pango markup. (See get_label()) * * @return The text in the label widget. */ Glib::ustring get_text() const; /** Sets a Pango::AttrList; the attributes in the list are applied to the * label text. * * The attributes set with this function will be applied * and merged with any other attributes previously effected by way * of the Gtk::Label::property_use_underline() or Gtk::Label::property_use_markup() properties. * While it is not recommended to mix markup strings with manually set * attributes, if you must; know that the attributes will be applied * to the label after the markup string is parsed. * * @param attrs A Pango::AttrList, or nullptr. */ void set_attributes(Pango::AttrList& attrs); /** Gets the attribute list that was set on the label using * set_attributes(), if any. This function does * not reflect attributes that come from the labels markup * (see set_markup()). If you want to get the * effective attributes for the label, use * pango_layout_get_attribute (gtk_label_get_layout (label)). * * @return The attribute list, or nullptr * if none was set. */ Pango::AttrList get_attributes() const; //TODO: Remove set_label() or set_text()? /** Sets the text of the label. The label is interpreted as * including embedded underlines and/or Pango markup depending * on the values of the Gtk::Label::property_use_underline() and * Gtk::Label::property_use_markup() properties. * * @param str The new text to set for the label. */ void set_label(const Glib::ustring& str); /** Fetches the text from a label widget including any embedded * underlines indicating mnemonics and Pango markup. (See * get_text()). * * @return The text of the label widget. */ Glib::ustring get_label() const; /** Parses @a str which is marked up with the * [Pango text markup language][PangoMarkupFormat], setting the * label’s text and attribute list based on the parse results. * * If the @a str is external data, you may need to escape it with * Glib::markup_escape_text() or Glib::markup_printf_escaped(): * * * [C example ellipted] * * This function will set the Gtk::Label::property_use_markup() property to true as * a side effect. * * If you set the label contents using the Gtk::Label::property_label() property you * should also ensure that you set the Gtk::Label::property_use_markup() property * accordingly. * * See also: set_text() * * @param str A markup string (see [Pango markup format][PangoMarkupFormat]). */ void set_markup(const Glib::ustring& str); /** Sets whether the text of the label contains markup in * [Pango’s text markup language][PangoMarkupFormat]. * See set_markup(). * * @param setting true if the label’s text should be parsed for markup. */ void set_use_markup(bool setting = true); /** Returns whether the label’s text is interpreted as marked up with * the [Pango text markup language][PangoMarkupFormat]. * See set_use_markup(). * * @return true if the label’s text will be parsed for markup. */ bool get_use_markup() const; /** If true, an underline in the text indicates the next character should be * used for the mnemonic accelerator key. * * @param setting true if underlines in the text indicate mnemonics. */ void set_use_underline(bool setting = true); /** Returns whether an embedded underline in the label indicates a * mnemonic. See set_use_underline(). * * @return true whether an embedded underline in the label indicates * the mnemonic accelerator keys. */ bool get_use_underline() const; /** Parses @a str which is marked up with the * [Pango text markup language][PangoMarkupFormat], * setting the label’s text and attribute list based on the parse results. * If characters in @a str are preceded by an underscore, they are underlined * indicating that they represent a keyboard accelerator called a mnemonic. * * The mnemonic key can be used to activate another widget, chosen * automatically, or explicitly using set_mnemonic_widget(). * * @param str A markup string (see * [Pango markup format][PangoMarkupFormat]). */ void set_markup_with_mnemonic(const Glib::ustring& str); /** If the label has been set so that it has an mnemonic key this function * returns the keyval used for the mnemonic accelerator. If there is no * mnemonic set up it returns #GDK_KEY_VoidSymbol. * * @return GDK keyval usable for accelerators, or #GDK_KEY_VoidSymbol. */ guint get_mnemonic_keyval() const; /** If the label has been set so that it has an mnemonic key (using * i.e.\ set_markup_with_mnemonic(), * set_text_with_mnemonic(), new_with_mnemonic() * or the “use_underline” property) the label can be associated with a * widget that is the target of the mnemonic. When the label is inside * a widget (like a Gtk::Button or a Gtk::Notebook tab) it is * automatically associated with the correct widget, but sometimes * (i.e. when the target is a Gtk::Entry next to the label) you need to * set it explicitly using this function. * * The target widget will be accelerated by emitting the * GtkWidget::mnemonic-activate signal on it. The default handler for * this signal will activate the widget if there are no mnemonic collisions * and toggle focus between the colliding widgets otherwise. * * @param widget The target Gtk::Widget, or nullptr to unset. */ void set_mnemonic_widget(Widget& widget); /** Retrieves the target of the mnemonic (keyboard shortcut) of this * label. See set_mnemonic_widget(). * * @return The target of the label’s mnemonic, * or nullptr if none has been set and the default algorithm will be used. */ Widget* get_mnemonic_widget(); /** Retrieves the target of the mnemonic (keyboard shortcut) of this * label. See set_mnemonic_widget(). * * @return The target of the label’s mnemonic, * or nullptr if none has been set and the default algorithm will be used. */ const Widget* get_mnemonic_widget() const; /** Sets the label’s text from the string @a str. * If characters in @a str are preceded by an underscore, they are underlined * indicating that they represent a keyboard accelerator called a mnemonic. * The mnemonic key can be used to activate another widget, chosen * automatically, or explicitly using set_mnemonic_widget(). * * @param str A string. */ void set_text_with_mnemonic(const Glib::ustring& str); /** Sets the alignment of the lines in the text of the label relative to * each other. Gtk::JUSTIFY_LEFT is the default value when the widget is * first created with new(). If you instead want to set the * alignment of the label as a whole, use Gtk::Widget::set_halign() instead. * set_justify() has no effect on labels containing only a * single line. * * @param jtype A Gtk::Justification. */ void set_justify(Justification jtype); /** Returns the justification of the label. See set_justify(). * * @return Gtk::Justification. */ Justification get_justify() const; /** Sets the mode used to ellipsize (add an ellipsis: "...") to the text * if there is not enough space to render the entire string. * * @newin{2,6} * * @param mode A Pango::EllipsizeMode. */ void set_ellipsize(Pango::EllipsizeMode mode); /** Returns the ellipsizing position of the label. See set_ellipsize(). * * @newin{2,6} * * @return Pango::EllipsizeMode. */ Pango::EllipsizeMode get_ellipsize() const; /** Sets the desired width in characters of @a label to @a n_chars. * * @newin{2,6} * * @param n_chars The new desired width, in characters. */ void set_width_chars(int n_chars); /** Retrieves the desired width of @a label, in characters. See * set_width_chars(). * * @newin{2,6} * * @return The width of the label in characters. */ int get_width_chars() const; /** Sets the desired maximum width in characters of @a label to @a n_chars. * * @newin{2,6} * * @param n_chars The new desired maximum width, in characters. */ void set_max_width_chars(int n_chars); /** Retrieves the desired maximum width of @a label, in characters. See * set_width_chars(). * * @newin{2,6} * * @return The maximum width of the label in characters. */ int get_max_width_chars() const; /** Sets the number of lines to which an ellipsized, wrapping label * should be limited. This has no effect if the label is not wrapping * or ellipsized. Set this to -1 if you don’t want to limit the * number of lines. * * @newin{3,10} * * @param lines The desired number of lines, or -1. */ void set_lines(int lines); /** Gets the number of lines to which an ellipsized, wrapping * label should be limited. See set_lines(). * * @newin{3,10} * * @return The number of lines. */ int get_lines() const; /** The pattern of underlines you want under the existing text within the * Gtk::Label widget. For example if the current text of the label says * “FooBarBaz” passing a pattern of “___ ___” will underline * “Foo” and “Baz” but not “Bar”. * * @param pattern The pattern as described above. */ void set_pattern(const Glib::ustring& pattern); /** Toggles line wrapping within the Gtk::Label widget. true makes it break * lines if text exceeds the widget’s size. false lets the text get cut off * by the edge of the widget if it exceeds the widget size. * * Note that setting line wrapping to true does not make the label * wrap at its parent container’s width, because GTK+ widgets * conceptually can’t make their requisition depend on the parent * container’s size. For a label that wraps at a specific position, * set the label’s width using Gtk::Widget::set_size_request(). * * @param wrap The setting. */ void set_line_wrap(bool wrap = true); /** Returns whether lines in the label are automatically wrapped. * See set_line_wrap(). * * @return true if the lines of the label are automatically wrapped. */ bool get_line_wrap() const; /** If line wrapping is on (see set_line_wrap()) this controls how * the line wrapping is done. The default is Pango::WRAP_WORD which means * wrap on word boundaries. * * @newin{2,10} * * @param wrap_mode The line wrapping mode. */ void set_line_wrap_mode(Pango::WrapMode wrap_mode); /** Returns line wrap mode used by the label. See set_line_wrap_mode(). * * @newin{2,10} * * @return true if the lines of the label are automatically wrapped. */ Pango::WrapMode get_line_wrap_mode() const; /** Selectable labels allow the user to select text from the label, for * copy-and-paste. * * @param setting true to allow selecting text in the label. */ void set_selectable(bool setting = true); /** Gets the value set by set_selectable(). * * @return true if the user can copy text from the label. */ bool get_selectable() const; /** Sets the angle of rotation for the label. An angle of 90 reads from * from bottom to top, an angle of 270, from top to bottom. The angle * setting for the label is ignored if the label is selectable, * wrapped, or ellipsized. * * @newin{2,6} * * @param angle The angle that the baseline of the label makes with * the horizontal, in degrees, measured counterclockwise. */ void set_angle(double angle); /** Gets the angle of rotation for the label. See * set_angle(). * * @newin{2,6} * * @return The angle of rotation for the label. */ double get_angle() const; /** Selects a range of characters in the label, if the label is selectable. * See set_selectable(). If the label is not selectable, * this function has no effect. If @a start_offset or * @a end_offset are -1, then the end of the label will be substituted. * * @param start_offset Start offset (in characters not bytes). * @param end_offset End offset (in characters not bytes). */ void select_region(int start_offset, int end_offset); /** Selects a range of characters in the label, from @a start_offset to the end, * if the label is selectable. * See gtk_label_set_selectable(). If the label is not selectable, * this function has no effect. * * @param start_offset Start offset (in characters not bytes) */ void select_region(int start_offset); /** Gets the selected range of characters in the label, returning true * if there’s a selection. * * @param start Return location for start of selection, as a character offset. * @param end Return location for end of selection, as a character offset. * @return true if selection is non-empty. */ bool get_selection_bounds(int& start, int& end) const; /** Gets the Pango::Layout used to display the label. * The layout is useful to e.g. convert text positions to * pixel positions, in combination with get_layout_offsets(). * * @return The Pango::Layout for this label. */ Glib::RefPtr get_layout(); /** Gets the Pango::Layout used to display the label. * The layout is useful to e.g. convert text positions to * pixel positions, in combination with get_layout_offsets(). * * @return The Pango::Layout for this label. */ Glib::RefPtr get_layout() const; /** Obtains the coordinates where the label will draw the Pango::Layout * representing the text in the label; useful to convert mouse events * into coordinates inside the Pango::Layout, e.g.\ to take some action * if some part of the label is clicked. Of course you will need to * create a Gtk::EventBox to receive the events, and pack the label * inside it, since labels are windowless (they return false from * Gtk::Widget::get_has_window()). Remember * when using the Pango::Layout functions you need to convert to * and from pixels using PANGO_PIXELS() or Pango::SCALE. * * @param x Location to store X offset of layout, or nullptr. * @param y Location to store Y offset of layout, or nullptr. */ void get_layout_offsets(int& x, int& y) const; /** Sets whether the label is in single line mode. * * @newin{2,6} * * @param single_line_mode true if the label should be in single line mode. */ void set_single_line_mode(bool single_line_mode = true); /** Returns whether the label is in single line mode. * * @newin{2,6} * * @return true when the label is in single line mode. */ bool get_single_line_mode() const; /** Returns the URI for the currently active link in the label. * The active link is the one under the mouse pointer or, in a * selectable label, the link in which the text cursor is currently * positioned. * * This function is intended for use in a Gtk::Label::signal_activate_link() handler * or for use in a Gtk::Widget::signal_query_tooltip() handler. * * @newin{2,18} * * @return The currently active URI. The string is owned by GTK+ and must * not be freed or modified. */ Glib::ustring get_current_uri() const; /** Sets whether the label should keep track of clicked * links (and use a different color for them). * * @newin{2,18} * * @param track_links true to track visited links. */ void set_track_visited_links(bool track_links = true); /** Returns whether the label is currently keeping track * of clicked links. * * @newin{2,18} * * @return true if clicked links are remembered. */ bool get_track_visited_links() const; /** Sets the Gtk::Label::property_xalign() property for @a label. * * @newin{3,16} * * @param xalign The new xalign value, between 0 and 1. */ void set_xalign(float xalign); /** Gets the Gtk::Label::property_xalign() property for @a label. * * @newin{3,16} * * @return The xalign property. */ float get_xalign() const; /** Sets the Gtk::Label::property_yalign() property for @a label. * * @newin{3,16} * * @param yalign The new yalign value, between 0 and 1. */ void set_yalign(float yalign); /** Gets the Gtk::Label::property_yalign() property for @a label. * * @newin{3,16} * * @return The yalign property. */ float get_yalign() const; /** * @par Slot Prototype: * void on_my_%populate_popup(Menu* menu) * * Flags: Run Last * * The signal_populate_popup() signal gets emitted before showing the * context menu of the label. Note that only selectable labels * have context menus. * * If you need to add items to the context menu, connect * to this signal and append your menuitems to the @a menu. * * @param menu The menu that is being populated. */ Glib::SignalProxy< void,Menu* > signal_populate_popup(); /** * @par Slot Prototype: * bool on_my_%activate_link(const Glib::ustring& uri) * * Flags: Run Last * * The signal which gets emitted to activate a URI. * Applications may connect to it to override the default behaviour, * which is to call gtk_show_uri_on_window(). * * @newin{2,18} * * @param uri The URI that is activated. * @return true if the link has been activated. */ Glib::SignalProxy< bool,const Glib::ustring& > signal_activate_link(); //Keybinding signals: /** The contents of the label. * * If the string contains [Pango XML markup][PangoMarkupFormat], you will * have to set the Gtk::Label::property_use_markup() property to true in order for the * label to display the markup attributes. See also Gtk::Label::set_markup() * for a convenience function that sets both this property and the * Gtk::Label::property_use_markup() property at the same time. * * If the string contains underlines acting as mnemonics, you will have to * set the Gtk::Label::property_use_underline() property to true in order for the label * to display them. * * Default value: "" * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Glib::ustring > property_label() ; /** The contents of the label. * * If the string contains [Pango XML markup][PangoMarkupFormat], you will * have to set the Gtk::Label::property_use_markup() property to true in order for the * label to display the markup attributes. See also Gtk::Label::set_markup() * for a convenience function that sets both this property and the * Gtk::Label::property_use_markup() property at the same time. * * If the string contains underlines acting as mnemonics, you will have to * set the Gtk::Label::property_use_underline() property to true in order for the label * to display them. * * Default value: "" * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Glib::ustring > property_label() const; /** A list of style attributes to apply to the text of the label. * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Pango::AttrList > property_attributes() ; /** A list of style attributes to apply to the text of the label. * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Pango::AttrList > property_attributes() const; /** The text of the label includes XML markup. See pango_parse_markup(). * * Default value: false * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_use_markup() ; /** The text of the label includes XML markup. See pango_parse_markup(). * * Default value: false * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_use_markup() const; /** If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key. * * Default value: false * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_use_underline() ; /** If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key. * * Default value: false * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_use_underline() const; /** The alignment of the lines in the text of the label relative to each other. This does NOT affect the alignment of the label within its allocation. See GtkLabel:xalign for that. * * Default value: Gtk::JUSTIFY_LEFT * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Justification > property_justify() ; /** The alignment of the lines in the text of the label relative to each other. This does NOT affect the alignment of the label within its allocation. See GtkLabel:xalign for that. * * Default value: Gtk::JUSTIFY_LEFT * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Justification > property_justify() const; /** A string with _ characters in positions correspond to characters in the text to underline. * * Default value: "" * * @return A PropertyProxy_WriteOnly that allows you to set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_WriteOnly< Glib::ustring > property_pattern() ; /** If set, wrap lines if the text becomes too wide. * * Default value: false * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_wrap() ; /** If set, wrap lines if the text becomes too wide. * * Default value: false * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_wrap() const; /** If line wrapping is on (see the Gtk::Label::property_wrap() property) this controls * how the line wrapping is done. The default is Pango::WRAP_WORD, which * means wrap on word boundaries. * * @newin{2,10} * * Default value: Pango::WRAP_WORD * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Pango::WrapMode > property_wrap_mode() ; /** If line wrapping is on (see the Gtk::Label::property_wrap() property) this controls * how the line wrapping is done. The default is Pango::WRAP_WORD, which * means wrap on word boundaries. * * @newin{2,10} * * Default value: Pango::WRAP_WORD * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Pango::WrapMode > property_wrap_mode() const; /** Whether the label text can be selected with the mouse. * * Default value: false * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_selectable() ; /** Whether the label text can be selected with the mouse. * * Default value: false * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_selectable() const; /** The mnemonic accelerator key for this label. * * Default value: 16777215 * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< guint > property_mnemonic_keyval() const; /** The widget to be activated when the label's mnemonic key is pressed. * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Widget* > property_mnemonic_widget() ; /** The widget to be activated when the label's mnemonic key is pressed. * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Widget* > property_mnemonic_widget() const; /** The current position of the insertion cursor in chars. * * Default value: 0 * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< int > property_cursor_position() const; /** The position of the opposite end of the selection from the cursor in chars. * * Default value: 0 * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< int > property_selection_bound() const; /** The preferred place to ellipsize the string, if the label does * not have enough room to display the entire string, specified as a * Pango::EllipsizeMode. * * Note that setting this property to a value other than * Pango::ELLIPSIZE_NONE has the side-effect that the label requests * only enough space to display the ellipsis "...". In particular, this * means that ellipsizing labels do not work well in notebook tabs, unless * the Gtk::Notebook tab-expand child property is set to true. Other ways * to set a label's width are Gtk::Widget::set_size_request() and * Gtk::Label::set_width_chars(). * * @newin{2,6} * * Default value: Pango::ELLIPSIZE_NONE * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Pango::EllipsizeMode > property_ellipsize() ; /** The preferred place to ellipsize the string, if the label does * not have enough room to display the entire string, specified as a * Pango::EllipsizeMode. * * Note that setting this property to a value other than * Pango::ELLIPSIZE_NONE has the side-effect that the label requests * only enough space to display the ellipsis "...". In particular, this * means that ellipsizing labels do not work well in notebook tabs, unless * the Gtk::Notebook tab-expand child property is set to true. Other ways * to set a label's width are Gtk::Widget::set_size_request() and * Gtk::Label::set_width_chars(). * * @newin{2,6} * * Default value: Pango::ELLIPSIZE_NONE * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Pango::EllipsizeMode > property_ellipsize() const; /** The desired width of the label, in characters. If this property is set to * -1, the width will be calculated automatically. * * See the section on [text layout][label-text-layout] * for details of how Gtk::Label::property_width_chars() and Gtk::Label::property_max_width_chars() * determine the width of ellipsized and wrapped labels. * * @newin{2,6} * * Default value: -1 * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< int > property_width_chars() ; /** The desired width of the label, in characters. If this property is set to * -1, the width will be calculated automatically. * * See the section on [text layout][label-text-layout] * for details of how Gtk::Label::property_width_chars() and Gtk::Label::property_max_width_chars() * determine the width of ellipsized and wrapped labels. * * @newin{2,6} * * Default value: -1 * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< int > property_width_chars() const; /** Whether the label is in single line mode. In single line mode, * the height of the label does not depend on the actual text, it * is always set to ascent + descent of the font. This can be an * advantage in situations where resizing the label because of text * changes would be distracting, e.g. in a statusbar. * * @newin{2,6} * * Default value: false * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_single_line_mode() ; /** Whether the label is in single line mode. In single line mode, * the height of the label does not depend on the actual text, it * is always set to ascent + descent of the font. This can be an * advantage in situations where resizing the label because of text * changes would be distracting, e.g. in a statusbar. * * @newin{2,6} * * Default value: false * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_single_line_mode() const; /** The angle that the baseline of the label makes with the horizontal, * in degrees, measured counterclockwise. An angle of 90 reads from * from bottom to top, an angle of 270, from top to bottom. Ignored * if the label is selectable. * * @newin{2,6} * * Default value: 0 * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< double > property_angle() ; /** The angle that the baseline of the label makes with the horizontal, * in degrees, measured counterclockwise. An angle of 90 reads from * from bottom to top, an angle of 270, from top to bottom. Ignored * if the label is selectable. * * @newin{2,6} * * Default value: 0 * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< double > property_angle() const; /** The desired maximum width of the label, in characters. If this property * is set to -1, the width will be calculated automatically. * * See the section on [text layout][label-text-layout] * for details of how Gtk::Label::property_width_chars() and Gtk::Label::property_max_width_chars() * determine the width of ellipsized and wrapped labels. * * @newin{2,6} * * Default value: -1 * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< int > property_max_width_chars() ; /** The desired maximum width of the label, in characters. If this property * is set to -1, the width will be calculated automatically. * * See the section on [text layout][label-text-layout] * for details of how Gtk::Label::property_width_chars() and Gtk::Label::property_max_width_chars() * determine the width of ellipsized and wrapped labels. * * @newin{2,6} * * Default value: -1 * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< int > property_max_width_chars() const; /** Set this property to true to make the label track which links * have been visited. It will then apply the Gtk::STATE_FLAG_VISITED * when rendering this link, in addition to Gtk::STATE_FLAG_LINK. * * @newin{2,18} * * Default value: true * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_track_visited_links() ; /** Set this property to true to make the label track which links * have been visited. It will then apply the Gtk::STATE_FLAG_VISITED * when rendering this link, in addition to Gtk::STATE_FLAG_LINK. * * @newin{2,18} * * Default value: true * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_track_visited_links() const; /** The number of lines to which an ellipsized, wrapping label * should be limited. This property has no effect if the * label is not wrapping or ellipsized. Set this property to * -1 if you don't want to limit the number of lines. * * @newin{3,10} * * Default value: -1 * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< int > property_lines() ; /** The number of lines to which an ellipsized, wrapping label * should be limited. This property has no effect if the * label is not wrapping or ellipsized. Set this property to * -1 if you don't want to limit the number of lines. * * @newin{3,10} * * Default value: -1 * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< int > property_lines() const; /** The xalign property determines the horizontal aligment of the label text * inside the labels size allocation. Compare this to Gtk::Widget::property_halign(), * which determines how the labels size allocation is positioned in the * space available for the label. * * @newin{3,16} * * Default value: 0.5 * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< float > property_xalign() ; /** The xalign property determines the horizontal aligment of the label text * inside the labels size allocation. Compare this to Gtk::Widget::property_halign(), * which determines how the labels size allocation is positioned in the * space available for the label. * * @newin{3,16} * * Default value: 0.5 * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< float > property_xalign() const; /** The yalign property determines the vertical aligment of the label text * inside the labels size allocation. Compare this to Gtk::Widget::property_valign(), * which determines how the labels size allocation is positioned in the * space available for the label. * * @newin{3,16} * * Default value: 0.5 * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< float > property_yalign() ; /** The yalign property determines the vertical aligment of the label text * inside the labels size allocation. Compare this to Gtk::Widget::property_valign(), * which determines how the labels size allocation is positioned in the * space available for the label. * * @newin{3,16} * * Default value: 0.5 * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< float > property_yalign() const; }; } // namespace Gtk namespace Glib { /** A Glib::wrap() method for this object. * * @param object The C instance. * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref. * @result A C++ instance that wraps this C instance. * * @relates Gtk::Label */ GTKMM_API Gtk::Label* wrap(GtkLabel* object, bool take_copy = false); } //namespace Glib #endif /* _GTKMM_LABEL_H */