sw/source/ui/inc/caption.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 _CAPTION_HXX
  20 #define _CAPTION_HXX
  21
  22 #include <tools/string.hxx>
  23 #include <tools/globname.hxx>
  24 #include <SwCapObjType.hxx>
  25 #include "swdllapi.h"
  26
  27 class SW_DLLPUBLIC InsCaptionOpt
  28 {
  29 private:
  30     sal_Bool            bUseCaption;
  31     SwCapObjType    eObjType;
  32     SvGlobalName    aOleId;
  33     String          sCategory;
  34     sal_uInt16          nNumType;
  35     OUString sNumberSeparator;
  36     String          sCaption;
  37     sal_uInt16          nPos;
  38     sal_uInt16          nLevel;
  39     String          sSeparator;
  40     String          sCharacterStyle;
  41
  42     bool         bIgnoreSeqOpts;    // is not being saved
  43     sal_Bool         bCopyAttributes;   //          -""-
  44
  45 public:
  46     InsCaptionOpt(const SwCapObjType eType = FRAME_CAP, const SvGlobalName* pOleId = 0);
  47     InsCaptionOpt(const InsCaptionOpt&);
  48     ~InsCaptionOpt();
  49
  50     inline sal_Bool&            UseCaption()                    { return bUseCaption; }
  51     inline sal_Bool             UseCaption() const              { return bUseCaption; }
  52
  53     inline SwCapObjType     GetObjType() const              { return eObjType; }
  54     inline void             SetObjType(const SwCapObjType eType) { eObjType = eType; }
  55
  56     inline const SvGlobalName&  GetOleId() const                { return aOleId; }
  57     inline void             SetOleId(const SvGlobalName &rId)   { aOleId = rId; }
  58
  59     inline const String&    GetCategory() const             { return sCategory; }
  60     inline void             SetCategory(const String& rCat) { sCategory = rCat; }
  61
  62     inline sal_uInt16           GetNumType() const              { return nNumType; }
  63     inline void             SetNumType(const sal_uInt16 nNT)    { nNumType = nNT; }
  64
  65     const OUString&  GetNumSeparator() const { return sNumberSeparator; }
  66     void                    SetNumSeparator(const OUString& rSet) {sNumberSeparator = rSet;}
  67
  68     inline const String&    GetCaption() const              { return sCaption; }
  69     inline void             SetCaption(const String& rCap)  { sCaption = rCap; }
  70
  71     inline sal_uInt16           GetPos() const                  { return nPos; }
  72     inline void             SetPos(const sal_uInt16 nP)         { nPos = nP; }
  73
  74     inline sal_uInt16           GetLevel() const                { return nLevel; }
  75     inline void             SetLevel(const sal_uInt16 nLvl)     { nLevel = nLvl; }
  76
  77     inline const String&    GetSeparator() const                { return sSeparator; }
  78     inline void             SetSeparator(const String& rSep)    { sSeparator = rSep; }
  79
  80     const String&           GetCharacterStyle() const { return sCharacterStyle; }
  81     void                    SetCharacterStyle(const String& rStyle)
  82                                     { sCharacterStyle = rStyle; }
  83
  84     inline bool&            IgnoreSeqOpts()                 { return bIgnoreSeqOpts; }
  85     inline bool             IgnoreSeqOpts() const           { return bIgnoreSeqOpts; }
  86
  87     inline sal_Bool&            CopyAttributes()                { return bCopyAttributes; }
  88     inline sal_Bool             CopyAttributes() const          { return bCopyAttributes; }
  89
  90     bool                    operator==( const InsCaptionOpt& rOpt ) const;
  91     InsCaptionOpt&          operator= ( const InsCaptionOpt& rOpt );
  92     inline bool             operator< ( const InsCaptionOpt & rObj ) const
  93                                                 { return aOleId < rObj.aOleId; }
  94 };
  95
  96 #endif
  97
  98
  99 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */