xref: /trunk/main/sw/source/ui/inc/caption.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 #ifndef _CAPTION_HXX
28 #define _CAPTION_HXX
29 
30 #include <tools/string.hxx>
31 //#ifndef _STREAM_HXX //autogen
32 //#include <tools/stream.hxx>
33 //#endif
34 #include <tools/globname.hxx>
35 #include <SwCapObjType.hxx>
36 #include "swdllapi.h"
37 
38 /*--------------------------------------------------------------------
39     Beschreibung:
40  --------------------------------------------------------------------*/
41 
42 class SW_DLLPUBLIC InsCaptionOpt
43 {
44 private:
45     sal_Bool            bUseCaption;
46     SwCapObjType    eObjType;
47     SvGlobalName    aOleId;
48     String          sCategory;
49     sal_uInt16          nNumType;
50     ::rtl::OUString sNumberSeparator;
51     String          sCaption;
52     sal_uInt16          nPos;
53     sal_uInt16          nLevel;
54 //  sal_Unicode     cSeparator;
55     String          sSeparator;
56     String          sCharacterStyle;
57 
58     sal_Bool         bIgnoreSeqOpts;    // wird nicht gespeichert
59     sal_Bool         bCopyAttributes;   //          -""-
60 
61 public:
62     InsCaptionOpt(const SwCapObjType eType = FRAME_CAP, const SvGlobalName* pOleId = 0);
63     InsCaptionOpt(const InsCaptionOpt&);
64     ~InsCaptionOpt();
65 
66     inline sal_Bool&            UseCaption()                    { return bUseCaption; }
67     inline sal_Bool             UseCaption() const              { return bUseCaption; }
68 
69     inline SwCapObjType     GetObjType() const              { return eObjType; }
70     inline void             SetObjType(const SwCapObjType eType) { eObjType = eType; }
71 
72     inline const SvGlobalName&  GetOleId() const                { return aOleId; }
73     inline void             SetOleId(const SvGlobalName &rId)   { aOleId = rId; }
74 
75     inline const String&    GetCategory() const             { return sCategory; }
76     inline void             SetCategory(const String& rCat) { sCategory = rCat; }
77 
78     inline sal_uInt16           GetNumType() const              { return nNumType; }
79     inline void             SetNumType(const sal_uInt16 nNT)    { nNumType = nNT; }
80 
81     const ::rtl::OUString&  GetNumSeparator() const { return sNumberSeparator; }
82     void                    SetNumSeparator(const ::rtl::OUString& rSet) {sNumberSeparator = rSet;}
83 
84     inline const String&    GetCaption() const              { return sCaption; }
85     inline void             SetCaption(const String& rCap)  { sCaption = rCap; }
86 
87     inline sal_uInt16           GetPos() const                  { return nPos; }
88     inline void             SetPos(const sal_uInt16 nP)         { nPos = nP; }
89 
90     inline sal_uInt16           GetLevel() const                { return nLevel; }
91     inline void             SetLevel(const sal_uInt16 nLvl)     { nLevel = nLvl; }
92 
93 //  inline sal_Unicode      GetSeparator() const                { return cSeparator; }
94 //  inline void             SetSeparator(const sal_Unicode cSep){ cSeparator = cSep; }
95     inline const String&    GetSeparator() const                { return sSeparator; }
96     inline void             SetSeparator(const String& rSep)    { sSeparator = rSep; }
97 
98     const String&           GetCharacterStyle() const { return sCharacterStyle; }
99     void                    SetCharacterStyle(const String& rStyle)
100                                     { sCharacterStyle = rStyle; }
101 
102     inline sal_Bool&            IgnoreSeqOpts()                 { return bIgnoreSeqOpts; }
103     inline sal_Bool             IgnoreSeqOpts() const           { return bIgnoreSeqOpts; }
104 
105     inline sal_Bool&            CopyAttributes()                { return bCopyAttributes; }
106     inline sal_Bool             CopyAttributes() const          { return bCopyAttributes; }
107 
108     sal_Bool                    operator==( const InsCaptionOpt& rOpt ) const;
109     InsCaptionOpt&          operator= ( const InsCaptionOpt& rOpt );
110     inline sal_Bool             operator< ( const InsCaptionOpt & rObj ) const
111                                                 { return aOleId < rObj.aOleId; }
112 //  friend SvStream&        operator>>( SvStream& rIStream, InsCaptionOpt& rCapOpt );
113 //  friend SvStream&        operator<<( SvStream& rOStream, const InsCaptionOpt& rCapOpt );
114 };
115 
116 #endif
117 
118 
119