Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*************************************************************************
3 : *
4 : * The Contents of this file are made available subject to the terms of
5 : * either of the following licenses
6 : *
7 : * - GNU Lesser General Public License Version 2.1
8 : * - Sun Industry Standards Source License Version 1.1
9 : *
10 : * Sun Microsystems Inc., October, 2000
11 : *
12 : * GNU Lesser General Public License Version 2.1
13 : * =============================================
14 : * Copyright 2000 by Sun Microsystems, Inc.
15 : * 901 San Antonio Road, Palo Alto, CA 94303, USA
16 : *
17 : * This library is free software; you can redistribute it and/or
18 : * modify it under the terms of the GNU Lesser General Public
19 : * License version 2.1, as published by the Free Software Foundation.
20 : *
21 : * This library is distributed in the hope that it will be useful,
22 : * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
24 : * Lesser General Public License for more details.
25 : *
26 : * You should have received a copy of the GNU Lesser General Public
27 : * License along with this library; if not, write to the Free Software
28 : * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
29 : * MA 02111-1307 USA
30 : *
31 : *
32 : * Sun Industry Standards Source License Version 1.1
33 : * =================================================
34 : * The contents of this file are subject to the Sun Industry Standards
35 : * Source License Version 1.1 (the "License"); You may not use this file
36 : * except in compliance with the License. You may obtain a copy of the
37 : * License at http://www.openoffice.org/license.html.
38 : *
39 : * Software provided under this License is provided on an "AS IS" basis,
40 : * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
41 : * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
42 : * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
43 : * See the License for the specific provisions governing your rights and
44 : * obligations concerning the Software.
45 : *
46 : * The Initial Developer of the Original Code is: IBM Corporation
47 : *
48 : * Copyright: 2008 by IBM Corporation
49 : *
50 : * All Rights Reserved.
51 : *
52 : * Contributor(s): _______________________________________
53 : *
54 : *
55 : ************************************************************************/
56 : /*************************************************************************
57 : * @file
58 : * index entry object.
59 : ************************************************************************/
60 : #ifndef _XFENTRY_HXX
61 : #define _XFENTRY_HXX
62 :
63 : #include "xfcontent.hxx"
64 :
65 : /**
66 : * @brief
67 : * Index entry obejct.
68 : */
69 0 : class XFEntry : public XFContent
70 : {
71 : public:
72 : XFEntry();
73 :
74 : public:
75 : /**
76 : * @descr Set entry type.
77 : */
78 : void SetEntryType(enumXFEntry type);
79 :
80 : /**
81 : * @descr Set entry string value.
82 : */
83 : void SetStringValue(const rtl::OUString& value);
84 :
85 : /**
86 : * @descr Set display string.
87 : */
88 : void SetStringDisplay(const rtl::OUString& display);
89 :
90 : /**
91 : * @descr Set entry name.
92 : */
93 : void SetEntryName(const rtl::OUString& name);
94 :
95 : /**
96 : * @descr Set entry key. The keys is available only for enumXFEntryAlphabetical.
97 : */
98 : void SetKey(const rtl::OUString& key1, const rtl::OUString& key2=A2OUSTR(""));
99 :
100 : /**
101 : * @descr Set whether it's a main entry. This is available only for enumXFEntryAlphabetical.
102 : */
103 : void SetMainEntry(sal_Bool main);
104 :
105 : /**
106 : * @descr Set outline level. This is available for enumXFEntryTOC and enumXFEntryUserIndex.
107 : */
108 : void SetOutlineLevel(sal_Int32 level);
109 :
110 : virtual void ToXml(IXFStream *pStrm);
111 :
112 : private:
113 : enumXFEntry m_eType;
114 : rtl::OUString m_strValue;
115 : rtl::OUString m_strDisplay;
116 : rtl::OUString m_strKey1;
117 : rtl::OUString m_strKey2;
118 : rtl::OUString m_strName;
119 : sal_Bool m_bMainEntry;
120 : sal_Int32 m_nOutlineLevel;
121 : };
122 :
123 0 : inline void XFEntry::SetEntryType(enumXFEntry type)
124 : {
125 0 : m_eType = type;
126 0 : }
127 :
128 0 : inline void XFEntry::SetStringValue(const rtl::OUString& value)
129 : {
130 0 : m_strValue = value;
131 0 : }
132 :
133 : inline void XFEntry::SetStringDisplay(const rtl::OUString& display)
134 : {
135 : m_strDisplay = display;
136 : }
137 :
138 : inline void XFEntry::SetEntryName(const rtl::OUString& name)
139 : {
140 : m_strName = name;
141 : }
142 :
143 0 : inline void XFEntry::SetKey(const rtl::OUString& key1, const rtl::OUString& key2/* =A2OUSTR */)
144 : {
145 0 : m_strKey1 = key1;
146 0 : m_strKey2 = key2;
147 0 : }
148 :
149 : inline void XFEntry::SetMainEntry(sal_Bool main)
150 : {
151 : m_bMainEntry = main;
152 : }
153 :
154 0 : inline void XFEntry::SetOutlineLevel(sal_Int32 level)
155 : {
156 0 : m_nOutlineLevel = level;
157 0 : }
158 :
159 : #endif
160 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|