GtkAda Reference Manual - Package Glib

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

@dircategory User Interface Toolkit * GtkAda_Rm: (gtkada_rm). Ada95 graphical tookit based on GTK+ (Reference Manual)

Copyright (C) 1998-2000, Emmanuel Briot, Joel Brobecker, Arnaud Charlet

Copyright (C) 2000-2003, ACT-Europe

# Package Glib

This package provides definitions for the basic types used in Glib, Gdk and Gtk.

- Glib Types
- Glib Subprograms

## Types

    subtype Allocation_Int is Gint;
| Provided for better compatibility between GtkAda 1.2 and 2.0
    type Boolean_Array is array (Natural range <>) of Boolean;
    type Boxed_Copy is access function
        (Boxed : System.Address) return System.Address;
    type Boxed_Free is access procedure
        (Boxed : System.Address);
    type C_Proxy is access C_Dummy;
| General proxy for C structures. This type is used instead of System.Address so that the variables are automatically initialized to 'null'. The value pointed to is irrelevant, and in fact should not be accessed. It has thus been made limited private with no subprogram to access it. C_Proxy is a public type so that one can compare directly the value of the variables with 'null'.
    type GQuark is new Guint32;
| Represents a string internally in GtkAda. Once you know the equivalent for a string, you can always use it instead of the string, which provides a faster access for all the functions that use htables in GtkAda. There is a global htable that contains all the quarks defined in your application and GtkAda itself.
    type GTime_Val is record
        TV_Sec  : Glong;
        TV_Usec : Glong;
        end record;
    type GTime_Val_Access is access all GTime_Val;
    type GType is new Gsize;
| This type describes an internal type in Glib. You shouldn't have to use it in your own applications, however it might be useful sometimes. Every object type is associated with a specific value, created dynamically at run time the first time you instantiate an object of that type (thus if you have never used e.g a Gtk_File_Selection, it won't have any GType associated with it). You can get the exact type value for each type by using the functions Get_Type provided in all the packages in GtkAda. You can get the specific value for an existing widget by using the function Gtk.Object.Get_Type.
    type GType_Array is array (Guint range <>) of Glib.GType;
    type G_Destroy_Notify is access procedure
        (Data : Glib.C_Proxy);
    type Gboolean is new Gint;
    type Gboolean_Array is array (Natural range <>) of Gboolean;
    type Gchar is new C.char;
    subtype Gcolor_Int is Guint16;
| Provided for better compatibility between GtkAda 1.2 and 2.0
    type Gdouble is new C.double;
    type Gdouble_Array is array (Natural range <>) of Gdouble;
    type Gfloat is new C.C_float;
    type Gfloat_Array is array (Natural range <>) of Gfloat;
    type Gint is new C.int;
    type Gint16 is range -(2 ** 15) .. (2 ** 15 - 1);
    type Gint32 is range -(2 ** 31) .. (2 ** 31 - 1);
    type Gint64 is range -(2 ** 63) .. (2 ** 63 - 1);
    type Gint8 is range -(2 ** 7) .. (2 ** 7 - 1);
    type Gint_Array is array (Natural range <>) of Gint;
    type Glong is new C.long;
    type Glong_Array is array (Natural range <>) of Glong;
    subtype Grange_Float is Gdouble;
| Needed for better compatibility between GtkAda 1.2 and 2.0
    type Gshort is new C.short;
    type Gshort_Array is array (Natural range <>) of Gshort;
    type Gsize is new C.size_t;
    type Guchar is new C.unsigned_char;
    type Guchar_Array is array (Natural range <>) of Guchar;
    type Guchar_Array_Access is access Guchar_Array;
    type Guint is new C.unsigned;
    type Guint16 is mod 2 ** 16;
    type Guint32 is mod 2 ** 32;
    type Guint32_Array is array (Natural range <>) of Guint32;
    type Guint64 is mod 2 ** 64;
    type Guint8 is mod 2 ** 8;
    type Guint_Array is array (Natural range <>) of Guint;
    type Gulong is new C.unsigned_long;
    type Gulong_Array is array (Natural range <>) of Gulong;
    type Gunichar is new Guint32;
    type Gushort is new C.unsigned_short;
    type Gushort_Array is array (Natural range <>) of Gushort;
    type Long_Array is array (Natural range <>) of C.long;
    type Param_Flags is mod 2 ** 6;
    type Param_Spec is new Glib.C_Proxy;
| See Glib.Properties.Creation for more information on this type
    type Property is private;
    type Short_Array is array (Natural range <>) of C.short;
    type Signal_Id is private;
| This uniquely identifies a connection widget<->signal.
    type String_Ptr is access all String;
    subtype UTF8_String is String;
| A string that accepts only valid UTF8 sequences. Most Gtk+ function expect valid UTF8 strings instead of regular strings.

## Subprograms

### Conversion services
    function To_Boolean_Array
      (A                  : in     Gboolean_Array)
       return Boolean_Array;
| Convert a C-style boolean array into an Ada-style array.
    function To_Gint
      (Bool               : in     Boolean)
       return Gint;
| Convert an Ada boolean into a C int.
### Quarks
    function Quark_From_String
      (Id                 : in     String)
       return GQuark;
| Return, or create the quark associated with the string. Note that if the quark does not already exist, an entry is created for it in the global htable for quarks.
    function Quark_Try_String
      (Id                 : in     String)
       return GQuark;
| Return the quark associated with the string, if it exists. If it does not exist, return Unknown_Quark.
### Properties
This is only the definition of the property types. See Glib.Properties on how to get and set the value of properties for specific objects, or the package Glib.Properties.Creation for information on how to create new properties in your own widgets.
    function Build
      (Name               :        String)
       return Property;
| You should use this function only if you are creating new widgets, and their properties. Normal usage of properties doesn't require the use of this function. An ASCII.NUL character is automatically appended if necessary
    function Property_Name
      (Prop               :        Property)
       return String;
| Return the name of the property. This name includes the trailing ASCII.Nul, and thus can be passed as is to C.
### GType
    function Parent
      (Typ                :        GType)
       return GType;
| Return the parent type of Typ (eg if Typ is associated with a Gtk widget, it returns the typ of its parent).
    function Fundamental
      (Typ                :        GType)
       return GType;
| Return the fundamental type for Type. In gtk+, the types are organized into several hierarchies, similar to what is done for widgets. All of these hierarchies are based on one of the fundamental types defined below. This function returns that fundamental type. For instance, each enumeration type in gtk+ has its own GType. However, Fundamental will return GType_Enum in all of these cases.
    function Type_Name
      (Type_Num           : in     GType)
       return String;
| Return the name of the type (enumeration,...) associated with Typ. If Fundamental (Typ) return GType_Enum, this returns the name of the enumeration type that Typ represents. This might be useful in debug messages.
    function Type_From_Name
      (Name               : in     String)
       return GType;
| Convert a string to the matching type. Name should be the C GObject name rather than the Ada name: thus, use names such as GtkScrollbar or GtkButton for widgets.
### Boxed types
Boxed types are a convenient way to encapsulate Ada types through a C layer. An initialization and a finalization function can be provided. The most frequent usage of such types is in argument to signals and handlers (See the functions in Glib.Values), or to store such types in a Gtk_Tree_Model.
    function Boxed_Type_Register_Static
      (Name               :        String;
       Copy               :        Boxed_Copy;
       Free               :        Boxed_Free)
       return GType;
| Create a new boxed type

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