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
|
/*
$Id: scrollbar.h,v 1.42 2001/12/28 00:17:00 mbn Exp $
------------------------------------------------------------------------
ClanLib, the platform independent game SDK.
This library is distributed under the GNU LIBRARY GENERAL PUBLIC LICENSE
version 2. See COPYING for details.
For a total list of contributers see CREDITS.
See http://www.clanlib.org
------------------------------------------------------------------------
*/
//! clanGUI="Controls"
//! header=gui.h
#ifndef header_scrollbar
#define header_scrollbar
#include "component.h"
class CL_Button;
class CL_ComponentOptions;
class CL_Rect;
class CL_ScrollBar_Generic;
//: ScrollBar component
class CL_ScrollBar : public CL_Component
{
//! Construction:
public:
//: ScrollBar Constructor
CL_ScrollBar(
CL_Component *parent,
CL_StyleManager *style = NULL);
//: ScrollBar Constructor
//- Orientation = false: Vertical scrollbar
//- Orientation = true: Hortizonal scrollbar
CL_ScrollBar(
const CL_Rect &pos,
int min,
int max,
bool orientation,
CL_Component *parent,
CL_StyleManager *style = NULL);
//: Creates a scrollbar, with range 0 to 100.
//- Orientation = false: Vertical scrollbar
//- Orientation = true: Hortizonal scrollbar
CL_ScrollBar(
const CL_Rect &pos,
bool orientation,
CL_Component *parent,
CL_StyleManager *style = NULL);
//: ScrollBar Destructor
virtual ~CL_ScrollBar();
//! Attributes:
public:
//: Returns the client area of the component.
CL_Component *get_client_area() const;
//: Returns the orientation of the scroll bar.
//- Return true if scrollbar is vertical, false otherwise.
bool is_vertical() const;
//: Returns true if tracking is enabled, or false if tracking is disabled.
//: Tracking is initially enabled. See set_tracking for more info on tracking.
bool is_tracking() const;
//: Returns the current min value.
int get_min_value() const;
//: Returns the current max value.
int get_max_value() const;
//: Returns the range (delta max-min).
int get_range() const;
//: Returns the current range control value.
int get_value() const;
//: Returns true if the user has clicked the mouse on the slider and is currently dragging it, or false if not.
bool is_dragging_slider() const;
//: Returns true if this is a fixed length slider, false otherwise.
bool is_fixed_length_slider() const;
//: Returns the scroll bar slider rectangle.
CL_Rect &get_slider_rect() const;
//: Returns the minimum size of the slider.
//: Only usable in variable-length sliders.
int get_min_slider_length() const;
//! Operations:
public:
//: Sets the length-mode of the slider.
//- If enable is true, the slider is constant in size. (See set_slider_length()).
//- If enable is false, the slider is resized automatically based on the range.
void set_fixed_length_mode(bool enabel = true);
//: Sets the current size of the slider.
//: Only usable in fixed-length sliders.
void set_slider_length(int length);
//: Sets the minimum size of the slider.
//: Only usable in variable-length sliders.
void set_min_slider_length(int length);
//: Sets the scroll bar orientation to vertical if enable is true, horizontal otherwise.
void set_vertical(bool enable = true);
//: Enables scroll bar tracking if enable is true, or disables tracking if enable is false.
//: <p>If tracking is enabled (the default), the scroll bar emits the
//: sig_value_changed() signal while the slider is being dragged. If tracking is
//: disabled, the scroll bar emits the sig_value_changed() only when the user
//: releases the mouse button after moving the slider.</p>
void set_tracking(bool enable = true);
//: Sets the range between min_value and max_value.
//: If max_value is smaller than min_value, max_value is set to min_value.
void set_range(int min_value, int max_value);
//: Sets the range to start from value.
//: If current maximum value is less than the minvalue, maxvalue is set to minvalue.
void set_min_value(int value);
//: Sets the range to end at value.
//: If current maximum value is less than the minvalue, maxvalue is set to minvalue.
void set_max_value(int value);
//: Sets the range controls value to value and forces it to be within the legal range.
void set_value(int value);
//: Increases current value with step.
void increase(int step = 1);
//: Decreases current value with step.
void decrease(int step = 1);
//! Signals:
public:
//: This signal is emitted when the scroll bar value has changed, with the new scroll bar value as an argument.
//: See set_tracking() for specifics on this signal.
CL_Signal_v1<int> &sig_value_changed();
//: This signal is emitted when the user presses the slider with the mouse.
CL_Signal_v0 &sig_slider_pressed();
//: This signal is emitted when the slider is moved by the user, with the new scroll bar value as an argument.
//: This signal is emitted even when tracking is turned off.
CL_Signal_v1<int> &sig_slider_moved();
//: This signal is emitted when the user releases the slider with the mouse.
CL_Signal_v0 &sig_slider_released();
//! Implementation:
private:
CL_ScrollBar(const CL_ScrollBar ©) : CL_Component(NULL, NULL) { return; } // disallow copy construction.
CL_ScrollBar_Generic *impl;
};
#endif
|
