kig/objects/bogus_imp.h

   1 // Copyright (C)  2002  Dominique Devriese <devriese@kde.org>
   2
   3 // This program is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU General Public License
   5 // as published by the Free Software Foundation; either version 2
   6 // of the License, or (at your option) any later version.
   7
   8 // This program is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 // GNU General Public License for more details.
  12
  13 // You should have received a copy of the GNU General Public License
  14 // along with this program; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  16 // 02111-1307, USA.
  17
  18 #ifndef BOGUS_IMP_H
  19 #define BOGUS_IMP_H
  20
  21 #include "object_imp.h"
  22 #include "../misc/object_hierarchy.h"
  23 #include "../misc/kigtransform.h"
  24
  25 #include <qstring.h>
  26
  27 /**
  28  * This is the base class for the so-called BogusImp's.  These
  29  * ObjectImp's are not really ObjectImp's, in that they don't
  30  * represent objects.  They exist because ObjectImp's also serve
  31  * another purpose, namely containing data.  They can all be loaded
  32  * and saved, and the only difference between these objects and normal
  33  * objects are that these serve *only* to be loaded and saved.  This
  34  * approach adds a lot of flexibility to the Kig system, and has
  35  * certainly proven itself very valuable.
  36  */
  37 class BogusImp
  38   : public ObjectImp
  39 {
  40   typedef ObjectImp Parent;
  41 public:
  42   /**
  43    * Returns the ObjectImpType representing the BogusImp type.
  44    */
  45   static const ObjectImpType* stype();
  46
  47   Coordinate attachPoint( ) const;
  48   void draw( KigPainter& p ) const;
  49   bool contains( const Coordinate& p, int width, const KigWidget& w ) const;
  50   bool inRect( const Rect& r, int width, const KigWidget& w ) const;
  51   Rect surroundingRect() const;
  52
  53   ObjectImp* transform( const Transformation& ) const;
  54 };
  55
  56 /**
  57  * This ObjectImp represents an invalid object.  If a calculation
  58  * fails, then often an InvalidImp is returned, indicating that the
  59  * generated object is invalid.
  60  */
  61 class InvalidImp
  62   : public BogusImp
  63 {
  64 public:
  65   /**
  66    * Returns the ObjectImpType representing the InvalidImp type.
  67    */
  68   static const ObjectImpType* stype();
  69   typedef BogusImp Parent;
  70
  71   /**
  72    * Construct a new InvalidImp.
  73    */
  74   InvalidImp();
  75   InvalidImp* copy() const;
  76
  77   const ObjectImpType* type() const;
  78   void visit( ObjectImpVisitor* vtor ) const;
  79
  80   bool canFillInNextEscape() const;
  81   void fillInNextEscape( QString& s, const KigDocument& ) const;
  82
  83   bool equals( const ObjectImp& rhs ) const;
  84 };
  85
  86 /**
  87  * This ObjectImp is a BogusImp containing only a double value.
  88  */
  89 class DoubleImp
  90   : public BogusImp
  91 {
  92   double mdata;
  93 public:
  94   /**
  95    * Returns the ObjectImpType representing the DoubleImp type.
  96    */
  97   static const ObjectImpType* stype();
  98   typedef BogusImp Parent;
  99
 100   /**
 101    * Construct a new DoubleImp containing the value d.
 102    */
 103   DoubleImp( const double d );
 104
 105   /**
 106    * Get hold of the contained data.
 107    */
 108   double data() const { return mdata; };
 109   /**
 110    * Set the contained data to d.
 111    */
 112   void setData( double d ) { mdata = d; };
 113
 114   DoubleImp* copy() const;
 115
 116   const ObjectImpType* type() const;
 117   void visit( ObjectImpVisitor* vtor ) const;
 118
 119   bool canFillInNextEscape() const;
 120   void fillInNextEscape( QString& s, const KigDocument& ) const;
 121
 122   bool equals( const ObjectImp& rhs ) const;
 123 };
 124
 125 /**
 126  * This ObjectImp is a BogusImp containing only an int value.
 127  */
 128 class IntImp
 129   : public BogusImp
 130 {
 131   int mdata;
 132 public:
 133   /**
 134    * Returns the ObjectImpType representing the IntImp type..
 135    */
 136   static const ObjectImpType* stype();
 137   typedef BogusImp Parent;
 138
 139   /**
 140    * Construct a new IntImp containing the value d.
 141    */
 142   IntImp( const int d );
 143
 144   /**
 145    * Get hold of the contained data.
 146    */
 147   int data() const { return mdata; };
 148   /**
 149    * Set the contained data to d.
 150    */
 151   void setData( int d )  { mdata = d; }
 152
 153   IntImp* copy() const;
 154
 155   const ObjectImpType* type() const;
 156   void visit( ObjectImpVisitor* vtor ) const;
 157
 158   bool canFillInNextEscape() const;
 159   void fillInNextEscape( QString& s, const KigDocument& ) const;
 160
 161   bool equals( const ObjectImp& rhs ) const;
 162 };
 163
 164 /**
 165  * This ObjectImp is a BogusImp containing only a string value.
 166  */
 167 class StringImp
 168   : public BogusImp
 169 {
 170   QString mdata;
 171 public:
 172   /**
 173    * Returns the ObjectImpType representing the StringImp type..
 174    */
 175   static const ObjectImpType* stype();
 176   typedef BogusImp Parent;
 177
 178   /**
 179    * Construct a new StringImp containing the string d.
 180    */
 181   StringImp( const QString& d );
 182
 183   /**
 184    * Get hold of the contained data.
 185    */
 186   const QString& data() const { return mdata; };
 187   /**
 188    * Set the contained data.
 189    */
 190   void setData( const QString& s ) { mdata = s; }
 191
 192   StringImp* copy() const;
 193
 194   const ObjectImpType* type() const;
 195   void visit( ObjectImpVisitor* vtor ) const;
 196
 197   bool canFillInNextEscape() const;
 198   void fillInNextEscape( QString& s, const KigDocument& ) const;
 199
 200   bool equals( const ObjectImp& rhs ) const;
 201 };
 202
 203 class HierarchyImp
 204   : public BogusImp
 205 {
 206   ObjectHierarchy mdata;
 207 public:
 208   static const ObjectImpType* stype();
 209   typedef BogusImp Parent;
 210
 211   HierarchyImp( const ObjectHierarchy& h );
 212
 213   const ObjectHierarchy& data() const { return mdata; };
 214   void setData( const ObjectHierarchy& h ) { mdata = h; };
 215
 216   HierarchyImp* copy() const;
 217   const char* baseName() const;
 218
 219   const ObjectImpType* type() const;
 220   void visit( ObjectImpVisitor* vtor ) const;
 221
 222   bool equals( const ObjectImp& rhs ) const;
 223 };
 224
 225 /**
 226  * \internal Don't mistake this imp for something that draws a
 227  * transformed object.  It does something completely different.  It's
 228  * a pure data Imp, like DoubleImp and friends that serves only to
 229  * store the data of a transformation ( see the Transformation class
 230  * in ../misc/kigtransform.h
 231  */
 232 class TransformationImp
 233   : public BogusImp
 234 {
 235   Transformation mdata;
 236 public:
 237   static const ObjectImpType* stype();
 238   typedef BogusImp Parent;
 239
 240   TransformationImp( const Transformation& h );
 241
 242   const Transformation& data() const { return mdata; };
 243   void setData( const Transformation& h ) { mdata = h; };
 244
 245   TransformationImp* copy() const;
 246
 247   const ObjectImpType* type() const;
 248   void visit( ObjectImpVisitor* vtor ) const;
 249
 250   bool equals( const ObjectImp& rhs ) const;
 251 };
 252
 253 class TestResultImp
 254   : public BogusImp
 255 {
 256   const QString mdata;
 257 public:
 258   static const ObjectImpType* stype();
 259   typedef BogusImp Parent;
 260
 261   TestResultImp( const QString& s );
 262
 263   TestResultImp* copy() const;
 264
 265   const QString& data() const { return mdata; };
 266
 267   const ObjectImpType* type() const;
 268   void visit( ObjectImpVisitor* vtor ) const;
 269
 270   const uint numberOfProperties() const;
 271   const QCStringList properties() const;
 272   const QCStringList propertiesInternalNames() const;
 273   ObjectImp* property( uint which, const KigDocument& d ) const;
 274   const char* iconForProperty( uint which ) const;
 275   const ObjectImpType* impRequirementForProperty( uint which ) const;
 276   bool isPropertyDefinedOnOrThroughThisImp( uint which ) const;
 277
 278   bool equals( const ObjectImp& rhs ) const;
 279 };
 280
 281 #endif