## Documentation

Table of Contents
Class Inheritance Tree
Widget Screenshots
Package groups

## Index

Package: Object

- Goto spec source

# Description

    package Glib.Object is

This package provides a minimal binding to the GObject type in Glib.

See Glib.Properties for information on how to manipulate properties

# Packages

### User_Data (generic)

Full description

### Object_List (new Glib.GSlist.Generic_SList)

    package Object_List is new Glib.GSlist.Generic_SList (GObject);

### Object_Simple_List (new Glib.Glist.Generic_List)

    package Object_Simple_List is new Glib.Glist.Generic_List (GObject);

# Classes

### GObject_Record

- Goto declaration in source
- Goto full declaration in source

    type GObject_Record is tagged private;

#### Immediate Children:

Gdk.Display.Gdk_Display_Record
Gdk.Pixbuf.Gdk_Pixbuf_Record
Gdk.Screen.Gdk_Screen_Record
Glib.Type_Conversion_Hooks.Handled_Type
Glib.Types.Object_Type_Record
Gtk.Accel_Group.Gtk_Accel_Group_Record
Gtk.Accel_Map.Gtk_Accel_Map_Record
Gtk.Action.Gtk_Action_Record
Gtk.Action_Group.Gtk_Action_Group_Record
Gtk.Adjustment.Gtk_Adjustment_Record
Gtk.Builder.Gtk_Builder_Record
Gtk.Cell_Renderer.Gtk_Cell_Renderer_Record
Gtk.Entry_Completion.Gtk_Entry_Completion_Record
Gtk.Extra.Plot.Gtk_Plot_Axis_Record
Gtk.Extra.Plot_Canvas.Gtk_Plot_Canvas_Child_Record
Gtk.File_Filter.Gtk_File_Filter_Record
Gtk.Handlers.Widget_Type
Gtk.Handlers.Widget_Type
Gtk.Handlers.Widget_Type
Gtk.Handlers.Widget_Type
Gtk.Handlers.Widget_Type
Gtk.Handlers.Widget_Type
Gtk.Icon_Factory.Gtk_Icon_Factory_Record
Gtk.Icon_Theme.Gtk_Icon_Theme_Record
Gtk.Item_Factory.Gtk_Item_Factory_Record
Gtk.Marshallers.Widget_Type
Gtk.Marshallers.Widget_Type
Gtk.Marshallers.Widget_Type
Gtk.Marshallers.Widget_Type
Gtk.Page_Setup.Gtk_Page_Setup_Record
Gtk.Paper_Size.Gtk_Paper_Size_Record
Gtk.Print_Context.Gtk_Print_Context_Record
Gtk.Print_Operation.Gtk_Print_Operation_Record
Gtk.Print_Settings.Gtk_Print_Settings_Record
Gtk.Rc.Gtk_Rc_Style_Record
Gtk.Recent_Filter.Gtk_Recent_Filter_Record
Gtk.Recent_Manager.Gtk_Recent_Info_Record
Gtk.Recent_Manager.Gtk_Recent_Manager_Record
Gtk.Settings.Gtk_Settings_Record
Gtk.Size_Group.Gtk_Size_Group_Record
Gtk.Status_Icon.Gtk_Status_Icon_Record
Gtk.Style.Gtk_Style_Record
Gtk.Text_Buffer.Gtk_Text_Buffer_Record
Gtk.Text_Child.Gtk_Text_Child_Anchor_Record
Gtk.Text_Mark.Gtk_Text_Mark_Record
Gtk.Text_Tag.Gtk_Text_Tag_Record
Gtk.Text_Tag_Table.Gtk_Text_Tag_Table_Record
Gtk.Tooltip.Gtk_Tooltip_Record
Gtk.Tooltips.Gtk_Tooltips_Record
Gtk.Tree_Model.Gtk_Tree_Model_Record
Gtk.Tree_Selection.Gtk_Tree_Selection_Record
Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record
Gtk.UI_Manager.Gtk_UI_Manager_Record
Gtk.Widget.Gtk_Widget_Record
Gtk.Window.Gtk_Window_Group_Record
Pango.Context.Pango_Context_Record
Pango.Font.Pango_Font_Record
Pango.Layout.Pango_Layout_Record

#### Primitive operations:

Deallocate

- To API doc
- To spec

Get_Type

- To API doc
- To spec

Notify

- To API doc
- To spec

Ref

- To API doc
- To spec

Ref_Sink

- To API doc
- To spec

Unref

- To API doc
- To spec

# Types

### GObject

- Goto declaration in source

    type GObject is access all GObject_Record'Class;

The base type for Glib/Gdk/Gtk objects. It basically gives access to an underlying C object. This is not a controlled type for efficiency reasons and because glib takes care of the memory management on its own.

### Weak_Notify

- Goto declaration in source

    type Weak_Notify is access procedure
         (Data                 : System.Address;
          Where_The_Object_Was : System.Address);

### Signal_Id_Array

