binfilter/inc/bf_svx/flditem.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: flditem.hxx,v $
  10  * $Revision: 1.11 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _SVX_FLDITEM_HXX
  31 #define _SVX_FLDITEM_HXX
  32
  33 #include <i18npool/lang.h>
  34 #include <tools/time.hxx>
  35 #include <tools/date.hxx>
  36 #include <tools/pstm.hxx>
  37 #include <bf_svtools/poolitem.hxx>
  38 #include <bf_svx/itemdata.hxx>
  39
  40 class MetaAction;
  41
  42 namespace binfilter {
  43 class SvNumberFormatter;
  44
  45 class SfxItemPool;
  46
  47 class SvxAddressItem;
  48
  49 // class SvxFieldItem ---------------------------------------------------
  50
  51 #ifdef ITEMID_FIELD
  52
  53 class SvxFieldData : public SvPersistBase
  54 {
  55 public:
  56                             SV_DECL_PERSIST1( SvxFieldData, SvPersistBase, 1 )
  57
  58                             SvxFieldData();
  59     virtual                             ~SvxFieldData();
  60
  61     virtual SvxFieldData*       Clone() const;
  62     virtual int                         operator==( const SvxFieldData& ) const;
  63
  64     virtual MetaAction* createBeginComment() const;
  65     virtual MetaAction* createEndComment() const;
  66 };
  67
  68 /*
  69 [Beschreibung]
  70 In diesem Item wird ein Feld (SvxFieldData) gespeichert.
  71 Das Feld gehoert dem Item.
  72 Das Feld selbst wird durch eine Ableitung von SvxFieldData bestimmt. (RTTI)
  73 */
  74
  75 class SvxFieldItem : public SfxPoolItem
  76 {
  77 private:
  78     SvxFieldData*                       pField;
  79
  80                     SvxFieldItem( SvxFieldData* pField, const USHORT nId );
  81
  82 public:
  83             TYPEINFO();
  84
  85             SvxFieldItem( const SvxFieldData& rField, const USHORT nId = ITEMID_FIELD );
  86             SvxFieldItem( const SvxFieldItem& rItem );
  87             ~SvxFieldItem();
  88
  89     virtual int                         operator==( const SfxPoolItem& ) const;
  90     virtual SfxPoolItem*        Clone( SfxItemPool *pPool = 0 ) const;
  91     virtual SfxPoolItem*        Create( SvStream&, USHORT nVer ) const;
  92     virtual SvStream&           Store( SvStream& , USHORT nItemVersion ) const;
  93
  94     const SvxFieldData*         GetField() const        { return pField; }
  95     static SvClassManager&      GetClassManager()       { return ITEMDATA()->GetClassManager(); }
  96 };
  97
  98 // =================================================================
  99 // Es folgen die Ableitungen von SvxFieldData...
 100 // =================================================================
 101
 102 #define SVX_DATEFIELD           2
 103 #define SVX_URLFIELD            3
 104
 105 #define SVX_PAGEFIELD           100             // Ex-Calc-Felder
 106 #define SVX_PAGESFIELD          101
 107 #define SVX_TIMEFIELD           102
 108 #define SVX_FILEFIELD           103
 109 #define SVX_TABLEFIELD          104
 110 #define SVX_EXT_TIMEFIELD       105
 111 #define SVX_EXT_FILEFIELD       106
 112 #define SVX_AUTHORFIELD         107
 113
 114 #define SVX_USERFIELD           200     // Ab hier eigene Felder, nicht im SVX
 115
 116 enum SvxDateType { SVXDATETYPE_FIX, SVXDATETYPE_VAR };
 117 enum SvxDateFormat {    SVXDATEFORMAT_APPDEFAULT,       // Wie in App eingestellt
 118                         SVXDATEFORMAT_SYSTEM,           // Wie im System eingestellt
 119                         SVXDATEFORMAT_STDSMALL,
 120                         SVXDATEFORMAT_STDBIG,
 121                         SVXDATEFORMAT_A,        // 13.02.96
 122                         SVXDATEFORMAT_B,        // 13.02.1996
 123                         SVXDATEFORMAT_C,        // 13.Feb 1996
 124                         SVXDATEFORMAT_D,        // 13.Februar 1996
 125                         SVXDATEFORMAT_E,        // Die, 13.Februar 1996
 126                         SVXDATEFORMAT_F         // Dienstag, 13.Februar 1996
 127                     };
 128
 129 class SvxDateField : public SvxFieldData
 130 {
 131     sal_uInt32                          nFixDate;
 132     SvxDateType                         eType;
 133     SvxDateFormat                       eFormat;
 134
 135 public:
 136                             SV_DECL_PERSIST1( SvxDateField, SvxFieldData, SVX_DATEFIELD )
 137
 138                             SvxDateField();
 139                             SvxDateField( const Date& rDate,
 140                                 SvxDateType eType = SVXDATETYPE_VAR,
 141                                 SvxDateFormat eFormat = SVXDATEFORMAT_STDSMALL );
 142
 143     sal_uInt32                          GetFixDate() const { return nFixDate; }
 144     void                                        SetFixDate( const Date& rDate ) { nFixDate = rDate.GetDate(); }
 145
 146     SvxDateType                         GetType() const { return eType; }
 147     void                                        SetType( SvxDateType eTp ) { eType = eTp; }
 148
 149     SvxDateFormat                       GetFormat() const { return eFormat; }
 150     void                                        SetFormat( SvxDateFormat eFmt ) { eFormat = eFmt; }
 151
 152                             // deprecated, to be removed
 153     String                                      GetFormatted( LanguageType eLanguage, LanguageType eFormat ) const;
 154                             // use this instead
 155
 156     virtual SvxFieldData*       Clone() const;
 157     virtual int                         operator==( const SvxFieldData& ) const;
 158
 159 };
 160
 161 enum SvxURLFormat       {       SVXURLFORMAT_APPDEFAULT,        // Wie in App eingestellt
 162                         SVXURLFORMAT_URL,                       // URL darstellen
 163                         SVXURLFORMAT_REPR                       // Repraesentation darstellen
 164                     };
 165
 166 class SvxURLField : public SvxFieldData
 167 {
 168 private:
 169     SvxURLFormat                        eFormat;
 170     XubString                           aURL;                           // URL-Adresse
 171     XubString                           aRepresentation;        // Was wird dargestellt
 172     XubString                           aTargetFrame;           // In welchem Frame
 173
 174 public:
 175                             SV_DECL_PERSIST1( SvxURLField, SvxFieldData, SVX_URLFIELD )
 176
 177                             SvxURLField();
 178                             SvxURLField( const XubString& rURL, const XubString& rRepres, SvxURLFormat eFmt = SVXURLFORMAT_URL );
 179
 180     const XubString&                    GetURL() const { return aURL; }
 181     void                                        SetURL( const XubString& rURL ) { aURL = rURL; }
 182
 183     const XubString&                    GetRepresentation() const { return aRepresentation; }
 184     void                                        SetRepresentation( const XubString& rRep ) { aRepresentation= rRep; }
 185
 186     const XubString&                    GetTargetFrame() const { return aTargetFrame; }
 187     void                                        SetTargetFrame( const XubString& rFrm ) { aTargetFrame = rFrm; }
 188
 189     SvxURLFormat                        GetFormat() const { return eFormat; }
 190     void                                        SetFormat( SvxURLFormat eFmt ) { eFormat = eFmt; }
 191
 192     virtual SvxFieldData*       Clone() const;
 193     virtual int                         operator==( const SvxFieldData& ) const;
 194
 195 };
 196
 197 class SvxPageField : public SvxFieldData
 198 {
 199 public:
 200                             SV_DECL_PERSIST1( SvxPageField, SvxFieldData, SVX_PAGEFIELD )
 201                             SvxPageField() {}
 202     virtual SvxFieldData*       Clone() const;
 203     virtual int                         operator==( const SvxFieldData& ) const;
 204
 205 };
 206
 207 class SvxPagesField : public SvxFieldData
 208 {
 209 public:
 210                             SV_DECL_PERSIST1( SvxPagesField, SvxFieldData, SVX_PAGESFIELD )
 211                             SvxPagesField() {}
 212     virtual SvxFieldData*       Clone() const;
 213     virtual int                         operator==( const SvxFieldData& ) const;
 214 };
 215
 216 class SvxTimeField : public SvxFieldData
 217 {
 218 public:
 219                             SV_DECL_PERSIST1( SvxTimeField, SvxFieldData, SVX_TIMEFIELD )
 220                             SvxTimeField() {}
 221     virtual SvxFieldData*       Clone() const;
 222     virtual int                         operator==( const SvxFieldData& ) const;
 223
 224 };
 225
 226 class SvxFileField : public SvxFieldData
 227 {
 228 public:
 229                             SV_DECL_PERSIST1( SvxFileField, SvxFieldData, SVX_FILEFIELD )
 230                             SvxFileField() {}
 231     virtual SvxFieldData*       Clone() const;
 232     virtual int                         operator==( const SvxFieldData& ) const;
 233 };
 234
 235 class SvxTableField : public SvxFieldData
 236 {
 237 public:
 238                             SV_DECL_PERSIST1( SvxTableField, SvxFieldData, SVX_TABLEFIELD )
 239                             SvxTableField() {}
 240     virtual SvxFieldData*       Clone() const;
 241     virtual int                         operator==( const SvxFieldData& ) const;
 242 };
 243
 244 enum SvxTimeType { SVXTIMETYPE_FIX, SVXTIMETYPE_VAR };
 245 enum SvxTimeFormat {    SVXTIMEFORMAT_APPDEFAULT,       // Wie in App eingestellt
 246                         SVXTIMEFORMAT_SYSTEM,           // Wie im System eingestellt
 247                         SVXTIMEFORMAT_STANDARD,
 248                         SVXTIMEFORMAT_24_HM,    // 13:49
 249                         SVXTIMEFORMAT_24_HMS,   // 13:49:38
 250                         SVXTIMEFORMAT_24_HMSH,  // 13:49:38.78
 251                         SVXTIMEFORMAT_12_HM,    // 01:49
 252                         SVXTIMEFORMAT_12_HMS,   // 01:49:38
 253                         SVXTIMEFORMAT_12_HMSH,  // 01:49:38.78
 254                         SVXTIMEFORMAT_AM_HM,    // 01:49 PM
 255                         SVXTIMEFORMAT_AM_HMS,   // 01:49:38 PM
 256                         SVXTIMEFORMAT_AM_HMSH   // 01:49:38.78 PM
 257                     };
 258
 259 class SvxExtTimeField : public SvxFieldData
 260 {
 261 private:
 262     sal_uInt32                          nFixTime;
 263     SvxTimeType                         eType;
 264     SvxTimeFormat                       eFormat;
 265
 266 public:
 267                             SV_DECL_PERSIST1( SvxExtTimeField, SvxFieldData, SVX_EXT_TIMEFIELD )
 268                             SvxExtTimeField();
 269                             SvxExtTimeField( const Time& rTime,
 270                                 SvxTimeType eType = SVXTIMETYPE_VAR,
 271                                 SvxTimeFormat eFormat = SVXTIMEFORMAT_STANDARD );
 272
 273     sal_uInt32                          GetFixTime() const { return nFixTime; }
 274     void                                        SetFixTime( const Time& rTime ) { nFixTime = rTime.GetTime(); }
 275
 276     SvxTimeType                         GetType() const { return eType; }
 277     void                                        SetType( SvxTimeType eTp ) { eType = eTp; }
 278
 279     SvxTimeFormat                       GetFormat() const { return eFormat; }
 280     void                                        SetFormat( SvxTimeFormat eFmt ) { eFormat = eFmt; }
 281
 282                              // use this instead
 283                              // If eLanguage==LANGUAGE_DONTKNOW the language/country
 284                              // used in number formatter initialization is taken.
 285      String                  GetFormatted( SvNumberFormatter& rFormatter,
 286                                  LanguageType eLanguage ) const;
 287
 288     virtual SvxFieldData*       Clone() const;
 289     virtual int                         operator==( const SvxFieldData& ) const;
 290
 291 };
 292
 293 enum SvxFileType { SVXFILETYPE_FIX, SVXFILETYPE_VAR };
 294 enum SvxFileFormat {    SVXFILEFORMAT_NAME_EXT, // Dateiname mit Extension
 295                         SVXFILEFORMAT_FULLPATH, // vollst„ndiger Pfad
 296                         SVXFILEFORMAT_PATH,             // nur Pfad
 297                         SVXFILEFORMAT_NAME              // nur Dateiname
 298                    };
 299
 300 class SvxExtFileField : public SvxFieldData
 301 {
 302 private:
 303     XubString                           aFile;
 304     SvxFileType                         eType;
 305     SvxFileFormat                       eFormat;
 306
 307 public:
 308                             SV_DECL_PERSIST1( SvxExtFileField, SvxFieldData, SVX_EXT_FILEFIELD )
 309                             SvxExtFileField();
 310                             SvxExtFileField( const XubString& rString,
 311                                 SvxFileType eType = SVXFILETYPE_VAR,
 312                                 SvxFileFormat eFormat = SVXFILEFORMAT_FULLPATH );
 313
 314     String                              GetFile() const { return aFile; }
 315     void                                        SetFile( const XubString& rString ) { aFile = rString; }
 316
 317     SvxFileType                         GetType() const { return eType; }
 318     void                                        SetType( SvxFileType eTp ) { eType = eTp; }
 319
 320     SvxFileFormat                       GetFormat() const { return eFormat; }
 321     void                                        SetFormat( SvxFileFormat eFmt ) { eFormat = eFmt; }
 322
 323     virtual SvxFieldData*       Clone() const;
 324     virtual int                         operator==( const SvxFieldData& ) const;
 325 };
 326
 327 enum SvxAuthorType { SVXAUTHORTYPE_FIX, SVXAUTHORTYPE_VAR };
 328 enum SvxAuthorFormat {  SVXAUTHORFORMAT_FULLNAME,       // vollst„ndiger Name
 329                         SVXAUTHORFORMAT_NAME,           // nur Nachname
 330                         SVXAUTHORFORMAT_FIRSTNAME,      // nur Vorname
 331                         SVXAUTHORFORMAT_SHORTNAME       // Initialen
 332                     };
 333
 334 class SvxAuthorField : public SvxFieldData
 335 {
 336 private:
 337     XubString           aName;
 338     XubString           aFirstName;
 339     XubString           aShortName;
 340     SvxAuthorType       eType;
 341     SvxAuthorFormat     eFormat;
 342
 343 public:
 344                             SV_DECL_PERSIST1( SvxAuthorField, SvxFieldData, SVX_AUTHORFIELD )
 345                             SvxAuthorField();
 346                             SvxAuthorField( const SvxAddressItem& rAdrItem,
 347                                 SvxAuthorType eType = SVXAUTHORTYPE_VAR,
 348                                 SvxAuthorFormat eFormat = SVXAUTHORFORMAT_FULLNAME );
 349
 350     XubString                           GetName() const { return aName; }
 351     void                                        SetName( const XubString& rString ) { aName = rString; }
 352
 353     XubString                           GetFirstName() const { return aFirstName; }
 354     void                                        SetFirstName( const XubString& rString ) { aFirstName = rString; }
 355
 356     XubString                           GetShortName() const { return aShortName; }
 357     void                                        SetShortName( const XubString& rString ) { aShortName = rString; }
 358
 359     SvxAuthorType                       GetType() const { return eType; }
 360     void                                        SetType( SvxAuthorType eTp ) { eType = eTp; }
 361
 362     SvxAuthorFormat                     GetFormat() const { return eFormat; }
 363     void                                        SetFormat( SvxAuthorFormat eFmt ) { eFormat = eFmt; }
 364
 365     XubString                           GetFormatted() const;
 366
 367     virtual SvxFieldData*       Clone() const;
 368     virtual int                         operator==( const SvxFieldData& ) const;
 369 };
 370
 371 #endif
 372
 373 }//end of namespace binfilter
 374 #endif
 375