Glib

Entities

Simple Types

Array Types

Record Types

Tagged Types

Access Types

Subtypes

Constants

Subprograms

Generic Instantiations

Description

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

<group>Glib, the general-purpose library</group>

Allocation_Int

subtype Allocation_Int is Gint;

Provided for better compatibility between GtkAda 1.2 and 2.0

array_of_gsize

type array_of_gsize is array (Natural range <>) of Gsize;

Boolean_Array

type Boolean_Array  is array (Natural range <>) of Boolean;

Boxed_Copy

type Boxed_Copy is access
   function (Boxed : System.Address) return System.Address;
Parameters
Boxed
Return Value

Boxed_Free

type Boxed_Free is access procedure (Boxed : System.Address);
Parameters
Boxed

Boxed_Type_Register_Static

function Boxed_Type_Register_Static
  (Name : String;
   Copy : Boxed_Copy;
   Free : Boxed_Free) return GType

Create a new boxed type

Parameters
Name
Copy
Free
Return Value

Build

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

Parameters
Name
Return Value

C_Boxed

type C_Boxed is tagged private;

An opaque type that wraps a pointer to a C object. It is used instead of a C_Proxy in cases where we want to have a tagged type so that users can use the object-dotted notation when calling methods.

C_Dummy

type C_Dummy is limited private;

</doc_ignore>

C_Proxy

type C_Proxy is access all 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'.

Free

procedure Free is new Ada.Unchecked_Deallocation
  (Object => Guchar_Array, Name => Guchar_Array_Access);

Free

procedure Free is new Ada.Unchecked_Deallocation
  (Object => String, Name => String_Ptr);

</doc_ignore>

Fundamental

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.

Parameters
Typ
Return Value

G_Connect_After

G_Connect_After   : constant G_Connect_Flags := 2 ** 0;

Used to specify the behavior of a signal's connection.

G_Connect_Flags

type G_Connect_Flags is mod 2 ** C.int'Size;

Used to specify the behavior of a signal's connection.

G_Connect_Swapped

G_Connect_Swapped : constant G_Connect_Flags := 2 ** 1;

Used to specify the behavior of a signal's connection.

G_Destroy_Notify

type G_Destroy_Notify is access procedure (Data : Glib.C_Proxy);

Callback used when some named data associated with an object is destroyed.

Parameters
Data

G_Destroy_Notify_Address

type G_Destroy_Notify_Address is
  access procedure (Data : System.Address);
Parameters
Data

g_free

procedure g_free (A : System.Address)

</doc_ignore>

Parameters
A

GApp_Info

type GApp_Info is new C_Proxy;

Gboolean

type Gboolean is new Gint;

Gboolean_Array

type Gboolean_Array is array (Natural range <>) of Gboolean;

Gchar

type Gchar  is new C.char;

Gchar_Array

type Gchar_Array    is array (Natural range <>) of Gchar;

Gcolor_Int

subtype Gcolor_Int is Guint16;

Provided for better compatibility between GtkAda 1.2 and 2.0

Gdouble

type Gdouble is new C.double;

Gdouble_Array

type Gdouble_Array  is array (Natural range <>) of Gdouble;

Get_Object