- Goto declaration in source

    type Signal_Id_Array is array (Guint range <>) of Glib.Signal_Id;

### Signal_Query

- Goto declaration in source
- Goto full declaration in source

    type Signal_Query is private;

### Interface_Vtable

- Goto declaration in source

    type Interface_Vtable is private;

The virtual table of an interface (see Glib.Types). This is only useful when doing introspection.

### GObject_Class

- Goto declaration in source

    type GObject_Class is new GType_Class;

### Signal_Parameter_Types

- Goto declaration in source

    type Signal_Parameter_Types is
         array (Natural range <>, Natural range <>) of GType;

The description of the parameters for each event. These are the parameters that the application must provide when emitting the signal. The user can of course add his own parameters when connecting the signal in his application, through the use of Gtk.Handlers.User_Callback. Each event defined with Initialize_Class_Record below should have an entry in this table. If Gtk_Type_None is found in the table, it is ignored. For instance, a Signal_Parameter_Type like: (1 => (1 => Gdk_Type_Gdk_Event, 2 => GType_None), 2 => (1 => GType_Int, 2 => GType_Int)); defines two signals, the first with a single Gdk_Event parameter, the second with two ints parameters.

# Constants & Global variables

### Uninitialized_Class

- Goto declaration in source

(GObject_Class)

    Uninitialized_Class : constant GObject_Class;

This type encloses all the informations related to a specific type of object or widget. All instances of such an object have a pointer to this structure, that includes the definition of all the signals that exist for a given object, all its properties,...

### Null_Parameter_Types

- Goto declaration in source

(Signal_Parameter_Types)

    Null_Parameter_Types : constant Signal_Parameter_Types (1 .. 0, 1 .. 0) :=
         (others => (others => GType_None));

An empty array, used as a default parameter in Initialize_Class_Record.

# Subprograms & Entries

### Is_Created

