Index

Package: Glade

Description

package Glib.Glade is
This package provides the low level Gate API to generate code for the GUI builder. See package Gtk.Glade for the high level routines.

Packages

Glib_XML (new Glib.XML) 

package Glib_XML is new Glib.XML (XML_Data);

Types

XML_Data 

type XML_Data is record
      Created : Boolean := False;
      --  True if the corresponding object has been created

      Has_Container : Boolean := False;
      --  True if object has a container

      Initialized : Boolean := False;
      --  True if object has been initialized, in other words, no further
      --  action is required on this widget.

      Has_Accel_Group : Boolean := False;
      --  True if object has created an accelerator group

      Has_Radio_Group : Boolean := False;
      --  True if object has created a radio button/menu_item group

      Has_Tooltip : Boolean := False;
      --  True if object has created a tooltip group
   end record;
Extra Data added to each node of the XML tree when parsing a Glade file. This node summarizes the characteristics of the widget bound to that node.

Constants & Global variables

Gettext (Boolean) 

Gettext : Boolean := True;
Indicates whether the project currently being parsed supports Gettext

Subprograms & Entries

Add_Package 

procedure Add_Package 
(S: String);
Add package S in the list of packages if S isn't already present. This is used to generate the proper list of "with"ed packages. Note that S is assumed to be a child of Gtk, e.g for Gtk.Table, call Add_Package ("Table").

Adjust 

function Adjust 
(S: String) return String;
Replace non "compilable" characters (e.g ASCII.LF). Return a printable and "compilable" Ada string.

Find_Parent 

function Find_Parent 
(N: Node_Ptr;
Class: String) return Node_Ptr;
Find a node in the ancestors of N with a given class.

Find_Top_Widget 

function Find_Top_Widget 
(N: Node_Ptr) return Node_Ptr;
Find a node in the ancestors of N that represents a root widget.

Find_Child 

function Find_Child 
(N: Node_Ptr;
Tag: String) return Node_Ptr;
Find a node in the children of N with a given Tag.

To_Ada 

function To_Ada 
(S: String;
Separator: Character := '_') return String;
Convert S by adding a separator before each upper case character. Also put in upper case each character following a separator.

To_Float 

function To_Float 
(S: String) return String;
Convert S to an Ada Float by adding a trailing ".0" when needed.

Get_Part 

function Get_Part 
(S: String;
Part: Positive;
Separator: Character := ':') return String;
Get the Part-th part of S delimited by Separator.

Gen_Set 

procedure Gen_Set 
(N: Node_Ptr;
Name: String;
File: File_Type;
Prefix: String  := "";
Postfix: String  := "";
Is_Float: Boolean := False;
Property_Name: String := "");
Generate a Set_<Name> call in File. Name is surrounded by Prefix and Postfix. If Is_Float is true, call To_Float on the field <Name>. Property_Name is the name of the property to look for in N; if Property_Name is empty, use Name instead.

Gen_Set 

procedure Gen_Set 
(N: Node_Ptr;
Name, Field: String;
File: File_Type);
Generate a Set_<Name> (Field) call in File.

Gen_Set 

procedure Gen_Set 
(N: Node_Ptr;
Name, Field1, Field2, Field3, Field4: String;
File: File_Type;
Is_Float: Boolean := False);
Generate a Set_<Name> (Field1) call in File if Field2 is a null string. Or Set_<Name> (Field1, Field2) if Field3 is a null string, or Set_<Name> (Field1, Field2, Field3) if Field4 is null, or Set_<Name> (Field1, Field2, Field3, Field4) otherwise. If Is_Float is true, call To_Float on each non null field.

Gen_New 

procedure Gen_New 
(N: Node_Ptr;
Class: String;
Param1, Param2, New_Name: String := "";
File: File_Type;
Prefix: String := "";
Postfix: String := "");
Output a call to <Class>.Gtk_New in File. N is the node containing the widget to create. If Param<n> is not null, it represents a parameter of Gtk_New. New_Name if not null is a name appended to Gtk_New_, e.g Gtk_New_Vbox if New_Name = Vbox. Param1 is surrounded by Prefix and Postfix.

