## Documentation

Table of Contents
Class Inheritance Tree
Widget Screenshots
Package groups

1.     -----------------------------------------------------------------------

2.     --               GtkAda - Ada95 binding for Gtk+/Gnome               --

3.     --                                                                   --

4.     --   Copyright (C) 1998-2000 E. Briot, J. Brobecker and A. Charlet   --

5.     --                Copyright (C) 2000-2007 AdaCore                    --

6.     --                                                                   --

7.     -- This library is free software; you can redistribute it and/or     --

8.     -- modify it under the terms of the GNU General Public               --

9.     -- License as published by the Free Software Foundation; either      --

10.     -- version 2 of the License, or (at your option) any later version.  --

11.     --                                                                   --

12.     -- This library is distributed in the hope that it will be useful,   --

13.     -- but WITHOUT ANY WARRANTY; without even the implied warranty of    --

14.     -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU --

15.     -- General Public License for more details.                          --

16.     --                                                                   --

17.     -- You should have received a copy of the GNU General Public         --

18.     -- License along with this library; if not, write to the             --

19.     -- Free Software Foundation, Inc., 59 Temple Place - Suite 330,      --

20.     -- Boston, MA 02111-1307, USA.                                       --

21.     --                                                                   --

22.     -- As a special exception, if other files instantiate generics from  --

23.     -- this unit, or you link this unit with other files to produce an   --

24.     -- executable, this  unit  does not  by itself cause  the resulting  --

25.     -- executable to be covered by the GNU General Public License. This  --

26.     -- exception does not however invalidate any other reasons why the   --

27.     -- executable file  might be covered by the  GNU Public License.     --

28.     -----------------------------------------------------------------------

30.     --  <description>

31.     --  Note that this package is currently not supported under Win32 systems.

32.     --

33.     --  Together with Gtk_Socket, Gtk_Plug provides the ability to embed widgets

34.     --  from one process into another process in a fashion that is transparent to

35.     --  the user. One process creates a Gtk_Socket widget and, passes the XID of

36.     --  that widgets window to the other process, which then creates a Gtk_Plug

37.     --  window with that XID.

38.     --  Any widgets contained in the Gtk_Plug then will appear inside the first

39.     --  applications window.

40.     --  </description>

41.     --  <c_version>2.8.17</c_version>

42.     --  <group>Inter-Process communication</group>

44.     with Gtk.WindowTo API docTo specTo body;

46.     package Gtk.PlugTo API docTo specTo body is

48.        type Gtk_Plug_RecordTo API docTo body is new Gtk.Window.Gtk_Window_RecordTo API docTo specTo body with private;

49.        type Gtk_Plug is access all Gtk_Plug_RecordTo API docTo specTo body'Class;

51.        procedure Gtk_NewTo API docTo body (Plug : out Gtk_PlugTo API docTo spec; Socket_Id : Guint32To API docTo spec);

52.        --  Create a new plug widget inside the Gtk_Socket identified by socket_id.

53.        --  Socket_Id is the XID of the socket's window.

55.        procedure InitializeTo API docTo body

56.          (Plug : access Gtk_Plug_RecordTo API docTo specTo body'Class; Socket_Id : Guint32To API docTo spec);

57.        --  Internal initialization function.

58.        --  See the section "Creating your own widgets" in the documentation.

60.        function Get_IdTo API docTo body (Plug : access Gtk_Plug_RecordTo API docTo specTo body) return Guint32To API docTo spec;

61.        --  Return the low level window id associated with Plug.

63.        function Get_TypeTo API docTo body return Gtk.Gtk_TypeTo API docTo spec;

64.        --  Return the internal value associated with a Gtk_Plug.

66.        -------------

67.        -- Signals --

68.        -------------

70.        --  <signals>

71.        --  The following new signals are defined for this widget:

72.        --

73.        --  - "embedded"

74.        --    procedure Handler (Plug : access Gtk_Plug_Record'Class);

75.        --    Emitted when the plug has been successfully added to a socket.

76.        --

77.        --  </signals>

79.        Signal_Embedded : constant Glib.Signal_NameTo API docTo spec := "embedded";

81.     private

82.        type Gtk_Plug_RecordTo API docTo spec is new Gtk.Window.Gtk_Window_RecordTo API docTo specTo body with null record;

83.        pragma Import (C, Get_TypeTo API docTo spec, "gtk_plug_get_type");

84.     end Gtk.PlugTo API docTo specTo body;

86.     --  No binding: gtk_plug_construct

87.     --  No binding: gtk_plug_construct_for_display

88.     --  No binding: gtk_plug_new_for_display