GtkAda Reference Manual - Package Gtk.Editable

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

# Package Gtk.Editable

This widget is an abstract widget designed to support the common functionalities of all widgets for editing text. It provides general services to manipulate an editable widget, a large number of action signals used for key bindings, and several signals that an application can connect to to modify the behavior of a widget.

- Gtk.Editable Widget Hierarchy
- Gtk.Editable Signals
- Gtk.Editable Subprograms

## Widget Hierarchy

    GObject                       (see section Package Glib.Object)
    Gtk_Object                    (see section Package Gtk.Object)
       \___ Gtk_Widget            (see section Package Gtk.Widget)
          \___ Gtk_Editable       (see section Package Gtk.Editable)

## Signals

- "changed" procedure Handler (Widget : access Gtk_Editable_Record'Class);
  Called when the contents of Widget has changed
- "delete_text" procedure Handler (Widget : access Gtk_Editable_Record'Class;
  Start_Pos : in Gint;
  End_Pos : in Gint);
  Emitted when some text is deleted by the user. As for the "insert-text" handler, it is possible to override the default behavior by connecting a handler to this signal, and then stopping the signal.
- "insert_text" procedure Handler (Widget : access Gtk_Editable_Record'Class;
  Text : in UTF8_String;
  Length : in Gint;
  Position : in Gint_Access);
  Emitted when some text is inserted inside the widget by the user. The default handler inserts the text into the widget. By connecting a handler to this signal, and then by stopping the signal with Gtk.Handlers.Emit_Stop_By_Name, it is possible to modify the inserted text, or even prevent it from being inserted. Position.all should be modified by the callback, and indicates the new position of the cursor after the text has been inserted.

## Subprograms

    function Get_Type              return Glib.GType;
| Return the internal value associated with a Gtk_Editable.
    procedure Select_Region
      (Editable           : access Gtk_Editable_Record;
       Start              :        Gint;
       The_End            :        Gint := -1);
| Select the region of text from Start to The_End. The characters that are selected are those characters at positions from Start up to, but not including The_End. If The_End_Pos is negative, then the characters selected will be those characters from Start to the end of the text.
    procedure Get_Selection_Bounds
      (Widget             : access Gtk_Editable_Record;
       Success            : out    Boolean;
       Start_Pos          : out    Guint;
       End_Pos            : out    Guint);
| Return the position of the start and end of the current selection. If success is false, Start_Pos and End_Pos are not modified.
    procedure Insert_Text
      (Editable           : access Gtk_Editable_Record;
       New_Text           :        UTF8_String;
       Position           : in out Gint);
| Insert the given string at the given position. Position is set to the new cursor position.
    procedure Delete_Text
      (Editable           : access Gtk_Editable_Record;
       Start_Pos          :        Gint := 0;
       End_Pos            :        Gint := -1);
| Delete the characters from Start_Pos to End_Pos. If End_Pos is negative, the characters are deleted from Start_Pos to the end of the text.
    function Get_Chars
      (Editable           : access Gtk_Editable_Record;
       Start_Pos          :        Gint := 0;
       End_Pos            :        Gint := -1)
       return UTF8_String;
| Get the text from Start_Pos to End_Pos. If End_Pos is negative, the text from Start_Pos to the end is returned.
    procedure Cut_Clipboard
      (Editable           : access Gtk_Editable_Record);
| Copy the characters in the current selection to the clipboard. The selection is then deleted.
    procedure Copy_Clipboard
      (Editable           : access Gtk_Editable_Record);
| Copy the characters in the current selection to the clipboard.
    procedure Paste_Clipboard
      (Editable           : access Gtk_Editable_Record);
| The contents of the clipboard is pasted into the given widget at the current cursor position.
    procedure Delete_Selection
      (Editable           : access Gtk_Editable_Record);
| Disclaim and delete the current selection.
    procedure Set_Position
      (Editable           : access Gtk_Editable_Record;
       Position           :        Gint);
| Change the position of the cursor in the entry. The cursor is displayed before the character with the given index in the widget (the first character has index 0). The value must be less than or equal to the number of characters in the widget. A value of -1 indicates that the position should be set after the last character in the entry. Note that this position is in characters, not in bytes.
    function Get_Position
      (Editable           : access Gtk_Editable_Record)
       return Gint;
| Return the position of the cursor.
    procedure Set_Editable
      (Widget             : access Gtk_Editable_Record;
       Editable           :        Boolean := True);
| Set the editable status of the entry. If Editable is False, the user can not modify the contents of the entry. This does not affect the user of the insertion functions above.
    function Get_Editable
      (Editable           : access Gtk_Editable_Record)
       return Boolean;
| Get the editable status of the entry.

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