File: gdk-cursor.ads

------------------------------------------------------------------------------

--                                                                          --

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

--                     Copyright (C) 2000-2014, AdaCore                     --

--                                                                          --

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

-- under terms of the  GNU General Public License  as published by the Free --

-- Software  Foundation;  either version 3,  or (at your  option) any later --

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

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

-- TABILITY or FITNESS FOR A PARTICULAR PURPOSE.                            --

--                                                                          --

-- As a special exception under Section 7 of GPL version 3, you are granted --

-- additional permissions described in the GCC Runtime Library Exception,   --

-- version 3.1, as published by the Free Software Foundation.               --

--                                                                          --

-- You should have received a copy of the GNU General Public License and    --

-- a copy of the GCC Runtime Library Exception along with this program;     --

-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --

-- <http://www.gnu.org/licenses/>.                                          --

--                                                                          --

------------------------------------------------------------------------------

```
 
```
```
--  <description> 
```

--  The Gdk.Gdk_Cursor structure represents a cursor. Its contents are

```
--  private. 
```
```
-- 
```
```
--  </description> 
```
```
pragma Ada_2005; 
```
```
 
```

pragma Warnings (Off, "*is already use-visible*");

with Gdk.DisplayTo API doc
To spec
To body;             use Gdk.DisplayTo API doc
To spec
To body;

with GlibTo API doc
To spec
To body;                    use GlibTo API doc
To spec
To body;

with Glib.Generic_PropertiesTo API doc
To spec
To body; use Glib.Generic_PropertiesTo API doc
To spec
To body;

with Glib.ObjectTo API doc
To spec
To body;             use Glib.ObjectTo API doc
To spec
To body;

with Glib.PropertiesTo API doc
To spec
To body;         use Glib.PropertiesTo API doc
To spec
To body;

```
 
```

package Gdk.CursorTo API doc
To spec
To body is

```
 
```
```
   type Gdk_Cursor_Type is ( 
```
```
      Blank_Cursor, 
```
```
      Cursor_Is_Pixmap, 
```
```
      X_Cursor, 
```
```
      Arrow, 
```
```
      Based_Arrow_Down, 
```
```
      Based_Arrow_Up, 
```
```
      Boat, 
```
```
      Bogosity, 
```
```
      Bottom_Left_Corner, 
```
```
      Bottom_Right_Corner, 
```
```
      Bottom_Side, 
```
```
      Bottom_Tee, 
```
```
      Box_Spiral, 
```
```
      Center_Ptr, 
```
```
      Circle, 
```
```
      Clock, 
```
```
      Coffee_Mug, 
```
```
      Cross, 
```
```
      Cross_Reverse, 
```
```
      Crosshair, 
```
```
      Diamond_Cross, 
```
```
      Dot, 
```
```
      Dotbox, 
```
```
      Double_Arrow, 
```
```
      Draft_Large, 
```
```
      Draft_Small, 
```
```
      Draped_Box, 
```
```
      Exchange, 
```
```
      Fleur, 
```
```
      Gobbler, 
```
```
      Gumby, 
```
```
      Hand1, 
```
```
      Hand2, 
```
```
      Heart, 
```
```
      Icon, 
```
```
      Iron_Cross, 
```
```
      Left_Ptr, 
```
```
      Left_Side, 
```
```
      Left_Tee, 
```
```
      Leftbutton, 
```
```
      Ll_Angle, 
```
```
      Lr_Angle, 
```
```
      Man, 
```
```
      Middlebutton, 
```
```
      Mouse, 
```
```
      Pencil, 
```
```
      Pirate, 
```
```
      Plus, 
```
```
      Question_Arrow, 
```
```
      Right_Ptr, 
```
```
      Right_Side, 
```
```
      Right_Tee, 
```
```
      Rightbutton, 
```
```
      Rtl_Logo, 
```
```
      Sailboat, 
```
```
      Sb_Down_Arrow, 
```
```
      Sb_H_Double_Arrow, 
```
```
      Sb_Left_Arrow, 
```
```
      Sb_Right_Arrow, 
```
```
      Sb_Up_Arrow, 
```
```
      Sb_V_Double_Arrow, 
```
```
      Shuttle, 
```
```
      Sizing, 
```
```
      Spider, 
```
```
      Spraycan, 
```
```
      Star, 
```
```
      Target, 
```
```
      Tcross, 
```
```
      Top_Left_Arrow, 
```
```
      Top_Left_Corner, 
```
```
      Top_Right_Corner, 
```
```
      Top_Side, 
```
```
      Top_Tee, 
```
```
      Trek, 
```
```
      Ul_Angle, 
```
```
      Umbrella, 
```
```
      Ur_Angle, 
```
```
      Watch, 
```
```
      Xterm, 
```
```
      Last_Cursor); 
```

   pragma Convention (C, Gdk_Cursor_TypeTo API doc
To spec);

