/usr/include/gtkmm-2.4/gtkmm/label.h is in libgtkmm-2.4-dev 1:2.24.4-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 | // -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _GTKMM_LABEL_H
#define _GTKMM_LABEL_H
#include <glibmm.h>
/* $Id: label.hg,v 1.11 2006/06/21 20:04:25 murrayc Exp $ */
/* 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., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <gtkmm/misc.h>
#include <pangomm/attrlist.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkLabel GtkLabel;
typedef struct _GtkLabelClass GtkLabelClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{ class Label_Class; } // namespace Gtk
namespace Gtk
{
class Menu;
/** A widget that displays a small to medium amount of text.
*
* A simple setable widget for holding a Glib::ustring.
*
* The Label widget looks like this:
* @image html label1.png
*
* @ingroup Widgets
*/
class 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 */
virtual ~Label();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
friend class Label_Class;
static CppClassType label_class_;
// noncopyable
Label(const Label&);
Label& operator=(const Label&);
protected:
explicit Label(const Glib::ConstructParams& construct_params);
explicit Label(GtkLabel* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_type() G_GNUC_CONST;
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GtkObject.
GtkLabel* gobj() { return reinterpret_cast<GtkLabel*>(gobject_); }
///Provides access to the underlying C GtkObject.
const GtkLabel* gobj() const { return reinterpret_cast<GtkLabel*>(gobject_); }
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
virtual void on_populate_popup(Menu* menu);
private:
public:
Label();
explicit Label(const Glib::ustring& label, bool mnemonic = false);
/** 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
*/
Label(const Glib::ustring& label, float xalign, float yalign, bool mnemonic = false);
/** 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
*/
Label(const Glib::ustring& label, AlignmentEnum xalign, AlignmentEnum yalign = 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.
*
* <note>The attributes set with this function will be applied
* and merged with any other attributes previously effected by way
* of the Gtk::Label:use-underline or Gtk::Label: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.</note>
* @param attrs A Pango::AttrList.
*/
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 <tt>0</tt>
* if none was set.
*/
Pango::AttrList get_attributes() const;
/** 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:use-underline" and
* Gtk::Label: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 ", str);
* gtk_label_set_markup (GTK_LABEL (label), markup);
* g_free (markup);
* ]|
* @param str A markup string (see ).
*/
void set_markup(const Glib::ustring& str);
/** Sets whether the text of the label contains markup in . See set_markup().
* @param setting <tt>true</tt> 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 . See set_use_markup().
* @return <tt>true</tt> 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 <tt>true</tt> 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 <tt>true</tt> 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 ,
* 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 ).
*/
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_VoidSymbol.
* @return GDK keyval usable for accelerators, or #GDK_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.
*/
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 <tt>0</tt> 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 <tt>0</tt> 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::Misc::set_alignment() 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;
void set_pattern(const Glib::ustring& pattern);
/** Toggles line wrapping within the Gtk::Label widget. <tt>true</tt> makes it break
* lines if text exceeds the widget's size. <tt>false</tt> lets the text get cut off
* by the edge of the widget if it exceeds the widget size.
*
* Note that setting line wrapping to <tt>true</tt> 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 <tt>true</tt> 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 <tt>true</tt> 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 <tt>true</tt> to allow selecting text in the label.
*/
void set_selectable(bool setting = true);
/** Gets the value set by set_selectable().
* @return <tt>true</tt> 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 <tt>true</tt>
* 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 <tt>true</tt> 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<Pango::Layout> 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<const Pango::Layout> 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 a Gtk::NO_WINDOW widget. 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 <tt>0</tt>.
* @param y Location to store Y offset of layout, or <tt>0</tt>.
*/
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 <tt>true</tt> 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 <tt>true</tt> 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::activate-link handler
* or for use in a Gtk::Widget::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 <tt>true</tt> 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 <tt>true</tt> if clicked links are remembered.
*/
bool get_track_visited_links() const;
/**
* @par Prototype:
* <tt>void on_my_%populate_popup(Menu* menu)</tt>
*/
Glib::SignalProxy1< void,Menu* > signal_populate_popup();
/**
* @par Prototype:
* <tt>bool on_my_%activate_link(const Glib::ustring& uri)</tt>
*/
Glib::SignalProxy1< bool,const Glib::ustring& > signal_activate_link();
//Keybinding signals:
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The text of the label.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<Glib::ustring> property_label() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The text of the label.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<Glib::ustring> property_label() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** A list of style attributes to apply to the text of the label.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<Pango::AttrList> property_attributes() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** A list of style attributes to apply to the text of the label.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<Pango::AttrList> property_attributes() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The text of the label includes XML markup. See pango_parse_markup().
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<bool> property_use_markup() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The text of the label includes XML markup. See pango_parse_markup().
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<bool> property_use_markup() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<bool> property_use_underline() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<bool> property_use_underline() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** 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 GtkMisc::xalign for that.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<Justification> property_justify() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** 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 GtkMisc::xalign for that.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<Justification> property_justify() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** A string with _ characters in positions correspond to characters in the text to underline.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_WriteOnly<Glib::ustring> property_pattern() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** If set, wrap lines if the text becomes too wide.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<bool> property_wrap() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** If set, wrap lines if the text becomes too wide.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<bool> property_wrap() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** If wrap is set, controls how linewrapping is done.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<Pango::WrapMode> property_wrap_mode() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** If wrap is set, controls how linewrapping is done.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<Pango::WrapMode> property_wrap_mode() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether the label text can be selected with the mouse.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<bool> property_selectable() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether the label text can be selected with the mouse.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<bool> property_selectable() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The mnemonic accelerator key for this label.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<guint> property_mnemonic_keyval() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The widget to be activated when the label's mnemonic key is pressed.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<Widget*> property_mnemonic_widget() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The widget to be activated when the label's mnemonic key is pressed.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<Widget*> property_mnemonic_widget() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The current position of the insertion cursor in chars.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<int> property_cursor_position() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The position of the opposite end of the selection from the cursor in chars.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<int> property_selection_bound() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The preferred place to ellipsize the string, if the label does not have enough room to display the entire string.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<Pango::EllipsizeMode> property_ellipsize() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The preferred place to ellipsize the string, if the label does not have enough room to display the entire string.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<Pango::EllipsizeMode> property_ellipsize() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The desired width of the label, in characters.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<int> property_width_chars() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The desired width of the label, in characters.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<int> property_width_chars() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether the label is in single line mode.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<bool> property_single_line_mode() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether the label is in single line mode.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<bool> property_single_line_mode() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Angle at which the label is rotated.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<double> property_angle() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Angle at which the label is rotated.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<double> property_angle() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The desired maximum width of the label, in characters.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<int> property_max_width_chars() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The desired maximum width of the label, in characters.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<int> property_max_width_chars() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether visited links should be tracked.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<bool> property_track_visited_links() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether visited links should be tracked.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<bool> property_track_visited_links() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
};
} // 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
*/
Gtk::Label* wrap(GtkLabel* object, bool take_copy = false);
} //namespace Glib
#endif /* _GTKMM_LABEL_H */
|