summaryrefslogtreecommitdiff
path: root/spec/fltk-widgets-groups-scrolls.ads
blob: 116fe428e23cf3a0e182ac8dd458897e86435cf6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200


--  Programmed by Jedidiah Barber
--  Released into the public domain


with

    FLTK.Widgets.Valuators.Sliders.Scrollbars;


package FLTK.Widgets.Groups.Scrolls is


    type Scroll is new Group with private;

    type Scroll_Reference (Data : not null access Scroll'Class) is limited null record
        with Implicit_Dereference => Data;

    type Scroll_Kind is
       (Horizontal,
        Vertical,
        Both,
        Always_On,
        Horizontal_Always,
        Vertical_Always,
        Both_Always);


    type Region is record
        X, Y, W, H : Integer;
    end record;

    type Scrollbar_Data is record
        X, Y, W, H      : Integer;
        Size, Total     : Natural;
        First, Position : Integer;
    end record;

    type Scroll_Info is record
        Child_Box           : Region;
        Inner_Inc, Inner_Ex : Region;
        H_Needed, V_Needed  : Boolean;
        H_Data, V_Data      : Scrollbar_Data;
        Scroll_Size         : Natural;
    end record;




    package Forge is

        function Create
               (X, Y, W, H : in Integer;
                Text       : in String := "")
            return Scroll;

        function Create
               (Parent     : in out Group'Class;
                X, Y, W, H : in     Integer;
                Text       : in     String := "")
            return Scroll;

    end Forge;




    --  Attributes  --

    function H_Bar
           (This : in out Scroll)
        return Valuators.Sliders.Scrollbars.Scrollbar_Reference;

    function V_Bar
           (This : in out Scroll)
        return Valuators.Sliders.Scrollbars.Scrollbar_Reference;




    --  Contents  --

    procedure Clear
           (This : in out Scroll);




    --  Scrolling  --

    procedure Scroll_To
           (This : in out Scroll;
            X, Y : in     Integer);

    --  These two functions are far too similar in name and
    --  function to the Get_X and Get_Y for Widgets.
    function Get_Scroll_X
           (This : in Scroll)
        return Integer;

    function Get_Scroll_Y
           (This : in Scroll)
        return Integer;




    --  Scrollbar Settings  --

    function Get_Scrollbar_Size
           (This : in Scroll)
        return Integer;

    procedure Set_Scrollbar_Size
           (This : in out Scroll;
            To   : in     Integer);

    function Get_Kind
           (This : in Scroll)
        return Scroll_Kind;

    procedure Set_Kind
           (This : in out Scroll;
            Mode : in     Scroll_Kind);




    --  Dimensions  --

    procedure Resize
           (This       : in out Scroll;
            X, Y, W, H : in     Integer);

    procedure Recalculate_Scrollbars
           (This : in     Scroll;
            Data :    out Scroll_Info);




    --  Drawing, Events  --

    procedure Bounding_Box
           (This       : in     Scroll;
            X, Y, W, H :    out Integer);

    procedure Draw
           (This : in out Scroll);

    function Handle
           (This  : in out Scroll;
            Event : in     Event_Kind)
        return Event_Outcome;


private


    type Scroll is new Group with record
        Horizon, Vertigo : aliased Valuators.Sliders.Scrollbars.Scrollbar;
    end record;

    overriding procedure Initialize
           (This : in out Scroll);

    overriding procedure Finalize
           (This : in out Scroll);

    procedure Extra_Init
           (This       : in out Scroll;
            X, Y, W, H : in     Integer;
            Text       : in     String);

    procedure Extra_Final
           (This : in out Scroll);


    pragma Inline (Clear);

    pragma Inline (Scroll_To);
    pragma Inline (Get_Scroll_X);
    pragma Inline (Get_Scroll_Y);

    pragma Inline (Get_Scrollbar_Size);
    pragma Inline (Set_Scrollbar_Size);
    pragma Inline (Get_Kind);
    pragma Inline (Set_Kind);

    pragma Inline (Resize);

    pragma Inline (Bounding_Box);
    pragma Inline (Draw);
    pragma Inline (Handle);


end FLTK.Widgets.Groups.Scrolls;