- Goto spec in source

    function Is_Created (Object: GObject_Record'Class) return Boolean;

Return True if the associated C object has been created, False if no C object is associated with Object. This is not the same as testing whether an access type (for instance any of the widgets) is "null", since this relates to the underlying C object.

### Get_Type

- Goto spec in source

    function Get_Type (Object: access GObject_Record) return GType;

Return the type of Object. This function is mostly used internally, since in Ada you can simply test whether an object belong to a class with a statement like: if Object in Gtk_Button_Record'Class then ... which is easier.

### G_New

- Goto spec in source

    procedure G_New (Object: out GObject);

Create a new GObject. This is only required when you want to create an Ada tagged type to which you can attach new signals. Most of the time, you only need to directly create the appropriate Gtk Widget by calling the correct Gtk_New procedure.

### Initialize

- Goto spec in source

    procedure Initialize (Object: access GObject_Record'Class);

Internal initialization function. See the section "Creating your own widgets" in the documentation.

### Ref

- Goto spec in source

    procedure Ref (Object: access GObject_Record);

Increment the reference counter for Object. See Unref below. Since an object is not deleted while its reference count is not null, this is a way to keep an object in memory, in particular when you want to temporarily remove a widget from its parent.

### Unref

- Goto spec in source

    procedure Unref (Object: access GObject_Record);

Decrement the reference counter for Object. When this reaches 0, the object is effectively destroy, all the callbacks associated with it are disconnected.

### Weak_Ref

- Goto spec in source

    procedure Weak_Ref (Object: access GObject_Record'Class;Notify: Weak_Notify;Data: System.Address := System.Null_Address);

This kind of reference doesn't increment the object's reference counting. However, it can and should be used to monitor the object's life cycle, in particular to detect is destruction. When Object is destroyed, calls Notify

### Weak_Unref

- Goto spec in source

    procedure Weak_Unref (Object: access GObject_Record'Class;Notify: Weak_Notify;Data: System.Address := System.Null_Address);

Cancels the settings of Weak_Ref.

### Deallocate

- Goto spec in source

    procedure Deallocate (Object: access GObject_Record);

This operation is used to deallocate Object. The default implementation assumes that the value passed in is an access value created by an allocator of the default pool, i.e. it will assume that an instance of Unchecked_Deallocation (GObject_Record'Class, GObject) can be used to deallocate the designated object. Types derived of GObject_Record can override this operation in order to cope with objects allocated on other pools or even objects allocated on the stack. This design is limited to support only one allocation strategy for each class, as the class tag is used to identify the applicable strategy.

### Ref_Sink

- Goto spec in source

    procedure Ref_Sink (Object: access GObject_Record);

Increase the reference count of Object, and possibly remove the floating reference, if Object has a floating reference. In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

### Get_Object

- Goto spec in source

    function Get_Object (Object: access GObject_Record'Class) return System.Address;

Access the underlying C pointer.

### Get_Object_Or_Null

- Goto spec in source

    function Get_Object_Or_Null (Object: GObject) return System.Address;

Same as above, but passing "null" is valid.

### Set_Object

- Goto spec in source

    procedure Set_Object (Object: access GObject_Record'Class;Value: System.Address);

Modify the underlying C pointer.

### Get_User_Data

- Goto spec in source

    function Get_User_Data (Obj: System.Address;Stub: GObject_Record'Class) return GObject;

Return the Ada object matching the C object Obj. If Obj was created explicitely from GtkAda, this will be the exact same widget. If Obj was created implicitely by gtk+ (buttons in complex windows,...), a new Ada object of type Stub will be created.

### Get_User_Data_Fast

- Goto spec in source

    function Get_User_Data_Fast (Obj: System.Address;Stub: GObject_Record'Class) return GObject;

Same as Get_User_Data, but does not try to guess the type of Obj, always default to Stub if Obj is unknown to GtkAda.

### Unchecked_Cast

- Goto spec in source

    function Unchecked_Cast (Obj: access GObject_Record'Class;Stub: GObject_Record'Class) return GObject;

Cast Obj in an object of tag Stub'Class. Return the resulting object and free the memory pointed by Obj.

### Lookup

- Goto spec in source

    function Lookup (Object: Glib.GType;Signal: String) return Glib.Signal_Id;

Returns the signal Id associated with a specific Object/Signal pair. Null_Signal_Id is returned if no such signal exists for Object. You can then use the Query procedure to get more information on the signal.

### List_Ids

- Goto spec in source

    function List_Ids (Typ: Glib.GType) return Signal_Id_Array;

Return the list of signals defined for Typ. You can get more information on each of this signals by using the Query function below. See also the function Get_Type above to convert from an object instance to its type. Using a GType as the parameter makes it easier to find the signals for a widget and its ancestors (using Glib.Parent).

### Query

- Goto spec in source
- Goto body in source

    procedure Query (Id: Glib.Signal_Id;Result: out Signal_Query);

Return the description associated with the signal Id. You can get the various fields from Query with one of the functions below. Result is undefined if Id is Invalid_Signal_Id or Null_Signal_Id

### Id

- Goto spec in source
- Goto body in source

    function Id (Q: Signal_Query) return Glib.Signal_Id;

Return the signal Id. Each Id is specific to a widget/signal name pair. These Ids can then be used to temporarily block a signal for instance, through the subprograms in Gtk.Handlers.

### Signal_Name

- Goto spec in source

    function Signal_Name (Q: Signal_Query) return Glib.Signal_Name;

Return the name of the signal, as should be used in a call to Connect.

### Return_Type

- Goto spec in source
- Goto body in source

    function Return_Type (Q: Signal_Query) return Glib.GType;

Return the type of object returned by the handlers for this signal.

### Params

- Goto spec in source

    function Params (Q: Signal_Query) return GType_Array;

Return the list of parameters for the handlers for this signal

### Initialize_Class_Record

- Goto spec in source

    procedure Initialize_Class_Record (Object: access GObject_Record'Class;Signals: Gtkada.Types.Chars_Ptr_Array;Class_Record: in out GObject_Class;Type_Name: String;Parameters: Signal_Parameter_Types := Null_Parameter_Types);

Create the class record for a new object type. It is associated with Signals'Length new signals. A pointer to the newly created structure is also returned in Class_Record. If Class_Record /= System.Null_Address, no memory allocation is performed, we just reuse it. As a result, each instantiation of an object will share the same GObject_Class, exactly as is done for gtk+. Note: The underlying C object must already have been initialized by a call to its parent's Initialize function. Parameters'Length should be the same as Signals'Length, or the result is undefined. As a special case, if Parameters has its default value, all signals are created with no argument. This is done for backward compatibility mainly, and you should instead give it an explicit value. Type_Name should be a unique name identifying the name of the new type. Only the signals with no parameter can be connected from C code. However, any signal can be connected from Ada. This is due to the way we define default marshallers for the signals.

### Type_From_Class

- Goto spec in source
- Goto body in source

    function Type_From_Class (Class_Record: GObject_Class) return GType;

Return the internal gtk+ type that describes the newly created Class_Record. See the function Glib.Types.Class_Peek for the opposite function converting from a GType to a GObject_Class.

### Interface_List_Properties

- Goto spec in source

    function Interface_List_Properties (Vtable: Interface_Vtable) return Glib.Param_Spec_Array;

Return the list of properties of an interface (see also Glib.Properties) from a Vtable from Default_Interface_Peek). See also Class_List_Properties for a similar function for objects.

### Class_List_Properties

- Goto spec in source

    function Class_List_Properties (Class: GObject_Class) return Glib.Param_Spec_Array;

Return the list of all properties of the class.

### Notify

- Goto spec in source

    procedure Notify (Object: access GObject_Record;Property_Name: String);

Emits the "notify" signal, to signal every listener that the property has been changed.

### Convert

- Goto spec in source

    function Convert (W: GObject) return System.Address;

### Convert

- Goto spec in source

    function Convert (W: System.Address) return GObject;