Gen_New 

procedure Gen_New 
(N: Node_Ptr;
Class, Param1, Param2, Param3, Param4, Param5: String;
File: File_Type;
Prefix: String := "";
Postfix: String := "");
Output a call to <Class>.Gtk_New in File. N is the node containing the widget to create. Each Param<n> represents a parameter of Gtk_New, except Param5 which is omitted if null. Param1 is surrounded by Prefix and Postfix.

Gen_Child 

procedure Gen_Child 
(N, Child: Node_Ptr;
File: File_Type);
Output an assignment in File of the form: <Name> := Get_<Child-2> (<Parent>); where Name is the name of the widget represented by N, Child-2 is the second part of Child.Value, the delimiter being ':' (e.g Child-2 = Vbox if Child.Value = Dialog:vbox) Parent is the first parent of N whose class is the first part of Child.Value (e.g Dialog if Child.Value = Dialog:vbox)

Gen_Call_Child 

procedure Gen_Call_Child 
(N, Child, Parent: Node_Ptr;
Class, Call: String;
Param1, Param2, Param3: String := "";
File: File_Type);
If N has a field "name", Output a call to Call in File of the form: <Call> (Parent (N), N) if Child is null, or <Call> (<Parent>, N) where Parent (N) is the name of N.Parent and <Parent> is the name of the first parent of N whose class is <Class> Param<n> when non null, represents a field of Child (Child must not be null) and is added to the parameters of <Call>

Gen_Packages 

procedure Gen_Packages 
(File: File_Type);
Output to file all the packages that have been referenced in previous calls to the Gen_* procedures. The output has the form: with Gtk.xxx; use Gtk.xxx; with Gtk.yyy; use Gtk.yyy;

Reset_Packages 

procedure Reset_Packages;
Reset the global table of packages.

Reset_Tree 

procedure Reset_Tree 
(N: Node_Ptr;
Check_Next: Boolean := True);
Reset the value of the flags for each node contained in N. Check_Next indicates whether the linked list of brothers of N should also be reset (the children are always reset recursively).

Gen_Signal 

procedure Gen_Signal 
(N: Node_Ptr;
File: File_Type;
Widget_Class: String := "";
The_Object: String := "");
Output to file calls to connect if N contains any signal. Also register the class of the widget that uses signals. Widget_Class if not null specifies the class of the widget contained in N. If null, the class will be retrieved from the "class" field of N. This is useful when a downcast is needed. If The_Object is specified, connect the signat to this object instead of reading it from N.

Gen_Signal_Instantiations 

function Gen_Signal_Instantiations 
(Project: String;
File: File_Type) return Natural;
Output to file all the instantiations of Gtk.Signal that have been referenced in previous calls to Gen_Signal. Return the number of instantiations generated. The instantiations are all generated in a package called Callbacks_<Project>

Gettext_Support 

function Gettext_Support 
(N: Node_Ptr) return Boolean;
Return True if the project's parameter "gettext_support" is True.

To_Package_Name 

function To_Package_Name 
(S: String) return String;
Transform the name of a given Gtk+ widget into the corresponding GtkAda package, by applying if needed GtkAda special exceptions in the naming rules (e.g GtkEntry -> Gtk.GEntry, GtkHScale -> Gtk.Scale).

Get_Property 

function Get_Property 
(N: Node_Ptr;
Property: String) return String_Ptr;
Return the value of the property Property if it exists in the direct children of N.

Get_Class 

function Get_Class 
(N: Node_Ptr) return String;
Return the class of N if N is a widget. Otherwise return "".

Get_Name 

function Get_Name 
(N: Node_Ptr) return String;
Return the name of N.

Get_Property 

function Get_Property 
(N: Node_Ptr;
Property: String;
Default: String := "") return String;
Return the propertu Property in N, or Default if the property was not found.