2 define(`HTMLNAME',`terminal_interface-curses-mouse__ads.htm')dnl
4 ------------------------------------------------------------------------------
6 -- GNAT ncurses Binding --
8 -- Terminal_Interface.Curses.Mouse --
12 ------------------------------------------------------------------------------
13 -- Copyright (c) 1998-2014,2015 Free Software Foundation, Inc. --
15 -- Permission is hereby granted, free of charge, to any person obtaining a --
16 -- copy of this software and associated documentation files (the --
17 -- "Software"), to deal in the Software without restriction, including --
18 -- without limitation the rights to use, copy, modify, merge, publish, --
19 -- distribute, distribute with modifications, sublicense, and/or sell --
20 -- copies of the Software, and to permit persons to whom the Software is --
21 -- furnished to do so, subject to the following conditions: --
23 -- The above copyright notice and this permission notice shall be included --
24 -- in all copies or substantial portions of the Software. --
26 -- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS --
27 -- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF --
28 -- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. --
29 -- IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, --
30 -- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR --
31 -- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR --
32 -- THE USE OR OTHER DEALINGS IN THE SOFTWARE. --
34 -- Except as contained in this notice, the name(s) of the above copyright --
35 -- holders shall not be used in advertising or otherwise to promote the --
36 -- sale, use or other dealings in this Software without prior written --
38 ------------------------------------------------------------------------------
39 -- Author: Juergen Pfeifer, 1996
42 -- $Date: 2015/05/30 23:19:19 $
43 -- Binding Version 01.00
44 ------------------------------------------------------------------------------
47 package Terminal_Interface.Curses.Mouse is
48 pragma Preelaborate (Terminal_Interface.Curses.Mouse);
50 -- MANPAGE(`curs_mouse.3x')
51 -- mouse_trafo, wmouse_trafo are implemented as Transform_Coordinates
52 -- in the parent package.
55 -- REPORT_MOUSE_POSITION (i.e. as a parameter to Register_Reportable_Event
57 type Event_Mask is private;
58 No_Events : constant Event_Mask;
59 All_Events : constant Event_Mask;
61 type Mouse_Button is (Left, -- aka: Button 1
62 Middle, -- aka: Button 2
63 Right, -- aka: Button 3
64 Button4, -- aka: Button 4
65 Control, -- Control Key
69 subtype Real_Buttons is Mouse_Button range Left .. Button4;
70 subtype Modifier_Keys is Mouse_Button range Control .. Alt;
72 type Button_State is (Released,
78 type Button_States is array (Button_State) of Boolean;
79 pragma Pack (Button_States);
81 All_Clicks : constant Button_States := (Clicked .. Triple_Clicked => True,
83 All_States : constant Button_States := (others => True);
85 type Mouse_Event is private;
87 -- MANPAGE(`curs_mouse.3x')
89 function Has_Mouse return Boolean;
90 -- Return true if a mouse device is supported, false otherwise.
92 procedure Register_Reportable_Event
93 (Button : Mouse_Button;
95 Mask : in out Event_Mask);
96 -- Stores the event described by the button and the state in the mask.
97 -- Before you call this the first time, you should initialize the mask
98 -- with the Empty_Mask constant
99 pragma Inline (Register_Reportable_Event);
101 procedure Register_Reportable_Events
102 (Button : Mouse_Button;
103 State : Button_States;
104 Mask : in out Event_Mask);
105 -- Register all events described by the Button and the State bitmap.
106 -- Before you call this the first time, you should initialize the mask
107 -- with the Empty_Mask constant
109 -- ANCHOR(`mousemask()',`Start_Mouse')
110 -- There is one difference to mousmask(): we return the value of the
111 -- old mask, that means the event mask value before this call.
112 -- Not Implemented: The library version
113 -- returns a Mouse_Mask that tells which events are reported.
114 function Start_Mouse (Mask : Event_Mask := All_Events)
117 pragma Inline (Start_Mouse);
119 procedure End_Mouse (Mask : Event_Mask := No_Events);
120 -- Terminates the mouse, restores the specified event mask
121 pragma Inline (End_Mouse);
123 -- ANCHOR(`getmouse()',`Get_Mouse')
124 function Get_Mouse return Mouse_Event;
126 pragma Inline (Get_Mouse);
128 procedure Get_Event (Event : Mouse_Event;
129 Y : out Line_Position;
130 X : out Column_Position;
131 Button : out Mouse_Button;
132 State : out Button_State);
133 -- !!! Warning: X and Y are screen coordinates. Due to ripped of lines they
134 -- may not be identical to window coordinates.
135 -- Not Implemented: Get_Event only reports one event, the C library
136 -- version supports multiple events, e.g. {click-1, click-3}
137 pragma Inline (Get_Event);
139 -- ANCHOR(`ungetmouse()',`Unget_Mouse')
140 procedure Unget_Mouse (Event : Mouse_Event);
142 pragma Inline (Unget_Mouse);
144 -- ANCHOR(`wenclose()',`Enclosed_In_Window')
145 function Enclosed_In_Window (Win : Window := Standard_Window;
146 Event : Mouse_Event) return Boolean;
148 -- But : use event instead of screen coordinates.
149 pragma Inline (Enclosed_In_Window);
151 -- ANCHOR(`mouseinterval()',`Mouse_Interval')
152 function Mouse_Interval (Msec : Natural := 200) return Natural;
154 pragma Inline (Mouse_Interval);
157 -- This can be as little as 32 bits (unsigned), or as long as the system's
158 -- unsigned long. Declare it as the minimum size to handle all valid
160 type Event_Mask is mod 4294967296;
164 Id : Integer range Integer (Interfaces.C.short'First) ..
165 Integer (Interfaces.C.short'Last);
166 X, Y, Z : Integer range Integer (Interfaces.C.int'First) ..
167 Integer (Interfaces.C.int'Last);
170 pragma Convention (C, Mouse_Event);
174 Id at 0 range Curses_Constants.MEVENT_id_First
175 .. Curses_Constants.MEVENT_id_Last;
176 X at 0 range Curses_Constants.MEVENT_x_First
177 .. Curses_Constants.MEVENT_x_Last;
178 Y at 0 range Curses_Constants.MEVENT_y_First
179 .. Curses_Constants.MEVENT_y_Last;
180 Z at 0 range Curses_Constants.MEVENT_z_First
181 .. Curses_Constants.MEVENT_z_Last;
182 Bstate at 0 range Curses_Constants.MEVENT_bstate_First
183 .. Curses_Constants.MEVENT_bstate_Last;
185 for Mouse_Event'Size use Curses_Constants.MEVENT_Size;
186 Generation_Bit_Order : System.Bit_Order renames Curses_Constants.Bit_Order;
188 BUTTON_CTRL : constant Event_Mask := Curses_Constants.BUTTON_CTRL;
189 BUTTON_SHIFT : constant Event_Mask := Curses_Constants.BUTTON_SHIFT;
190 BUTTON_ALT : constant Event_Mask := Curses_Constants.BUTTON_ALT;
191 BUTTON1_EVENTS : constant Event_Mask
192 := Curses_Constants.all_events_button_1;
193 BUTTON2_EVENTS : constant Event_Mask
194 := Curses_Constants.all_events_button_2;
195 BUTTON3_EVENTS : constant Event_Mask
196 := Curses_Constants.all_events_button_3;
197 BUTTON4_EVENTS : constant Event_Mask
198 := Curses_Constants.all_events_button_4;
199 ALL_MOUSE_EVENTS : constant Event_Mask := Curses_Constants.ALL_MOUSE_EVENTS;
200 No_Events : constant Event_Mask := 0;
201 All_Events : constant Event_Mask := ALL_MOUSE_EVENTS;
203 end Terminal_Interface.Curses.Mouse;