summaryrefslogtreecommitdiff
path: root/lotuswordpro/source/filter/xfilter/xfindex.hxx
blob: 1f958d7ab51797c7d4261c96b5816393341f3931 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: IBM Corporation
 *
 *  Copyright: 2008 by IBM Corporation
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
/*************************************************************************
 * @file
 * Represente index source,index body and index index entry.
 ************************************************************************/
#ifndef INCLUDED_LOTUSWORDPRO_SOURCE_FILTER_XFILTER_XFINDEX_HXX
#define INCLUDED_LOTUSWORDPRO_SOURCE_FILTER_XFILTER_XFINDEX_HXX
#include <map>
#include <vector>

#include "xfcontent.hxx"
#include "xfcontentcontainer.hxx"
#include "xftabstop.hxx"

class XFIndex;
class XFIndexTemplate;
class XFParagraph;

/**
 * @brief
 * Index template.
 * When index update, the template is used to decide the index body.
 */
class XFIndexTemplate : public XFContent
{
public:
    XFIndexTemplate();

public:
    /**
     * @descr   Set template level.
     */
    void    SetLevel(const OUString& level);
    /**
     * @descr   Set style.
     */
    void    SetStyleName(const OUString& style) override;
    /**
     * @descr   Add a entry in the template.
     */
    void    AddEntry(enumXFIndexTemplate entry, const OUString& styleName);

    /**
     * @descr   Add a tab entry in the template.
     */
    void    AddTabEntry(enumXFTab type, double len, sal_Unicode leader, sal_Unicode delimiter, const OUString& styleName);

    /**
     * @descr   Add a entry in the template.
     */
    void    AddTextEntry(const OUString& sSpan, const OUString& styleName);

    virtual void    ToXml(IXFStream *pStrm) override;

private:
    /**
     * @descr   Helper function.
     */
    void    SetTagName(const OUString& tag);

    friend class XFIndex;
private:
    OUString   m_nLevel;
    OUString   m_strStyle;
    enumXFTab  m_eTabType;
    double     m_fTabLength;
    OUString   m_strTabDelimiter;
    OUString   m_strTabLeader;
    OUString   m_strTagName;
    typedef std::pair<enumXFIndexTemplate, OUString> TOCTEMPLATE_ENTRY_TYPE;
    std::vector<TOCTEMPLATE_ENTRY_TYPE> m_aEntries; // template entry + text style
    std::map<sal_uInt16, OUString> m_aTextEntries;
};

/**
 * @brief
 * Index, include index template, index body.
 */
class XFIndex : public XFContentContainer
{
public:
    XFIndex();

    virtual ~XFIndex();

public:
    /**
     * @descr   Set index type.
     */
    void    SetIndexType(enumXFIndex type);

    /**
     * @descr   Add index template entry.
     */
    void    AddTemplate(const OUString& level, const OUString& style, XFIndexTemplate* templ);

    /**
     * @descr   Set if protected index to prevent handy-revise.
     */
    void    SetProtected(bool protect);

    /**
     * @descr   Set separator.
     */
    void    SetSeparator(bool sep);

    virtual void ToXml(IXFStream *pStrm) override;

    void AddTocSource(sal_uInt16 nLevel, const OUString& sStyleName);

private:
    enumXFIndex     m_eType;
    OUString        m_strTitle;
    bool            m_bProtect;
    bool            m_bSeparator;
    XFParagraph*    m_pTitle;

    std::vector<XFIndexTemplate *>  m_aTemplates; // template entry + style

    #define MAX_TOC_LEVEL 10
    std::vector<OUString> m_aTOCSource[MAX_TOC_LEVEL+1];
};

inline XFIndexTemplate::XFIndexTemplate()
    : m_eTabType(enumXFTabNone)
    , m_fTabLength(0.0)
{
    m_nLevel = OUString::number(0);
}

inline void XFIndexTemplate::SetLevel(const OUString& level)
{
    m_nLevel = level;
}
inline void XFIndexTemplate::SetStyleName(const OUString& style)
{
    m_strStyle = style;
}

inline void XFIndexTemplate::SetTagName(const OUString& tag)
{
    m_strTagName = tag;
}

inline void XFIndexTemplate::AddEntry(enumXFIndexTemplate entry, const OUString& styleName)
{
    std::pair<enumXFIndexTemplate, OUString> pair(entry, styleName);
    m_aEntries.push_back(pair);
}

inline void XFIndexTemplate::AddTabEntry(enumXFTab type, double len, sal_Unicode leader, sal_Unicode delimiter, const OUString& styleName)
{
    m_eTabType = type;
    m_strTabLeader = OUString( leader );
    m_strTabDelimiter = OUString( delimiter );
    m_fTabLength = len;

    AddEntry(enumXFIndexTemplateTab, styleName);
}

inline void XFIndexTemplate::AddTextEntry(const OUString& sText, const OUString& styleName)
{
    sal_uInt16 nLen = m_aEntries.size();
    AddEntry(enumXFIndexTemplateSpan, styleName);

    m_aTextEntries[nLen] = sText;
}

inline void XFIndex::SetIndexType(enumXFIndex type)
{
    m_eType = type;
}

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */