include/editeng/flditem.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_EDITENG_FLDITEM_HXX
  20 #define INCLUDED_EDITENG_FLDITEM_HXX
  21
  22 #include <i18nlangtag/lang.h>
  23 #include <tools/time.hxx>
  24 #include <tools/date.hxx>
  25 #include <svl/poolitem.hxx>
  26 #include <tools/pstm.hxx>
  27 #include <editeng/editengdllapi.h>
  28
  29 #include <com/sun/star/text/textfield/Type.hpp>
  30
  31 namespace com { namespace sun { namespace star { namespace text {
  32
  33 class XTextContent;
  34
  35 }}}}
  36
  37 class SvNumberFormatter;
  38 class MetaAction;
  39
  40 // class SvxFieldItem ---------------------------------------------------
  41
  42
  43 class EDITENG_DLLPUBLIC SvxFieldData : public SvPersistBase
  44 {
  45 public:
  46     static const sal_Int32 UNKNOWN_FIELD;
  47
  48     static SvxFieldData* Create(const css::uno::Reference<css::text::XTextContent>& xContent);
  49
  50     SV_DECL_PERSIST1( SvxFieldData, css::text::textfield::Type::UNSPECIFIED)
  51
  52                             SvxFieldData();
  53     virtual                 ~SvxFieldData() override;
  54
  55     virtual SvxFieldData*   Clone() const;
  56     virtual bool            operator==( const SvxFieldData& ) const;
  57
  58     virtual MetaAction*     createBeginComment() const;
  59     static MetaAction*      createEndComment();
  60 };
  61
  62 /**
  63  * This item stores a field (SvxFieldData).  The field is controlled by or
  64  * belongs to the item.  The field itself is determined by a derivation from
  65  * SvxFieldData (RTTI)
  66  */
  67 class EDITENG_DLLPUBLIC SvxFieldItem : public SfxPoolItem
  68 {
  69 private:
  70     tools::SvRef<SvxFieldData>      mxField;
  71
  72     EDITENG_DLLPRIVATE SvxFieldItem( SvxFieldData* pField, const sal_uInt16 nId );
  73
  74 public:
  75             SvxFieldItem( const SvxFieldData& rField, const sal_uInt16 nId  );
  76             SvxFieldItem( const SvxFieldItem& rItem );
  77             virtual ~SvxFieldItem() override;
  78
  79     virtual bool            operator==( const SfxPoolItem& ) const override;
  80     virtual SfxPoolItem*    Clone( SfxItemPool *pPool = nullptr ) const override;
  81     virtual SfxPoolItem*    Create( SvStream&, sal_uInt16 nVer ) const override;
  82     virtual SvStream&       Store( SvStream& , sal_uInt16 nItemVersion ) const override;
  83
  84     const SvxFieldData*     GetField() const    { return mxField.get(); }
  85     static SvClassManager&  GetClassManager();
  86 };
  87
  88
  89 // The following are the derivatives of SvxFieldData ...
  90
  91
  92 enum class SvxDateType { Fix, Var };
  93 enum SvxDateFormat {    SVXDATEFORMAT_APPDEFAULT = 0,   // Set as in App
  94                         SVXDATEFORMAT_SYSTEM,       // Set as in System
  95                         SVXDATEFORMAT_STDSMALL,
  96                         SVXDATEFORMAT_STDBIG,
  97                         SVXDATEFORMAT_A,    // 13.02.96
  98                         SVXDATEFORMAT_B,    // 13.02.1996
  99                         SVXDATEFORMAT_C,    // 13.Feb 1996
 100                         SVXDATEFORMAT_D,    // 13.February 1996
 101                         SVXDATEFORMAT_E,    // Tue, 13.February 1996
 102                         SVXDATEFORMAT_F     // Tuesday, 13.February 1996
 103                     };
 104
 105 class EDITENG_DLLPUBLIC SvxDateField : public SvxFieldData
 106 {
 107     sal_Int32               nFixDate;
 108     SvxDateType             eType;
 109     SvxDateFormat           eFormat;
 110
 111 public:
 112     SV_DECL_PERSIST1( SvxDateField, css::text::textfield::Type::DATE )
 113
 114                             SvxDateField();
 115     explicit                SvxDateField( const Date& rDate,
 116                                 SvxDateType eType,
 117                                 SvxDateFormat eFormat = SVXDATEFORMAT_STDSMALL );
 118
 119     sal_Int32               GetFixDate() const { return nFixDate; }
 120     void                    SetFixDate( const Date& rDate ) { nFixDate = rDate.GetDate(); }
 121
 122     SvxDateType             GetType() const { return eType; }
 123     void                    SetType( SvxDateType eTp ) { eType = eTp; }
 124
 125     SvxDateFormat           GetFormat() const { return eFormat; }
 126     void                    SetFormat( SvxDateFormat eFmt ) { eFormat = eFmt; }
 127
 128                             // If eLanguage==LANGUAGE_DONTKNOW the language/country
 129                             // used in number formatter initialization is taken.
 130     OUString                GetFormatted( SvNumberFormatter& rFormatter, LanguageType eLanguage ) const;
 131     static OUString         GetFormatted( Date& rDate, SvxDateFormat eFormat, SvNumberFormatter& rFormatter, LanguageType eLanguage );
 132
 133     virtual SvxFieldData*   Clone() const override;
 134     virtual bool            operator==( const SvxFieldData& ) const override;
 135
 136     virtual MetaAction* createBeginComment() const override;
 137 };
 138
 139
 140 enum SvxURLFormat   {   SVXURLFORMAT_APPDEFAULT = 0,    // Set as in App
 141                         SVXURLFORMAT_URL,           // Represent URL
 142                         SVXURLFORMAT_REPR           // Constitute representation
 143                     };
 144
 145 class EDITENG_DLLPUBLIC SvxURLField : public SvxFieldData
 146 {
 147 private:
 148     SvxURLFormat            eFormat;
 149     OUString                aURL;               // URL-Address
 150     OUString                aRepresentation;    // What is shown
 151     OUString                aTargetFrame;       // In what Frame
 152
 153 public:
 154     SV_DECL_PERSIST1( SvxURLField, css::text::textfield::Type::URL )
 155
 156                             SvxURLField();
 157                             SvxURLField( const OUString& rURL, const OUString& rRepres, SvxURLFormat eFmt = SVXURLFORMAT_URL );
 158
 159     const OUString&         GetURL() const { return aURL; }
 160     void                    SetURL( const OUString& rURL ) { aURL = rURL; }
 161
 162     const OUString&         GetRepresentation() const { return aRepresentation; }
 163     void                    SetRepresentation( const OUString& rRep ) { aRepresentation= rRep; }
 164
 165     const OUString&         GetTargetFrame() const { return aTargetFrame; }
 166     void                    SetTargetFrame( const OUString& rFrm ) { aTargetFrame = rFrm; }
 167
 168     SvxURLFormat            GetFormat() const { return eFormat; }
 169     void                    SetFormat( SvxURLFormat eFmt ) { eFormat = eFmt; }
 170
 171     virtual SvxFieldData*   Clone() const override;
 172     virtual bool            operator==( const SvxFieldData& ) const override;
 173
 174     virtual MetaAction* createBeginComment() const override;
 175 };
 176
 177 class EDITENG_DLLPUBLIC SvxPageField final: public SvxFieldData
 178 {
 179 public:
 180     SV_DECL_PERSIST1( SvxPageField, css::text::textfield::Type::PAGE )
 181     SvxPageField();
 182
 183     virtual SvxFieldData*   Clone() const override;
 184     virtual bool            operator==( const SvxFieldData& ) const override;
 185
 186     virtual MetaAction* createBeginComment() const override;
 187 };
 188
 189 class EDITENG_DLLPUBLIC SvxPageTitleField final: public SvxFieldData
 190 {
 191 public:
 192     SV_DECL_PERSIST1( SvxPageTitleField, css::text::textfield::Type::PAGE_NAME )
 193     SvxPageTitleField();
 194
 195     virtual SvxFieldData*   Clone() const override;
 196     virtual bool            operator==( const SvxFieldData& ) const override;
 197
 198     virtual MetaAction* createBeginComment() const override;
 199 };
 200
 201 class EDITENG_DLLPUBLIC SvxPagesField final: public SvxFieldData
 202 {
 203 public:
 204     SV_DECL_PERSIST1( SvxPagesField, css::text::textfield::Type::PAGES )
 205     SvxPagesField();
 206
 207     virtual SvxFieldData*   Clone() const override;
 208     virtual bool            operator==( const SvxFieldData& ) const override;
 209 };
 210
 211 class EDITENG_DLLPUBLIC SvxTimeField final: public SvxFieldData
 212 {
 213 public:
 214     SV_DECL_PERSIST1( SvxTimeField, css::text::textfield::Type::TIME )
 215     SvxTimeField();
 216
 217     virtual SvxFieldData*   Clone() const override;
 218     virtual bool            operator==( const SvxFieldData& ) const override;
 219
 220     virtual MetaAction* createBeginComment() const override;
 221 };
 222
 223 class EDITENG_DLLPUBLIC SvxFileField final: public SvxFieldData
 224 {
 225 public:
 226     SV_DECL_PERSIST1( SvxFileField, css::text::textfield::Type::DOCINFO_TITLE )
 227     SvxFileField();
 228
 229     virtual SvxFieldData*   Clone() const override;
 230     virtual bool            operator==( const SvxFieldData& ) const override;
 231 };
 232
 233 class EDITENG_DLLPUBLIC SvxTableField final: public SvxFieldData
 234 {
 235     int mnTab;
 236 public:
 237     SV_DECL_PERSIST1( SvxTableField, css::text::textfield::Type::TABLE )
 238     SvxTableField();
 239     explicit SvxTableField(int nTab);
 240
 241     void SetTab(int nTab);
 242     int GetTab() const { return mnTab;}
 243
 244     virtual SvxFieldData*   Clone() const override;
 245     virtual bool            operator==( const SvxFieldData& ) const override;
 246 };
 247
 248
 249 enum SvxTimeType { SVXTIMETYPE_FIX, SVXTIMETYPE_VAR };
 250 enum SvxTimeFormat {    SVXTIMEFORMAT_APPDEFAULT = 0,   // Set as in App
 251                         SVXTIMEFORMAT_SYSTEM,       // Set as in System
 252                         SVXTIMEFORMAT_STANDARD,
 253                         SVXTIMEFORMAT_24_HM,    // 13:49
 254                         SVXTIMEFORMAT_24_HMS,   // 13:49:38
 255                         SVXTIMEFORMAT_24_HMSH,  // 13:49:38.78
 256                         SVXTIMEFORMAT_12_HM,    // 01:49
 257                         SVXTIMEFORMAT_12_HMS,   // 01:49:38
 258                         SVXTIMEFORMAT_12_HMSH,  // 01:49:38.78
 259                         SVXTIMEFORMAT_AM_HM,    // 01:49 PM
 260                         SVXTIMEFORMAT_AM_HMS,   // 01:49:38 PM
 261                         SVXTIMEFORMAT_AM_HMSH   // 01:49:38.78 PM
 262                     };
 263
 264 class EDITENG_DLLPUBLIC SvxExtTimeField : public SvxFieldData
 265 {
 266 private:
 267     sal_Int64               m_nFixTime;
 268     SvxTimeType             eType;
 269     SvxTimeFormat           eFormat;
 270
 271 public:
 272     SV_DECL_PERSIST1( SvxExtTimeField, css::text::textfield::Type::EXTENDED_TIME )
 273                             SvxExtTimeField();
 274     explicit                SvxExtTimeField( const tools::Time& rTime,
 275                                 SvxTimeType eType,
 276                                 SvxTimeFormat eFormat = SVXTIMEFORMAT_STANDARD );
 277
 278     sal_Int64               GetFixTime() const { return m_nFixTime; }
 279     void                    SetFixTime( const tools::Time& rTime ) { m_nFixTime = rTime.GetTime(); }
 280
 281     SvxTimeType             GetType() const { return eType; }
 282     void                    SetType( SvxTimeType eTp ) { eType = eTp; }
 283
 284     SvxTimeFormat           GetFormat() const { return eFormat; }
 285     void                    SetFormat( SvxTimeFormat eFmt ) { eFormat = eFmt; }
 286
 287                             // If eLanguage==LANGUAGE_DONTKNOW the language/country
 288                             // used in number formatter initialization is taken.
 289     OUString                GetFormatted( SvNumberFormatter& rFormatter, LanguageType eLanguage ) const;
 290     static OUString         GetFormatted( tools::Time& rTime, SvxTimeFormat eFormat, SvNumberFormatter& rFormatter, LanguageType eLanguage );
 291
 292     virtual SvxFieldData*   Clone() const override;
 293     virtual bool            operator==( const SvxFieldData& ) const override;
 294
 295     virtual MetaAction* createBeginComment() const override;
 296 };
 297
 298
 299 enum SvxFileType { SVXFILETYPE_FIX, SVXFILETYPE_VAR };
 300 enum SvxFileFormat {    SVXFILEFORMAT_NAME_EXT = 0, // File name with Extension
 301                         SVXFILEFORMAT_FULLPATH, // full path
 302                         SVXFILEFORMAT_PATH,     // only path
 303                         SVXFILEFORMAT_NAME      // only file name
 304                    };
 305
 306
 307 class EDITENG_DLLPUBLIC SvxExtFileField : public SvxFieldData
 308 {
 309 private:
 310     OUString           aFile;
 311     SvxFileType             eType;
 312     SvxFileFormat           eFormat;
 313
 314 public:
 315     SV_DECL_PERSIST1( SvxExtFileField, css::text::textfield::Type::EXTENDED_FILE )
 316                             SvxExtFileField();
 317     explicit                SvxExtFileField( const OUString& rString,
 318                                 SvxFileType eType = SVXFILETYPE_VAR,
 319                                 SvxFileFormat eFormat = SVXFILEFORMAT_FULLPATH );
 320
 321     const OUString&         GetFile() const { return aFile; }
 322     void                    SetFile( const OUString& rString ) { aFile = rString; }
 323
 324     SvxFileType             GetType() const { return eType; }
 325     void                    SetType( SvxFileType eTp ) { eType = eTp; }
 326
 327     SvxFileFormat           GetFormat() const { return eFormat; }
 328     void                    SetFormat( SvxFileFormat eFmt ) { eFormat = eFmt; }
 329
 330     OUString                GetFormatted() const;
 331
 332     virtual SvxFieldData*   Clone() const override;
 333     virtual bool            operator==( const SvxFieldData& ) const override;
 334 };
 335
 336
 337 enum SvxAuthorType { SVXAUTHORTYPE_FIX, SVXAUTHORTYPE_VAR };
 338 enum SvxAuthorFormat {  SVXAUTHORFORMAT_FULLNAME = 0, // full name
 339                         SVXAUTHORFORMAT_NAME,       // Only Last name
 340                         SVXAUTHORFORMAT_FIRSTNAME,  // Only first name
 341                         SVXAUTHORFORMAT_SHORTNAME   // Initials
 342                     };
 343
 344 class EDITENG_DLLPUBLIC SvxAuthorField : public SvxFieldData
 345 {
 346 private:
 347     OUString   aName;
 348     OUString   aFirstName;
 349     OUString   aShortName;
 350     SvxAuthorType   eType;
 351     SvxAuthorFormat eFormat;
 352
 353 public:
 354     SV_DECL_PERSIST1( SvxAuthorField, css::text::textfield::Type::AUTHOR )
 355                             SvxAuthorField();
 356                             SvxAuthorField(
 357                                 const OUString& rFirstName,
 358                                 const OUString& rLastName,
 359                                 const OUString& rShortName,
 360                                 SvxAuthorType eType = SVXAUTHORTYPE_VAR,
 361                                 SvxAuthorFormat eFormat = SVXAUTHORFORMAT_FULLNAME );
 362
 363     SvxAuthorType           GetType() const { return eType; }
 364     void                    SetType( SvxAuthorType eTp ) { eType = eTp; }
 365
 366     SvxAuthorFormat         GetFormat() const { return eFormat; }
 367     void                    SetFormat( SvxAuthorFormat eFmt ) { eFormat = eFmt; }
 368
 369     OUString                GetFormatted() const;
 370
 371     virtual SvxFieldData*   Clone() const override;
 372     virtual bool            operator==( const SvxFieldData& ) const override;
 373 };
 374
 375 /** this field is used as a placeholder for a header&footer in impress. The actual
 376     value is stored at the page */
 377 class EDITENG_DLLPUBLIC SvxHeaderField final: public SvxFieldData
 378 {
 379 public:
 380     SV_DECL_PERSIST1( SvxHeaderField, css::text::textfield::Type::PRESENTATION_HEADER )
 381     SvxHeaderField();
 382
 383     virtual SvxFieldData*   Clone() const override;
 384     virtual bool            operator==( const SvxFieldData& ) const override;
 385 };
 386
 387 /** this field is used as a placeholder for a header&footer in impress. The actual
 388     value is stored at the page */
 389 class EDITENG_DLLPUBLIC SvxFooterField final: public SvxFieldData
 390 {
 391 public:
 392     SV_DECL_PERSIST1( SvxFooterField, css::text::textfield::Type::PRESENTATION_FOOTER )
 393     SvxFooterField();
 394     virtual SvxFieldData*   Clone() const override;
 395     virtual bool            operator==( const SvxFieldData& ) const override;
 396 };
 397
 398 /** this field is used as a placeholder for a header&footer in impress. The actual
 399     value is stored at the page */
 400 class EDITENG_DLLPUBLIC SvxDateTimeField final: public SvxFieldData
 401 {
 402 public:
 403     SV_DECL_PERSIST1( SvxDateTimeField, css::text::textfield::Type::PRESENTATION_DATE_TIME )
 404     SvxDateTimeField();
 405
 406     static OUString    GetFormatted( Date& rDate, tools::Time& rTime, int eFormat, SvNumberFormatter& rFormatter, LanguageType eLanguage );
 407
 408     virtual SvxFieldData*   Clone() const override;
 409     virtual bool            operator==( const SvxFieldData& ) const override;
 410 };
 411
 412
 413 #endif
 414
 415 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */