tbx  0.7.5
resquit.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_RESQUIT_H
26 #define TBX_RES_RESQUIT_H
27 
28 #include "resobject.h"
29 
30 namespace tbx {
31 namespace res {
32 
36 class ResQuit : public ResObject
37 {
38 
39 public:
40  enum {CLASS_ID = 0x82a90 };
41 
48  ResQuit(const ResObject &other) : ResObject(other)
49  {
50  check_class_id(CLASS_ID);
51  }
52 
58  ResQuit(const ResQuit &other) : ResObject(other)
59  {
60  }
61 
62  virtual ~ResQuit() {}
63 
70  ResQuit &operator=(const ResObject &other)
71  {
72  other.check_class_id(CLASS_ID);
73  ResBase::operator=(other);
74  return *this;
75  }
76 
82  ResQuit &operator=(const ResQuit &other)
83  {
84  ResBase::operator=(other);
85  return *this;
86  }
87 
95  ResQuit(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 
109  unsigned int flags() const {return uint_value(0);}
110 
117  void flags(unsigned int value) {uint_value(0, value);}
123  bool generate_about_to_be_shown() const {return flag(0, 1<<0);}
129  void generate_about_to_be_shown(bool value) {flag(0,1<<0,value);}
135  bool generate_dialogue_completed() const {return flag(0, 1<<1);}
141  void generate_dialogue_completed(bool value) {flag(0,1<<1,value);}
142 
148  const char *title() const {return message(4);}
156  void title(const char *value, int max_length = -1) {message_with_length(4, value, max_length);}
164  void title(const std::string &value, int max_length = -1) {message_with_length(4, value, max_length);}
168  int max_title() const {return int_value(8);}
169 
175  const char *alternative_message() const {return message(12);}
183  void alternative_message(const char *value, int max_length = -1) {message_with_length(12, value, max_length);}
191  void alternative_message(const std::string &value, int max_length = -1) {message_with_length(12, value, max_length);}
195  int max_alternative_message() const {return int_value(16);}
202  const char *window() const {return string(20);}
209  void window(const char *value) {string(20, value);}
216  void window(const std::string &value) {string(20, value);}
217 
218 };
219 
220 }
221 }
222 
223 #endif // TBX_RES_RESQUIT_H
224 
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
unsigned int flags() const
Get all flags as a word raw access.
Definition: resquit.h:109
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_about_to_be_shown(bool value)
Set if the about to be shown event should be generated.
Definition: resquit.h:129
ResQuit & operator=(const ResObject &other)
Assign from a ResObject.
Definition: resquit.h:70
void title(const std::string &value, int max_length=-1)
Set the title of the dialogue.
Definition: resquit.h:164
ResQuit(const ResObject &other)
Construct a quit dialogue resource from a ResObject.
Definition: resquit.h:48
void window(const std::string &value)
Set the name of the window template that provides the window for this object.
Definition: resquit.h:216
void alternative_message(const char *value, int max_length=-1)
Set the alternative message to display in the dialogue.
Definition: resquit.h:183
unsigned int uint_value(int offset) const
Get an unsigned integer value.
Definition: resbase.h:324
void window(const char *value)
Set the name of the window template that provides the window for this object.
Definition: resquit.h:209
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.
void generate_dialogue_completed(bool value)
Set if the dialogue completed event should be generated.
Definition: resquit.h:141
int max_title() const
Get the maximum size the title can be.
Definition: resquit.h:168
ResQuit(std::string name)
Construct a quit dialogue resource.
Definition: resquit.h:95
const char * window() const
Get the name of the window template that provides the window for this object.
Definition: resquit.h:202
int int_value(int offset) const
Get an integer value.
Definition: resbase.h:316
void alternative_message(const std::string &value, int max_length=-1)
Set the alternative message to display in the dialogue.
Definition: resquit.h:191
void title(const char *value, int max_length=-1)
Set the title of the dialogue.
Definition: resquit.h:156
const char * string(int offset) const
Return a string at the given offset.
Definition: resbase.cc:1555
const char * title() const
Get the title of the dialogue.
Definition: resquit.h:148
ResQuit & operator=(const ResQuit &other)
Assign from another quit dialogue resource.
Definition: resquit.h:82
Class for Quit object template.
Definition: resquit.h:36
ResQuit(const ResQuit &other)
Construct a quit dialogue resource by copying another.
Definition: resquit.h:58
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
const char * alternative_message() const
Get the alternative message to display in the dialogue.
Definition: resquit.h:175
int max_alternative_message() const
Get the maximum length for the alternative message.
Definition: resquit.h:195
bool generate_about_to_be_shown() const
Check if the about to be shown event should be generated.
Definition: resquit.h:123
ResBase & operator=(const ResBase &other)
Assignment.
Definition: resbase.cc:1534
Base class for a resource object that can be edited.
Definition: resobject.h:52
bool generate_dialogue_completed() const
Check if the dialogue completed event should be generated.
Definition: resquit.h:135
void flags(unsigned int value)
Set all flags as a word.
Definition: resquit.h:117
void init_message(int offset, const char *value)
Initialise a message in a constructor helper.
Definition: resbase.cc:1736