[Contents] [Back] [Prev] [Up] [Next] [Forward]

# Package Gtk.Label

A Gtk_Label is a light widget associated with some text you want to display on the screen. You can change the text dynamically if needed.

The text can be on multiple lines if you separate each line with the ASCII.LF character. However, this is not the recommended way to display long texts (see the Gtk_Text widget instead)

- Gtk.Label Widget Hierarchy
- Gtk.Label Subprograms

## Widget Hierarchy

    Gtk_Object                    (see section Package Gtk.Object)
       \___ Gtk_Widget            (see section Package Gtk.Widget)
          \___ Gtk_Misc           (see section Package Gtk.Misc)
             \___ Gtk_Label       (see section Package Gtk.Label)

## Subprograms

    procedure Gtk_New
      (Label              : out    Gtk_Label;
       Str                : in     String := "");

| Create a new label. Str is the string to be displayed.

    function Get_Type              return Gtk.Gtk_Type;

| Return the internal value associated with a Gtk_Label.

    procedure Set_Text
      (Label              : access Gtk_Label_Record;
       Str                : in     String);

| Change the text of the label. The new text is visible on the screen at once. Note that the underline pattern is not modified.

    procedure Set_Justify
      (Label              : access Gtk_Label_Record;
       Jtype              : in     Enums.Gtk_Justification);

Set the justification for the label.
The default value is Justify_Center, which means that the text will be centered in the label. Note that this setting has an impact only when the Gtk_Label is larger than the text (its default width is the same as the text) and contains multiple lines. To justify a single line label, you should instead change the properties of the container handling the label (box, table, ...).

    procedure Set_Pattern
      (Label              : access Gtk_Label_Record;
       Pattern            : in     String);

| Change the underlines pattern. Pattern is a simple string made of underscore and space characters, matching the ones in the string. GtkAda will underline every letter that matches an underscore. An empty string disables the underlines. example: If the text is FooBarBaz and the Pattern is "___ ___" then both "Foo" and "Baz" will be underlined, but not "Bar".

    procedure Set_Line_Wrap
      (Label              : access Gtk_Label_Record;
       Wrap               : in     Boolean);

| Toggle line wrapping within Label. if Wrap is True, then Label will break lines if the text is larger then the widget's size. If Wrap is False, then the text is simply cut off.

    function Get
      (Label              : access Gtk_Label_Record)
       return String;

| Get the current value of the text displayed in the label.

    function Parse_Uline
      (Label              : access Gtk_Label_Record;
       Text               :        String)
       return Gdk.Types.Gdk_Key_Type;

| Create both the text and the underscore pattern from a single string. Text is parsed for underscores. The next character is converted to an underlined character.

[Contents] [Back] [Prev] [Up] [Next] [Forward]