summaryrefslogtreecommitdiff
path: root/lotuswordpro/source/filter/xfilter/xfentry.hxx
blob: cc04bbb41efd5b723db04eab91ae98648f97b262 (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
/* -*- 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
 * index entry object.
 ************************************************************************/
#ifndef     _XFENTRY_HXX
#define     _XFENTRY_HXX

#include "xfcontent.hxx"

/**
 * @brief
 * Index entry object.
 */
class XFEntry : public XFContent
{
public:
    XFEntry();

public:
    /**
     * @descr   Set entry type.
     */
    void    SetEntryType(enumXFEntry type);

    /**
     * @descr   Set entry string value.
     */
    void    SetStringValue(const OUString& value);

    /**
     * @descr   Set display string.
     */
    void    SetStringDisplay(const OUString& display);

    /**
     * @descr   Set entry name.
     */
    void    SetEntryName(const OUString& name);

    /**
     * @descr   Set entry key. The keys is available only for enumXFEntryAlphabetical.
     */
    void    SetKey(const OUString& key1, const OUString& key2="");

    /**
     * @descr   Set whether it's a main entry. This is available only for enumXFEntryAlphabetical.
     */
    void    SetMainEntry(sal_Bool main);

    /**
     * @descr   Set outline level. This is available for enumXFEntryTOC and enumXFEntryUserIndex.
     */
    void    SetOutlineLevel(sal_Int32 level);

    virtual void    ToXml(IXFStream *pStrm) SAL_OVERRIDE;

private:
    enumXFEntry     m_eType;
    OUString   m_strValue;
    OUString   m_strDisplay;
    OUString   m_strKey1;
    OUString   m_strKey2;
    OUString   m_strName;
    sal_Bool        m_bMainEntry;
    sal_Int32       m_nOutlineLevel;
};

inline void XFEntry::SetEntryType(enumXFEntry type)
{
    m_eType = type;
}

inline void XFEntry::SetStringValue(const OUString& value)
{
    m_strValue = value;
}

inline void XFEntry::SetStringDisplay(const OUString& display)
{
    m_strDisplay = display;
}

inline void XFEntry::SetEntryName(const OUString& name)
{
    m_strName = name;
}

inline void XFEntry::SetKey(const OUString& key1, const OUString& key2)
{
    m_strKey1 = key1;
    m_strKey2 = key2;
}

inline void XFEntry::SetMainEntry(sal_Bool main)
{
    m_bMainEntry = main;
}

inline void XFEntry::SetOutlineLevel(sal_Int32 level)
{
    m_nOutlineLevel = level;
}

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