function Get_Object (Self : C_Boxed'Class) return System.Address

The internal C object. It should not be used directly by applications.

Parameters
Self
Return Value

Get_Qdata

function Get_Qdata (Typ : GType; Quark : GQuark) return Glib.C_Proxy

Return the user data set for Typ

Parameters
Typ
Quark
Return Value

Gfloat

type Gfloat  is new C.C_float;

Gfloat_Array

type Gfloat_Array   is array (Natural range <>) of Gfloat;

Gint

type Gint   is new C.int;

Gint16

type Gint16 is range -(2 ** 15) .. (2 ** 15 - 1);

Gint32

type Gint32 is range -(2 ** 31) .. (2 ** 31 - 1);

Gint64

type Gint64 is range -(2 ** 63) .. (2 ** 63 - 1);

Gint8

type Gint8  is range -(2 ** 7) .. (2 ** 7 - 1);

Gint_Array

type Gint_Array     is array (Natural range <>) of Gint;

Glong

type Glong  is new C.long;

Glong_Array

type Glong_Array    is array (Natural range <>) of Glong;

GQuark

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.

Grange_Float

subtype Grange_Float is Gdouble;

Needed for better compatibility between GtkAda 1.2 and 2.0

Gshort

type Gshort is new C.short;

Gshort_Array

type Gshort_Array   is array (Natural range <>) of Gshort;

Gsize

type Gsize is new C.size_t;

Gssize

type Gssize is
  range -(2 ** (C.size_t'Size - 1)) .. (2 ** (C.size_t'Size - 1) - 1);

GTime_Val

type GTime_Val is record
   TV_Sec  : Glong;
   TV_Usec : Glong;
end record;
Record fields
TV_Sec
TV_Usec

GTime_Val_Access

type GTime_Val_Access is access all GTime_Val;

GType

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 Glib.Object.Get_Type.

GType_Array

type GType_Array is array (Guint range <>) of Glib.GType;

GType_Boolean

GType_Boolean   : constant GType := 5 * (2 ** GType_Fundamental_Shift);

Null terminated string.

GType_Boxed

GType_Boxed     : constant GType := 18 * (2 ** GType_Fundamental_Shift);

The base type for all boxed types. In tree models, you should use the actual type returned by Boxed_Type_Register_Static.

GType_Char

GType_Char      : constant GType := 3 * (2 ** GType_Fundamental_Shift);

Null terminated string.

GType_Class

type GType_Class is private;

An opaque structure used as the base for all classes in glib and gtk+. See also Glib.Object.GObject_Class for a more useful child of this type.

GType_Double

GType_Double    : constant GType := 15 * (2 ** GType_Fundamental_Shift);

Null terminated string.

GType_Enum

GType_Enum      : constant GType := 12 * (2 ** GType_Fundamental_Shift);

Null terminated string.

GType_Flags

GType_Flags     : constant GType := 13 * (2 ** GType_Fundamental_Shift);

Null terminated string.

GType_Float

GType_Float     : constant GType := 14 * (2 ** GType_Fundamental_Shift);

Null terminated string.

GType_Fundamental_Shift

GType_Fundamental_Shift : constant Integer := 2;

GType_Int

GType_Int       : constant GType := 6 * (2 ** GType_Fundamental_Shift);

Null terminated string.

GType_Int64

GType_Int64     : constant GType := 10 * (2 ** GType_Fundamental_Shift);

Null terminated string.

GType_Interface

GType_Interface : constant GType := 2 * (2 ** GType_Fundamental_Shift);

GType_Invalid

GType_Invalid   : constant GType := 0 * (2 ** GType_Fundamental_Shift);

GType_Long

GType_Long      : constant GType := 8 * (2 ** GType_Fundamental_Shift);

Null terminated string.

GType_None

GType_None      : constant GType := 1 * (2 ** GType_Fundamental_Shift);

GType_Object

GType_Object    : constant GType := 20 * (2 ** GType_Fundamental_Shift);

One of the widgets/objects

GType_Param

GType_Param     : constant GType := 19 * (2 ** GType_Fundamental_Shift);

One of the widgets/objects

GType_Pointer

GType_Pointer   : constant GType := 17 * (2 ** GType_Fundamental_Shift);

A general pointer type.

GType_String

GType_String    : constant GType := 16 * (2 ** GType_Fundamental_Shift);

Null terminated string.

GType_Uchar

GType_Uchar     : constant GType := 4 * (2 ** GType_Fundamental_Shift);

Null terminated string.

GType_Uint

GType_Uint      : constant GType := 7 * (2 ** GType_Fundamental_Shift);

Null terminated string.

GType_UInt64

GType_UInt64    : constant GType := 11 * (2 ** GType_Fundamental_Shift);

Null terminated string.

GType_Ulong

GType_Ulong     : constant GType := 9 * (2 ** GType_Fundamental_Shift);

Null terminated string.

Guchar

type Guchar  is new C.unsigned_char;

Guchar_Array

type Guchar_Array   is array (Natural range <>) of Guchar;

Guchar_Array_Access

type Guchar_Array_Access is access Guchar_Array;

Guint

type Guint   is new C.unsigned;

Guint16

type Guint16 is mod 2 ** 16;

Guint32

type Guint32 is mod 2 ** 32;

Guint32_Array

type Guint32_Array  is array (Natural range <>) of Guint32;

Guint64

type Guint64 is mod 2 ** 64;

Guint8

type Guint8  is mod 2 ** 8;

Guint_Array

type Guint_Array    is array (Natural range <>) of Guint;

Gulong

type Gulong  is new C.unsigned_long;

Gulong_Array

type Gulong_Array   is array (Natural range <>) of Gulong;

Gunichar

type Gunichar is new Guint32;

Gushort

type Gushort is new C.unsigned_short;

Gushort_Array

type Gushort_Array  is array (Natural range <>) of Gushort;

Invalid_Signal_Id

Invalid_Signal_Id : constant Signal_Id;

Is_Null

function Is_Null (Self : C_Boxed'Class) return Boolean

Whether the object has been initialized already.

Parameters
Self
Return Value

Long_Array

type Long_Array     is array (Natural range <>) of C.long;

Null_Signal_Id

Null_Signal_Id : constant Signal_Id;

Param_Construct

Param_Construct      : constant Param_Flags := 2 ** 2;

These are the various flags that help define if, and when, a property can be read and modified.

Param_Construct_Only

Param_Construct_Only : constant Param_Flags := 2 ** 3;

These are the various flags that help define if, and when, a property can be read and modified.

Param_Flags

type Param_Flags is mod 2 ** 6;

These are the various flags that help define if, and when, a property can be read and modified.

Param_Lax_Validation

Param_Lax_Validation : constant Param_Flags := 2 ** 4;

These are the various flags that help define if, and when, a property can be read and modified.

Param_Private

Param_Private        : constant Param_Flags := 2 ** 5;

These are the various flags that help define if, and when, a property can be read and modified.

Param_Readable

Param_Readable       : constant Param_Flags := 2 ** 0;

These are the various flags that help define if, and when, a property can be read and modified.

Param_Spec

type Param_Spec is new Glib.C_Proxy;

See Glib.Properties.Creation for more information on this type

Param_Spec_Array

type Param_Spec_Array is array (Natural range <>) of Param_Spec;

See Glib.Properties.Creation for more information on this type

Param_Writable

Param_Writable       : constant Param_Flags := 2 ** 1;

These are the various flags that help define if, and when, a property can be read and modified.

Parent

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).

Parameters
Typ
Return Value

Property

type Property (<>) is private;

Property_Name

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.

Parameters
Prop
Return Value

Quark_From_String

function Quark_From_String (Id : 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.

Parameters
Id
Return Value

Quark_Try_String

function Quark_Try_String (Id : String) return GQuark

Return the quark associated with the string, if it exists. If it does not exist, return Unknown_Quark.

Parameters
Id
Return Value

Set_Object

procedure Set_Object (Self : in out C_Boxed'Class; Ptr : System.Address)

The internal C object. It should not be used directly by applications.

Parameters
Self
Ptr

Set_Qdata

procedure Set_Qdata
  (Typ     : GType;
   Quark   : GQuark;
   Data    : Glib.C_Proxy)

Associate some named data with Typ.

Parameters
Typ
Quark
Data

Short_Array

type Short_Array    is array (Natural range <>) of C.short;

Signal_Id

type Signal_Id is private;

This uniquely identifies a connection widget<->signal.

Signal_Name

type Signal_Name is new String;

A signal name as used in connect, shared type between the Gtk and Glib layer.

String_Ptr

type String_Ptr is access all String;

To_Address

function To_Address is new
  Ada.Unchecked_Conversion (C_Proxy, System.Address);

Converts from a System.Address returned by a C function to an internal C_Proxy.

To_Boolean_Array

function To_Boolean_Array (A : Gboolean_Array) return Boolean_Array

Convert a C-style boolean array into an Ada-style array.

Parameters
A
Return Value

To_Gint

function To_Gint (Bool : Boolean) return Gint

Convert an Ada boolean into a C int.

Parameters
Bool
Return Value

To_Proxy

function To_Proxy is new Ada.Unchecked_Conversion (System.Address, C_Proxy);

Converts from a System.Address returned by a C function to an internal C_Proxy.

Type_From_Name

function Type_From_Name (Name : 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.

Parameters
Name
Return Value

Type_Name

function Type_Name (Type_Num : 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.

Parameters
Type_Num
Return Value

Unknown_Quark

Unknown_Quark : constant GQuark := 0;

UTF8_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.