SWFieldManager.hxx Source File documentation

SWFieldManager.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */
2
3/* libstaroffice
4* Version: MPL 2.0 / LGPLv2+
5*
6* The contents of this file are subject to the Mozilla Public License Version
7* 2.0 (the "License"); you may not use this file except in compliance with
8* the License or as specified alternatively below. You may obtain a copy of
9* the License at http://www.mozilla.org/MPL/
10*
11* Software distributed under the License is distributed on an "AS IS" basis,
12* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13* for the specific language governing rights and limitations under the
14* License.
15*
16* Major Contributor(s):
17* Copyright (C) 2002 William Lachance (wrlach@gmail.com)
18* Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
19* Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
20* Copyright (C) 2006, 2007 Andrew Ziem
21* Copyright (C) 2011, 2012 Alonso Laurent (alonso@loria.fr)
22*
23*
24* All Rights Reserved.
25*
26* For minor contributions see the git repository.
27*
28* Alternatively, the contents of this file may be used under the terms of
29* the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
30* in which case the provisions of the LGPLv2+ are applicable
31* instead of those above.
32*/
33
34/*
35 * FieldManager to read/parse SW StarOffice field
36 *
37 */
38#ifndef SW_FIELDMANAGER
39# define SW_FIELDMANAGER
40
41#include <vector>
42
43#include "STOFFDebug.hxx"
44#include "STOFFEntry.hxx"
45#include "STOFFInputStream.hxx"
46
47class StarState;
48
49namespace SWFieldManagerInternal
50{
53 struct Field {
55 Field()
56 : m_type(-1)
57 , m_subType(-1)
58 , m_format(-1)
59 , m_name("")
60 , m_content("")
61 , m_textValue("")
62 , m_doubleValue(0)
63 , m_level(0)
64 {
65 }
67 virtual ~Field();
69 friend std::ostream &operator<<(std::ostream &o, Field const &field)
70 {
71 field.print(o);
72 return o;
73 }
75 virtual bool send(STOFFListenerPtr &listener, StarState &state) const;
77 virtual void print(std::ostream &o) const;
79 int m_type;
81 int m_subType;
83 int m_format;
85 librevenge::RVNGString m_name;
87 librevenge::RVNGString m_content;
89 librevenge::RVNGString m_textValue;
91 double m_doubleValue;
93 int m_level;
94protected:
96 Field(const Field &) = default;
97};
98
99struct State;
100}
101
102class StarZone;
103
109 class SWFieldManager
110{
111public:
113 SWFieldManager();
115 virtual ~SWFieldManager();
116
117
119 std::shared_ptr<SWFieldManagerInternal::Field> readField(StarZone &zone, unsigned char cKind='_');
121 std::shared_ptr<SWFieldManagerInternal::Field> readPersistField(StarZone &zone, long lastPos);
122
123 //
124 // data
125 //
126private:
128 std::shared_ptr<SWFieldManagerInternal::State> m_state;
129};
130#endif
131// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
STOFFDebug.hxx
STOFFEntry.hxx
STOFFInputStream.hxx
SWFieldManager
the main class to read/.
Definition SWFieldManager.hxx:110
SWFieldManager::SWFieldManager
SWFieldManager()
constructor
Definition SWFieldManager.cxx:1016
SWFieldManager::~SWFieldManager
virtual ~SWFieldManager()
destructor
Definition SWFieldManager.cxx:1021
SWFieldManager::m_state
std::shared_ptr< SWFieldManagerInternal::State > m_state
the state
Definition SWFieldManager.hxx:128
SWFieldManager::readField
std::shared_ptr< SWFieldManagerInternal::Field > readField(StarZone &zone, unsigned char cKind='_')
try to read a field type
Definition SWFieldManager.cxx:1025
SWFieldManager::readPersistField
std::shared_ptr< SWFieldManagerInternal::Field > readPersistField(StarZone &zone, long lastPos)
try to read a persist field type
Definition SWFieldManager.cxx:1901
StarState
class to store an state: ie.
Definition StarState.hxx:68
StarZone
a zone in a StarOffice file
Definition StarZone.hxx:57
STOFFListenerPtr
std::shared_ptr< STOFFListener > STOFFListenerPtr
a smart pointer of STOFFListener
Definition libstaroffice_internal.hxx:491
SWFieldManagerInternal
Internal: the structures of a SWFieldManager.
Definition StarState.hxx:61
SWFieldManagerInternal::Field
Internal: a field.
Definition SWFieldManager.hxx:53
SWFieldManagerInternal::Field::Field
Field(const Field &)=default
copy constructor
SWFieldManagerInternal::Field::m_type
int m_type
the field type
Definition SWFieldManager.hxx:79
SWFieldManagerInternal::Field::send
virtual bool send(STOFFListenerPtr &listener, StarState &state) const
add to send the zone data
Definition SWFieldManager.cxx:110
SWFieldManagerInternal::Field::m_content
librevenge::RVNGString m_content
the content
Definition SWFieldManager.hxx:87
SWFieldManagerInternal::Field::m_doubleValue
double m_doubleValue
double
Definition SWFieldManager.hxx:91
SWFieldManagerInternal::Field::m_subType
int m_subType
the subtype
Definition SWFieldManager.hxx:81
SWFieldManagerInternal::Field::operator<<
friend std::ostream & operator<<(std::ostream &o, Field const &field)
operator<<
Definition SWFieldManager.hxx:69
SWFieldManagerInternal::Field::~Field
virtual ~Field()
destructor
Definition SWFieldManager.cxx:72
SWFieldManagerInternal::Field::m_level
int m_level
the chapter level
Definition SWFieldManager.hxx:93
SWFieldManagerInternal::Field::Field
Field()
constructor
Definition SWFieldManager.hxx:55
SWFieldManagerInternal::Field::m_textValue
librevenge::RVNGString m_textValue
the value text
Definition SWFieldManager.hxx:89
SWFieldManagerInternal::Field::print
virtual void print(std::ostream &o) const
print a field
Definition SWFieldManager.cxx:76
SWFieldManagerInternal::Field::m_name
librevenge::RVNGString m_name
the name
Definition SWFieldManager.hxx:85
SWFieldManagerInternal::Field::m_format
int m_format
the field format
Definition SWFieldManager.hxx:83
SWFieldManagerInternal::State
Internal: the state of a SWFieldManager.
Definition SWFieldManager.cxx:945