```
   --  The standard cursors available. 
```
```
 
```

   for Gdk_Cursor_TypeTo API doc
To spec use (

```
      Blank_Cursor => -2, 
```
```
      Cursor_Is_Pixmap => -1, 
```
```
      X_Cursor => 0, 
```
```
      Arrow => 2, 
```
```
      Based_Arrow_Down => 4, 
```
```
      Based_Arrow_Up => 6, 
```
```
      Boat => 8, 
```
```
      Bogosity => 10, 
```
```
      Bottom_Left_Corner => 12, 
```
```
      Bottom_Right_Corner => 14, 
```
```
      Bottom_Side => 16, 
```
```
      Bottom_Tee => 18, 
```
```
      Box_Spiral => 20, 
```
```
      Center_Ptr => 22, 
```
```
      Circle => 24, 
```
```
      Clock => 26, 
```
```
      Coffee_Mug => 28, 
```
```
      Cross => 30, 
```
```
      Cross_Reverse => 32, 
```
```
      Crosshair => 34, 
```
```
      Diamond_Cross => 36, 
```
```
      Dot => 38, 
```
```
      Dotbox => 40, 
```
```
      Double_Arrow => 42, 
```
```
      Draft_Large => 44, 
```
```
      Draft_Small => 46, 
```
```
      Draped_Box => 48, 
```
```
      Exchange => 50, 
```
```
      Fleur => 52, 
```
```
      Gobbler => 54, 
```
```
      Gumby => 56, 
```
```
      Hand1 => 58, 
```
```
      Hand2 => 60, 
```
```
      Heart => 62, 
```
```
      Icon => 64, 
```
```
      Iron_Cross => 66, 
```
```
      Left_Ptr => 68, 
```
```
      Left_Side => 70, 
```
```
      Left_Tee => 72, 
```
```
      Leftbutton => 74, 
```
```
      Ll_Angle => 76, 
```
```
      Lr_Angle => 78, 
```
```
      Man => 80, 
```
```
      Middlebutton => 82, 
```
```
      Mouse => 84, 
```
```
      Pencil => 86, 
```
```
      Pirate => 88, 
```
```
      Plus => 90, 
```
```
      Question_Arrow => 92, 
```
```
      Right_Ptr => 94, 
```
```
      Right_Side => 96, 
```
```
      Right_Tee => 98, 
```
```
      Rightbutton => 100, 
```
```
      Rtl_Logo => 102, 
```
```
      Sailboat => 104, 
```
```
      Sb_Down_Arrow => 106, 
```
```
      Sb_H_Double_Arrow => 108, 
```
```
      Sb_Left_Arrow => 110, 
```
```
      Sb_Right_Arrow => 112, 
```
```
      Sb_Up_Arrow => 114, 
```
```
      Sb_V_Double_Arrow => 116, 
```
```
      Shuttle => 118, 
```
```
      Sizing => 120, 
```
```
      Spider => 122, 
```
```
      Spraycan => 124, 
```
```
      Star => 126, 
```
```
      Target => 128, 
```
```
      Tcross => 130, 
```
```
      Top_Left_Arrow => 132, 
```
```
      Top_Left_Corner => 134, 
```
```
      Top_Right_Corner => 136, 
```
```
      Top_Side => 138, 
```
```
      Top_Tee => 140, 
```
```
      Trek => 142, 
```
```
      Ul_Angle => 144, 
```
```
      Umbrella => 146, 
```
```
      Ur_Angle => 148, 
```
```
      Watch => 150, 
```
```
      Xterm => 152, 
```
```
      Last_Cursor => 153); 
```
```
 
```
```
   ---------------------------- 
```
```
   -- Enumeration Properties -- 
```
```
   ---------------------------- 
```
```
 
```

   package Gdk_Cursor_Type_Properties is

      new Generic_Internal_Discrete_PropertyTo API doc
To spec
To body (Gdk_Cursor_TypeTo API doc
To spec);

   type Property_Gdk_Cursor_Type is new Gdk_Cursor_Type_Properties.PropertyTo API doc
To spec;

```
 
```
```
   ------------------ 
```
```
   -- Constructors -- 
```
```
   ------------------ 
```
```
 
```

   procedure Gdk_NewTo API doc
To body (Self : out Gdk_CursorTo API doc
To spec; Cursor_TypeTo API doc
To body : Gdk_Cursor_TypeTo API doc
To spec);

   --  Creates a new cursor from the set of builtin cursors for the default

   --  display. See gdk_cursor_new_for_display.

   --  To make the cursor invisible, use Gdk.Blank_Cursor.

```
   --  "cursor_type": cursor to create 
```
```
 
```

   function Gdk_Cursor_NewTo API doc
To body (Cursor_TypeTo API doc
To body : Gdk_Cursor_TypeTo API doc
To spec) return Gdk_CursorTo API doc
To spec;

   --  Creates a new cursor from the set of builtin cursors for the default

   --  display. See gdk_cursor_new_for_display.

   --  To make the cursor invisible, use Gdk.Blank_Cursor.

```
   --  "cursor_type": cursor to create 
```
```
 
```

   procedure Gdk_New_For_DisplayTo API doc
To body

      (Self        : out Gdk_CursorTo API doc
To spec;

       Display     : not null access Gdk.Display.Gdk_Display_RecordTo API doc
To spec'Class;

       Cursor_TypeTo API doc
To body : Gdk_Cursor_TypeTo API doc
To spec);

   --  Creates a new cursor from the set of builtin cursors. Some useful ones

```
   --  are: 
```

   --     * <inlinegraphic format="PNG"

   --  fileref="right_ptr.png"></inlinegraphic> GDK_RIGHT_PTR (right-facing

```
   --  arrow) 
```

   --     * <inlinegraphic format="PNG"

   --  fileref="crosshair.png"></inlinegraphic> GDK_CROSSHAIR (crosshair)

   --     * <inlinegraphic format="PNG" fileref="xterm.png"></inlinegraphic>

```
   --  GDK_XTERM (I-beam) 
```

   --     * <inlinegraphic format="PNG" fileref="watch.png"></inlinegraphic>

```
   --  GDK_WATCH (busy) 
```

   --     * <inlinegraphic format="PNG" fileref="fleur.png"></inlinegraphic>

```
   --  GDK_FLEUR (for moving objects) 
```

   --     * <inlinegraphic format="PNG" fileref="hand1.png"></inlinegraphic>

   --  GDK_HAND1 (a right-pointing hand)

   --     * <inlinegraphic format="PNG" fileref="hand2.png"></inlinegraphic>

   --  GDK_HAND2 (a left-pointing hand)

   --     * <inlinegraphic format="PNG"

   --  fileref="left_side.png"></inlinegraphic> GDK_LEFT_SIDE (resize left

```
   --  side) 
```

   --     * <inlinegraphic format="PNG"

   --  fileref="right_side.png"></inlinegraphic> GDK_RIGHT_SIDE (resize right

```
   --  side) 
```

   --     * <inlinegraphic format="PNG"

   --  fileref="top_left_corner.png"></inlinegraphic> GDK_TOP_LEFT_CORNER

```
   --  (resize northwest corner) 
```

   --     * <inlinegraphic format="PNG"

   --  fileref="top_right_corner.png"></inlinegraphic> GDK_TOP_RIGHT_CORNER

```
   --  (resize northeast corner) 
```

   --     * <inlinegraphic format="PNG"

   --  fileref="bottom_left_corner.png"></inlinegraphic> GDK_BOTTOM_LEFT_CORNER

```
   --  (resize southwest corner) 
```

   --     * <inlinegraphic format="PNG"

   --  fileref="bottom_right_corner.png"></inlinegraphic>

   --  GDK_BOTTOM_RIGHT_CORNER (resize southeast corner)

   --     * <inlinegraphic format="PNG"

   --  fileref="top_side.png"></inlinegraphic> GDK_TOP_SIDE (resize top side)

   --     * <inlinegraphic format="PNG"

   --  fileref="bottom_side.png"></inlinegraphic> GDK_BOTTOM_SIDE (resize

```
   --  bottom side) 
```

   --     * <inlinegraphic format="PNG"

   --  fileref="sb_h_double_arrow.png"></inlinegraphic> GDK_SB_H_DOUBLE_ARROW

```
   --  (move vertical splitter) 
```

   --     * <inlinegraphic format="PNG"

   --  fileref="sb_v_double_arrow.png"></inlinegraphic> GDK_SB_V_DOUBLE_ARROW

```
   --  (move horizontal splitter) 
```

   --     * GDK_BLANK_CURSOR (Blank cursor). Since 2.16

```
   --  Since: gtk+ 2.2 
```

   --  "display": the Gdk.Display.Gdk_Display for which the cursor will be

```
   --  created 
```
```
   --  "cursor_type": cursor to create 
```
```
 
```

   function Gdk_Cursor_New_For_DisplayTo API doc
To body

      (Display     : not null access Gdk.Display.Gdk_Display_RecordTo API doc
To spec'Class;

       Cursor_TypeTo API doc
To body : Gdk_Cursor_TypeTo API doc
To spec) return Gdk_CursorTo API doc
To spec;

   --  Creates a new cursor from the set of builtin cursors. Some useful ones

```
   --  are: 
```

   --     * <inlinegraphic format="PNG"

   --  fileref="right_ptr.png"></inlinegraphic> GDK_RIGHT_PTR (right-facing

```
   --  arrow) 
```

   --     * <inlinegraphic format="PNG"

   --  fileref="crosshair.png"></inlinegraphic> GDK_CROSSHAIR (crosshair)

   --     * <inlinegraphic format="PNG" fileref="xterm.png"></inlinegraphic>

```
   --  GDK_XTERM (I-beam) 
```

   --     * <inlinegraphic format="PNG" fileref="watch.png"></inlinegraphic>

```
   --  GDK_WATCH (busy) 
```

   --     * <inlinegraphic format="PNG" fileref="fleur.png"></inlinegraphic>

```
   --  GDK_FLEUR (for moving objects) 
```

   --     * <inlinegraphic format="PNG" fileref="hand1.png"></inlinegraphic>

   --  GDK_HAND1 (a right-pointing hand)

   --     * <inlinegraphic format="PNG" fileref="hand2.png"></inlinegraphic>

   --  GDK_HAND2 (a left-pointing hand)

   --     * <inlinegraphic format="PNG"

   --  fileref="left_side.png"></inlinegraphic> GDK_LEFT_SIDE (resize left

```
   --  side) 
```

   --     * <inlinegraphic format="PNG"

   --  fileref="right_side.png"></inlinegraphic> GDK_RIGHT_SIDE (resize right

```
   --  side) 
```

   --     * <inlinegraphic format="PNG"

   --  fileref="top_left_corner.png"></inlinegraphic> GDK_TOP_LEFT_CORNER

```
   --  (resize northwest corner) 
```

   --     * <inlinegraphic format="PNG"

   --  fileref="top_right_corner.png"></inlinegraphic> GDK_TOP_RIGHT_CORNER

```
   --  (resize northeast corner) 
```

   --     * <inlinegraphic format="PNG"

   --  fileref="bottom_left_corner.png"></inlinegraphic> GDK_BOTTOM_LEFT_CORNER

```
   --  (resize southwest corner) 
```

   --     * <inlinegraphic format="PNG"

   --  fileref="bottom_right_corner.png"></inlinegraphic>

   --  GDK_BOTTOM_RIGHT_CORNER (resize southeast corner)

   --     * <inlinegraphic format="PNG"

   --  fileref="top_side.png"></inlinegraphic> GDK_TOP_SIDE (resize top side)

   --     * <inlinegraphic format="PNG"

   --  fileref="bottom_side.png"></inlinegraphic> GDK_BOTTOM_SIDE (resize

```
   --  bottom side) 
```

   --     * <inlinegraphic format="PNG"

   --  fileref="sb_h_double_arrow.png"></inlinegraphic> GDK_SB_H_DOUBLE_ARROW

```
   --  (move vertical splitter) 
```

   --     * <inlinegraphic format="PNG"

   --  fileref="sb_v_double_arrow.png"></inlinegraphic> GDK_SB_V_DOUBLE_ARROW

```
   --  (move horizontal splitter) 
```

   --     * GDK_BLANK_CURSOR (Blank cursor). Since 2.16

```
   --  Since: gtk+ 2.2 
```

   --  "display": the Gdk.Display.Gdk_Display for which the cursor will be

```
   --  created 
```
```
   --  "cursor_type": cursor to create 
```
```
 
```

   procedure Gdk_New_From_NameTo API doc
To body

      (Self    : out Gdk_CursorTo API doc
To spec;

       Display : not null access Gdk.Display.Gdk_Display_RecordTo API doc
To spec'Class;

       Name    : UTF8_StringTo API doc
To spec);

   --  Creates a new cursor by looking up Name in the current cursor theme.

```
   --  Since: gtk+ 2.8 
```

   --  "display": the Gdk.Display.Gdk_Display for which the cursor will be

```
   --  created 
```
```
   --  "name": the name of the cursor 
```
```
 
```

   function Gdk_Cursor_New_From_NameTo API doc
To body

      (Display : not null access Gdk.Display.Gdk_Display_RecordTo API doc
To spec'Class;

       Name    : UTF8_StringTo API doc
To spec) return Gdk_CursorTo API doc
To spec;

   --  Creates a new cursor by looking up Name in the current cursor theme.

```
   --  Since: gtk+ 2.8 
```

   --  "display": the Gdk.Display.Gdk_Display for which the cursor will be

```
   --  created 
```
```
   --  "name": the name of the cursor 
```
```
 
```

   function Get_TypeTo API doc
To body return Glib.GTypeTo API doc
To spec;

   pragma Import (C, Get_TypeTo API doc
To spec, "gdk_cursor_get_type");

```
 
```
```
   ------------- 
```
```
   -- Methods -- 
```
```
   ------------- 
```
```
 
```

   function Get_Cursor_TypeTo API doc
To body (Self : Gdk.Gdk_CursorTo API doc
To spec) return Gdk_Cursor_TypeTo API doc
To spec;

   pragma Import (C, Get_Cursor_TypeTo API doc
To spec, "gdk_cursor_get_cursor_type");

   --  Returns the cursor type for this cursor.

```
   --  Since: gtk+ 2.22 
```
```
 
```

   function Get_DisplayTo API doc
To body

      (Self : Gdk.Gdk_CursorTo API doc
To spec) return Gdk.Display.Gdk_DisplayTo API doc
To spec;

   --  Returns the display on which the Gdk.Gdk_Cursor is defined.

```
   --  Since: gtk+ 2.2 
```
```
 
```
```
   ---------------------- 
```
```
   -- GtkAda additions -- 
```
```
   ---------------------- 
```
```
 
```

   procedure RefTo API doc
To body (Self : Gdk.Gdk_CursorTo API doc
To spec);

   pragma Import (C, RefTo API doc
To spec, "g_object_ref");

```
 
```

   procedure UnrefTo API doc
To body (Self : Gdk.Gdk_CursorTo API doc
To spec);

   pragma Import (C, UnrefTo API doc
To spec, "g_object_unref");

```
 
```
```
   ---------------- 
```
```
   -- Properties -- 
```
```
   ---------------- 
```

   --  The following properties are defined for this widget. See

   --  Glib.Properties for more information on properties)

```
 
```

   Cursor_Type_Property : constant Glib.Properties.Property_BoxedTo API doc
To spec;

```
   --  Type: Cursor_Type 
```
```
 
```

   Display_Property : constant Glib.Properties.Property_BoxedTo API doc
To spec;

```
   --  Type: Display 
```
```
 
```
```
private 
```

   Display_PropertyTo API doc
To spec : constant Glib.Properties.Property_BoxedTo API doc
To spec :=

     Glib.Properties.BuildTo API doc
To spec
To body ("display");

   Cursor_Type_PropertyTo API doc
To spec : constant Glib.Properties.Property_BoxedTo API doc
To spec :=

     Glib.Properties.BuildTo API doc
To spec
To body ("cursor-type");

end Gdk.CursorTo API doc
To spec
To body;

Documentation