xref: /haiku/docs/user/interface/ChannelSlider.dox (revision c237c4ce593ee823d9867fd997e51e4c447f5623)
1/*
2 * Copyright 2019 Haiku, Inc. All rights reserved.
3 * Distributed under the terms of the MIT License.
4 *
5 * Authors:
6 *		Name, email@email.com
7 *
8 * Corresponds to:
9 *		headers/os/interface/ChannelSlider.h	hrev49977
10 *		src/kits/interface/ChannelSlider.cpp	hrev51468
11 */
12
13
14/*!
15	\file ChannelSlider.h
16	\ingroup interface
17	\brief Undocumented file.
18
19	\since Haiku R1
20*/
21
22
23/*!
24	\class BChannelSlider
25	\ingroup interface
26	\ingroup libbe
27	\brief Undocumented class.
28
29	\since Haiku R1
30*/
31
32
33/*!
34	\fn BChannelSlider::BChannelSlider(BRect area, const char *name, const char *label, BMessage *message, int32 channels=1, uint32 resizeMode=B_FOLLOW_LEFT_TOP, uint32 flags=B_WILL_DRAW)
35	\brief Undocumented public method
36
37	\param area Undocumented
38	\param name Undocumented
39	\param label Undocumented
40	\param message Undocumented
41	\param channels Undocumented
42	\param resizeMode Undocumented
43	\param flags Undocumented
44
45	\return Undocumented
46	\retval <value> Undocumented
47
48	\since Haiku R1
49*/
50
51
52/*!
53	\fn BChannelSlider::BChannelSlider(BRect area, const char *name, const char *label, BMessage *message, orientation orientation, int32 channels=1, uint32 resizeMode=B_FOLLOW_LEFT_TOP, uint32 flags=B_WILL_DRAW)
54	\brief Undocumented public method
55
56	\param area Undocumented
57	\param name Undocumented
58	\param label Undocumented
59	\param message Undocumented
60	\param orientation Undocumented
61	\param channels Undocumented
62	\param resizeMode Undocumented
63	\param flags Undocumented
64
65	\return Undocumented
66	\retval <value> Undocumented
67
68	\since Haiku R1
69*/
70
71
72/*!
73	\fn BChannelSlider::BChannelSlider(const char *name, const char *label, BMessage *message, orientation orientation, int32 channels=1, uint32 flags=B_WILL_DRAW)
74	\brief Undocumented public method
75
76	\param name Undocumented
77	\param label Undocumented
78	\param message Undocumented
79	\param orientation Undocumented
80	\param channels Undocumented
81	\param flags Undocumented
82
83	\return Undocumented
84	\retval <value> Undocumented
85
86	\since Haiku R1
87*/
88
89
90/*!
91	\fn BChannelSlider::BChannelSlider(BMessage *archive)
92	\brief Undocumented public method
93
94	\param archive Undocumented
95
96	\return Undocumented
97	\retval <value> Undocumented
98
99	\since Haiku R1
100*/
101
102
103/*!
104	\fn virtual virtual BChannelSlider::~BChannelSlider()
105	\brief Undocumented public method
106
107	\return Undocumented
108	\retval <value> Undocumented
109
110	\since Haiku R1
111*/
112
113
114/*!
115	\fn virtual virtual status_t BChannelSlider::Archive(BMessage *into, bool deep=true) const
116	\brief Undocumented public method
117
118	\param into Undocumented
119	\param deep Undocumented
120
121	\return Undocumented
122	\retval <value> Undocumented
123
124	\since Haiku R1
125*/
126
127
128/*!
129	\fn virtual virtual void BChannelSlider::AttachedToWindow()
130	\brief Undocumented public method
131
132	\since Haiku R1
133*/
134
135
136/*!
137	\fn virtual virtual void BChannelSlider::AllAttached()
138	\brief Undocumented public method
139
140	\since Haiku R1
141*/
142
143
144/*!
145	\fn virtual virtual void BChannelSlider::DetachedFromWindow()
146	\brief Undocumented public method
147
148	\since Haiku R1
149*/
150
151
152/*!
153	\fn virtual virtual void BChannelSlider::AllDetached()
154	\brief Undocumented public method
155
156	\since Haiku R1
157*/
158
159
160/*!
161	\fn virtual virtual void BChannelSlider::MessageReceived(BMessage *message)
162	\brief Undocumented public method
163
164	\param message Undocumented
165
166	\since Haiku R1
167*/
168
169
170/*!
171	\fn virtual virtual void BChannelSlider::Draw(BRect updateRect)
172	\brief Undocumented public method
173
174	\param updateRect Undocumented
175
176	\since Haiku R1
177*/
178
179
180/*!
181	\fn virtual virtual void BChannelSlider::MouseDown(BPoint where)
182	\brief Undocumented public method
183
184	\param where Undocumented
185
186	\since Haiku R1
187*/
188
189
190/*!
191	\fn virtual virtual void BChannelSlider::MouseUp(BPoint where)
192	\brief Undocumented public method
193
194	\param where Undocumented
195
196	\since Haiku R1
197*/
198
199
200/*!
201	\fn virtual virtual void BChannelSlider::MouseMoved(BPoint where, uint32 transit, const BMessage *dragMessage)
202	\brief Undocumented public method
203
204	\param where Undocumented
205	\param transit Undocumented
206	\param dragMessage Undocumented
207
208	\since Haiku R1
209*/
210
211
212/*!
213	\fn virtual virtual void BChannelSlider::WindowActivated(bool state)
214	\brief Undocumented public method
215
216	\param state Undocumented
217
218	\since Haiku R1
219*/
220
221
222/*!
223	\fn virtual virtual void BChannelSlider::KeyDown(const char *bytes, int32 numBytes)
224	\brief Undocumented public method
225
226	\param bytes Undocumented
227	\param numBytes Undocumented
228
229	\since Haiku R1
230*/
231
232
233/*!
234	\fn virtual virtual void BChannelSlider::KeyUp(const char *bytes, int32 numBytes)
235	\brief Undocumented public method
236
237	\param bytes Undocumented
238	\param numBytes Undocumented
239
240	\since Haiku R1
241*/
242
243
244/*!
245	\fn virtual virtual void BChannelSlider::FrameResized(float width, float height)
246	\brief Undocumented public method
247
248	\param width Undocumented
249	\param height Undocumented
250
251	\since Haiku R1
252*/
253
254
255/*!
256	\fn virtual virtual void BChannelSlider::SetFont(const BFont *font, uint32 mask=B_FONT_ALL)
257	\brief Undocumented public method
258
259	\param font Undocumented
260	\param mask Undocumented
261
262	\since Haiku R1
263*/
264
265
266/*!
267	\fn virtual virtual void BChannelSlider::MakeFocus(bool focusState=true)
268	\brief Undocumented public method
269
270	\param focusState Undocumented
271
272	\since Haiku R1
273*/
274
275
276/*!
277	\fn virtual virtual void BChannelSlider::GetPreferredSize(float *_width, float *_height)
278	\brief Undocumented public method
279
280	\param _width Undocumented
281	\param _height Undocumented
282
283	\since Haiku R1
284*/
285
286
287/*!
288	\fn virtual virtual BHandler* BChannelSlider::ResolveSpecifier(BMessage *message, int32 index, BMessage *specifier, int32 form, const char *property)
289	\brief Undocumented public method
290
291	\param message Undocumented
292	\param index Undocumented
293	\param specifier Undocumented
294	\param form Undocumented
295	\param property Undocumented
296
297	\return Undocumented
298	\retval <value> Undocumented
299
300	\since Haiku R1
301*/
302
303
304/*!
305	\fn virtual virtual status_t BChannelSlider::GetSupportedSuites(BMessage *data)
306	\brief Undocumented public method
307
308	\param data Undocumented
309
310	\return Undocumented
311	\retval <value> Undocumented
312
313	\since Haiku R1
314*/
315
316
317/*!
318	\fn virtual virtual void BChannelSlider::SetEnabled(bool on)
319	\brief Undocumented public method
320
321	\param on Undocumented
322
323	\since Haiku R1
324*/
325
326
327/*!
328	\fn virtual virtual orientation BChannelSlider::Orientation() const
329	\brief Undocumented public method
330
331	\return Undocumented
332	\retval <value> Undocumented
333
334	\since Haiku R1
335*/
336
337
338/*!
339	\fn void BChannelSlider::SetOrientation(orientation orientation)
340	\brief Undocumented public method
341
342	\param orientation Undocumented
343
344	\since Haiku R1
345*/
346
347
348/*!
349	\fn virtual virtual int32 BChannelSlider::MaxChannelCount() const
350	\brief Undocumented public method
351
352	\return Undocumented
353	\retval <value> Undocumented
354
355	\since Haiku R1
356*/
357
358
359/*!
360	\fn virtual virtual bool BChannelSlider::SupportsIndividualLimits() const
361	\brief Undocumented public method
362
363	\return Undocumented
364	\retval <value> Undocumented
365
366	\since Haiku R1
367*/
368
369
370/*!
371	\fn virtual virtual void BChannelSlider::DrawChannel(BView *into, int32 channel, BRect area, bool pressed)
372	\brief Undocumented public method
373
374	\param into Undocumented
375	\param channel Undocumented
376	\param area Undocumented
377	\param pressed Undocumented
378
379	\since Haiku R1
380*/
381
382
383/*!
384	\fn virtual virtual void BChannelSlider::DrawGroove(BView *into, int32 channel, BPoint leftTop, BPoint rightBottom)
385	\brief Undocumented public method
386
387	\param into Undocumented
388	\param channel Undocumented
389	\param leftTop Undocumented
390	\param rightBottom Undocumented
391
392	\since Haiku R1
393*/
394
395
396/*!
397	\fn virtual virtual void BChannelSlider::DrawThumb(BView *into, int32 channel, BPoint where, bool pressed)
398	\brief Undocumented public method
399
400	\param into Undocumented
401	\param channel Undocumented
402	\param where Undocumented
403	\param pressed Undocumented
404
405	\since Haiku R1
406*/
407
408
409/*!
410	\fn virtual virtual const BBitmap* BChannelSlider::ThumbFor(int32 channel, bool pressed)
411	\brief Undocumented public method
412
413	\param channel Undocumented
414	\param pressed Undocumented
415
416	\return Undocumented
417	\retval <value> Undocumented
418
419	\since Haiku R1
420*/
421
422
423/*!
424	\fn virtual virtual BRect BChannelSlider::ThumbFrameFor(int32 channel)
425	\brief Undocumented public method
426
427	\param channel Undocumented
428
429	\return Undocumented
430	\retval <value> Undocumented
431
432	\since Haiku R1
433*/
434
435
436/*!
437	\fn virtual virtual float BChannelSlider::ThumbDeltaFor(int32 channel)
438	\brief Undocumented public method
439
440	\param channel Undocumented
441
442	\return Undocumented
443	\retval <value> Undocumented
444
445	\since Haiku R1
446*/
447
448
449/*!
450	\fn virtual virtual float BChannelSlider::ThumbRangeFor(int32 channel)
451	\brief Undocumented public method
452
453	\param channel Undocumented
454
455	\return Undocumented
456	\retval <value> Undocumented
457
458	\since Haiku R1
459*/
460
461
462/*!
463	\fn static static BArchivable* BChannelSlider::Instantiate(BMessage *from)
464	\brief Undocumented public method
465
466	\param from Undocumented
467
468	\return Undocumented
469	\retval <value> Undocumented
470
471	\since Haiku R1
472*/
473