tbx  0.7.5
resdcs.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_RESDCS_H
26 #define TBX_RES_RESDCS_H
27 
28 #include "resobject.h"
29 
30 namespace tbx {
31 namespace res {
32 
36 class ResDCS : public ResObject
37 {
38 
39 public:
40  enum {CLASS_ID = 0x82a80 };
41 
48  ResDCS(const ResObject &other) : ResObject(other)
49  {
50  check_class_id(CLASS_ID);
51  }
52 
58  ResDCS(const ResDCS &other) : ResObject(other)
59  {
60  }
61 
62  virtual ~ResDCS() {}
63 
70  ResDCS &operator=(const ResObject &other)
71  {
72  other.check_class_id(CLASS_ID);
73  ResBase::operator=(other);
74  return *this;
75  }
76 
82  ResDCS &operator=(const ResDCS &other)
83  {
84  ResBase::operator=(other);
85  return *this;
86  }
87 
95  ResDCS(std::string name)
96  : ResObject(name, CLASS_ID, 100, 36 + 24)
97  {
98  init_message(4,0); // title
99  init_message(12,0); // message
100  init_string(20,0); // window
101  }
102 
111  int flags() const {return int_value(0);}
120  void flags(int value) {int_value(0,value);}
126  bool generate_about_to_be_shown() const {return flag(0, 1<<0);}
132  void generate_about_to_be_shown(bool value) {flag(0,1<<0,value);}
138  bool generate_dialogue_completed() const {return flag(0, 1<<1);}
144  void generate_dialogue_completed(bool value) {flag(0,1<<1,value);}
145 
151  const char *title() const {return message(4);}
159  void title(const char *value, int max_length = -1) {message_with_length(4, value, max_length);}
167  void title(const std::string &value, int max_length = -1) {message_with_length(4, value, max_length);}
171  int max_title() const {return int_value(8);}
177  const char *alternative_message() const {return message(12);}
185  void alternative_message(const char *value, int max_length = -1) {message_with_length(12, value, max_length);}
193  void alternative_message(const std::string &value, int max_length = -1) {message_with_length(12, value, max_length);}
197  int max_alternative_message() const {return int_value(16);}
204  const char *window() const {return string(20);}
211  void window(const char *value) {string(20, value);}
218  void window(const std::string &value) {string(20, value);}
219 
220 };
221 
222 }
223 }
224 
225 #endif // TBX_RES_RESDCS_H
226 
int max_alternative_message() const
Get the maximum size the alternative title can be.
Definition: resdcs.h:197
A library for creating RISC OS toolbox applications.
Definition: abouttobeshownlistener.cc:34
void init_string(int offset, const char *value)
Initialise a string in a constructor helper.
Definition: resbase.cc:1725
ResDCS(const ResDCS &other)
Construct a discard/cancel/save dialogue resource by copying another.
Definition: resdcs.h:58
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: resdcs.h:144
void window(const char *value)
Set the name of the window template that provides the window for this object.
Definition: resdcs.h:211
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 int_value(int offset) const
Get an integer value.
Definition: resbase.h:316
void title(const char *value, int max_length=-1)
Set the title of the dialogue.
Definition: resdcs.h:159
bool generate_about_to_be_shown() const
Check if the about to be shown event should be generated.
Definition: resdcs.h:126
const char * title() const
Get the title of the dialogue.
Definition: resdcs.h:151
const char * string(int offset) const
Return a string at the given offset.
Definition: resbase.cc:1555
ResDCS & operator=(const ResDCS &other)
Assign from another discard/cancel/save dialogue resource.
Definition: resdcs.h:82
const char * alternative_message() const
Get the alternative message to display in the DCS box.
Definition: resdcs.h:177
void window(const std::string &value)
Set the name of the window template that provides the window for this object.
Definition: resdcs.h:218
ResDCS(std::string name)
Construct a discard/cancel/save dialogue resource.
Definition: resdcs.h:95
Class for DCS object template.
Definition: resdcs.h:36
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
bool generate_dialogue_completed() const
Check if the dialogue completed event should be generated.
Definition: resdcs.h:138
void flags(int value)
Set all the flags.
Definition: resdcs.h:120
void generate_about_to_be_shown(bool value)
Set if the about to be shown event should be generated.
Definition: resdcs.h:132
ResBase & operator=(const ResBase &other)
Assignment.
Definition: resbase.cc:1534
void alternative_message(const std::string &value, int max_length=-1)
Set the alternative message to display in the DCS box.
Definition: resdcs.h:193
Base class for a resource object that can be edited.
Definition: resobject.h:52
ResDCS & operator=(const ResObject &other)
Assign from a ResObject.
Definition: resdcs.h:70
void title(const std::string &value, int max_length=-1)
Set the title of the dialogue.
Definition: resdcs.h:167
int flags() const
Raw access to all the object flags.
Definition: resdcs.h:111
void alternative_message(const char *value, int max_length=-1)
Set the alternative message to display in the DCS box.
Definition: resdcs.h:185
const char * window() const
Get the name of the window template that provides the window for this object.
Definition: resdcs.h:204
ResDCS(const ResObject &other)
Construct a discard/cancel/save dialogue resource from a ResObject.
Definition: resdcs.h:48
int max_title() const
Get the maximum size the title can be.
Definition: resdcs.h:171
void init_message(int offset, const char *value)
Initialise a message in a constructor helper.
Definition: resbase.cc:1736