tbx  0.7.5
resscale.h
1 /*
2  * tbx RISC OS toolbox library
3  *
4  * Copyright (C) 2010 Alan Buckley All Rights Reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included
14  * in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24 
25 #ifndef TBX_RES_RESSCALE_H
26 #define TBX_RES_RESSCALE_H
27 
28 #include "resobject.h"
29 
30 namespace tbx {
31 namespace res {
32 
36 class ResScale : public ResObject
37 {
38 
39 public:
40  enum {CLASS_ID = 0x82c00 };
41 
48  ResScale(const ResObject &other) : ResObject(other)
49  {
50  check_class_id(CLASS_ID);
51  }
52 
58  ResScale(const ResScale &other) : ResObject(other)
59  {
60  }
61 
62  virtual ~ResScale() {}
63 
70  ResScale &operator=(const ResObject &other)
71  {
72  other.check_class_id(CLASS_ID);
73  ResBase::operator=(other);
74  return *this;
75  }
76 
82  ResScale &operator=(const ResScale &other)
83  {
84  ResBase::operator=(other);
85  return *this;
86  }
87 
95  ResScale(std::string name)
96  : ResObject(name, CLASS_ID, 100, 36+44)
97  {
98  min_val(10);
99  max_val(400);
100  step_size(1);
101  init_message(16,0); // title
102  init_string(24,0); // window
103  std1_value(33);
104  std2_value(80);
105  std3_value(100);
106  std4_value(120);
107  }
108 
115  unsigned int flags() const {return uint_value(0);}
116 
123  void flags(unsigned int value) {uint_value(0, value);}
129  bool generate_about_to_be_shown() const {return flag(0, 1<<0);}
135  void generate_about_to_be_shown(bool value) {flag(0,1<<0,value);}
141  bool generate_dialogue_completed() const {return flag(0, 1<<1);}
147  void generate_dialogue_completed(bool value) {flag(0,1<<1,value);}
153  bool has_scale_to_fit() const {return flag(0, 1<<2);}
159  void has_scale_to_fit(bool value) {flag(0,1<<2,value);}
160 
166  int min_val() const {return int_value(4);}
172  void min_val(int value) {int_value(4,value);}
178  int max_val() const {return int_value(8);}
184  void max_val(int value) {int_value(8,value);}
191  int step_size() const {return int_value(12);}
198  void step_size(int value) {int_value(12,value);}
204  const char *title() const {return message(16);}
212  void title(const char *value, int max_length = -1) {message_with_length(16, value, max_length);}
220  void title(const std::string &value, int max_length = -1) {message_with_length(16, value, max_length);}
224  int max_title() const {return int_value(20);}
231  const char *window() const {return string(24);}
238  void window(const char *value) {string(24, value);}
245  void window(const std::string &value) {string(24, value);}
251  int std1_value() const {return int_value(28);}
257  void std1_value(int value) {int_value(28,value);}
263  int std2_value() const {return int_value(32);}
269  void std2_value(int value) {int_value(32,value);}
275  int std3_value() const {return int_value(36);}
281  void std3_value(int value) {int_value(36,value);}
287  int std4_value() const {return int_value(40);}
293  void std4_value(int value) {int_value(40,value);}
294 };
295 
296 }
297 }
298 
299 #endif // TBX_RES_RESSCALE_H
void window(const char *value)
Set the name of the window template that provides the window for this object.
Definition: resscale.h:238
void title(const char *value, int max_length=-1)
Set the title of the dialogue.
Definition: resscale.h:212
void std2_value(int value)
Set the value of the second standard button.
Definition: resscale.h:269
A library for creating RISC OS toolbox applications.
Definition: abouttobeshownlistener.cc:34
void std1_value(int value)
Set the value of the first standard button.
Definition: resscale.h:257
void std4_value(int value)
Set the value of the fourth standard button.
Definition: resscale.h:293
void title(const std::string &value, int max_length=-1)
Set the title of the dialogue.
Definition: resscale.h:220
void init_string(int offset, const char *value)
Initialise a string in a constructor helper.
Definition: resbase.cc:1725
int std3_value() const
Get the value of the third standard button.
Definition: resscale.h:275
void message_with_length(int offset, const char *value, int length=-1)
Assign a message where the length is at offset+4.
Definition: resbase.cc:1639
bool flag(int offset, int mask) const
Check if any of the bits in a mask are set.
Definition: resbase.h:352
void generate_dialogue_completed(bool value)
Set if the dialogue completed event should be generated.
Definition: resscale.h:147
void flags(unsigned int value)
Set all flags as a word.
Definition: resscale.h:123
void step_size(int value)
Set the step size for incrementing/decrementing the scale.
Definition: resscale.h:198
unsigned int uint_value(int offset) const
Get an unsigned integer value.
Definition: resbase.h:324
int min_val() const
Get the minimum value for the scaling.
Definition: resscale.h:166
const char * window() const
Get the name of the window template that provides the window for this object.
Definition: resscale.h:231
void check_class_id(int class_id) const
Check if this objects class id is as specified.
Definition: resobject.cc:383
Classes to use/edit toolbox resources in memory.
int step_size() const
Get the step size for incrementing/decrementing the scale.
Definition: resscale.h:191
ResScale(const ResObject &other)
Construct a scale resource from a ResObject.
Definition: resscale.h:48
int max_val() const
Get the maximum value for the scaling.
Definition: resscale.h:178
void has_scale_to_fit(bool value)
Set if scale to fit option is included on the dialogue.
Definition: resscale.h:159
void std3_value(int value)
Set the value of the third standard button.
Definition: resscale.h:281
int int_value(int offset) const
Get an integer value.
Definition: resbase.h:316
void max_val(int value)
Set the maximum value for the scaling.
Definition: resscale.h:184
const char * string(int offset) const
Return a string at the given offset.
Definition: resbase.cc:1555
int std2_value() const
Get the value of the second standard button.
Definition: resscale.h:263
bool generate_about_to_be_shown() const
Check if the about to be shown event should be generated.
Definition: resscale.h:129
void min_val(int value)
Set the minimum value for the scaling.
Definition: resscale.h:172
int max_title() const
Get the maximum size the title can be.
Definition: resscale.h:224
const char * message(int offset) const
Get the message string at the given offset.
Definition: resbase.cc:1602
const char * name() const
Return pointer to name of object.
Definition: resobject.h:79
unsigned int flags() const
Get all flags as a word raw access.
Definition: resscale.h:115
void generate_about_to_be_shown(bool value)
Set if the about to be shown event should be generated.
Definition: resscale.h:135
ResScale(const ResScale &other)
Construct a scale resource by copying another.
Definition: resscale.h:58
ResBase & operator=(const ResBase &other)
Assignment.
Definition: resbase.cc:1534
Base class for a resource object that can be edited.
Definition: resobject.h:52
ResScale & operator=(const ResObject &other)
Assign from a ResObject.
Definition: resscale.h:70
void window(const std::string &value)
Set the name of the window template that provides the window for this object.
Definition: resscale.h:245
ResScale(std::string name)
Construct a scale resource.
Definition: resscale.h:95
bool has_scale_to_fit() const
Check if scale to fit option is included on the dialogue.
Definition: resscale.h:153
int std1_value() const
Get the value of the first standard button.
Definition: resscale.h:251
bool generate_dialogue_completed() const
Check if the dialogue completed event should be generated.
Definition: resscale.h:141
int std4_value() const
Get the value of the fourth standard button.
Definition: resscale.h:287
const char * title() const
Get the title of the dialogue.
Definition: resscale.h:204
ResScale & operator=(const ResScale &other)
Assign from another scale resource.
Definition: resscale.h:82
Class for Scale object template.
Definition: resscale.h:36
void init_message(int offset, const char *value)
Initialise a message in a constructor helper.
Definition: resbase.cc:1736