MarinerWrtText.hxx Source File documentation

- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

MarinerWrtText.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 /* libmwaw
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 * Parser to Mariner Write text document
36 *
37 */
38 #ifndef MARINER_WRT_TEXT
39 # define MARINER_WRT_TEXT
40
41 #include "libmwaw_internal.hxx"
42 #include "MWAWDebug.hxx"
43
44 namespace MarinerWrtTextInternal
45 {
46 struct Paragraph;
47 struct State;
48 struct Table;
49 struct Zone;
50 }
51
52 struct MarinerWrtEntry;
53 class MarinerWrtParser;
54
60 class MarinerWrtText
61 {
62 friend class MarinerWrtParser;
63 public:
65 MarinerWrtText(MarinerWrtParser &parser);
67 virtual ~MarinerWrtText();
68
70 int version() const;
71
73 int numPages() const;
74
75 protected:
77 void setProperty(MarinerWrtTextInternal::Paragraph const &ruler);
78
80 void flushExtra();
81
82 //
83 // intermediate level
84 //
86 bool send(int zoneId);
88 bool send(MarinerWrtTextInternal::Zone const &zone, MWAWEntry const &entry);
89
91 bool findTableStructure(MarinerWrtTextInternal::Table &table, MWAWEntry const &entry);
93 bool sendTable(MarinerWrtTextInternal::Table &table);
95 bool readTextStruct(MarinerWrtEntry const &entry, int zoneId);
97 bool readZone(MarinerWrtEntry const &entry, int zoneId);
99 int computeNumPages(MarinerWrtTextInternal::Zone const &zone) const;
101 bool readFonts(MarinerWrtEntry const &entry, int zoneId);
102
104 bool readFontNames(MarinerWrtEntry const &entry, int zoneId);
105
107 bool readRulers(MarinerWrtEntry const &entry, int zoneId);
108
110 bool readPLCZone(MarinerWrtEntry const &entry, int zoneId);
111
113 bool readStyleNames(MarinerWrtEntry const &entry, int zoneId);
114
115 private:
116 MarinerWrtText(MarinerWrtText const &orig);
117 MarinerWrtText &operator=(MarinerWrtText const &orig);
118
119 protected:
120 //
121 // data
122 //
124 MWAWParserStatePtr m_parserState;
125
127 shared_ptr<MarinerWrtTextInternal::State> m_state;
128
130 MarinerWrtParser *m_mainParser;
131 };
132 #endif
133 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MarinerWrtTextInternal::Table
Internal: struct used to store the table of a MarinerWrtText.
Definition: MarinerWrtText.cxx:436
MarinerWrtTextInternal::Zone
Internal: struct used to store zone data of a MarinerWrtText.
Definition: MarinerWrtText.cxx:337
MarinerWrtText::readPLCZone
bool readPLCZone(MarinerWrtEntry const &entry, int zoneId)
try to read a PLC zone: position in text to char(zone 4) or ruler(zone 5) id
Definition: MarinerWrtText.cxx:1081
MarinerWrtText::operator=
MarinerWrtText & operator=(MarinerWrtText const &orig)
MarinerWrtText::send
bool send(int zoneId)
try to send a zone (knowing zoneId)
Definition: MarinerWrtText.cxx:730
MarinerWrtText::readFonts
bool readFonts(MarinerWrtEntry const &entry, int zoneId)
try to read a font zone
Definition: MarinerWrtText.cxx:1218
libmwaw_internal.hxx
MarinerWrtText::~MarinerWrtText
virtual ~MarinerWrtText()
destructor
Definition: MarinerWrtText.cxx:525
MarinerWrtParser
the main class to read a Mariner Write file
Definition: MarinerWrtParser.hxx:124
MarinerWrtText::numPages
int numPages() const
returns the number of pages
Definition: MarinerWrtText.cxx:536
MarinerWrtText::version
int version() const
returns the file version
Definition: MarinerWrtText.cxx:529
MarinerWrtText
the main class to read the text part of Mariner Write file
Definition: MarinerWrtText.hxx:60
MarinerWrtEntry
a entry to store a zone structure
Definition: MarinerWrtParser.hxx:62
MarinerWrtTextInternal
Internal: the structures of a MarinerWrtText.
Definition: MarinerWrtText.cxx:59
MarinerWrtText::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: MarinerWrtText.cxx:1992
MarinerWrtText::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: MarinerWrtText.hxx:124
MarinerWrtText::readRulers
bool readRulers(MarinerWrtEntry const &entry, int zoneId)
try to read a ruler zone
Definition: MarinerWrtText.cxx:1551
MarinerWrtText::sendTable
bool sendTable(MarinerWrtTextInternal::Table &table)
try to send a table
Definition: MarinerWrtText.cxx:951
MarinerWrtText::m_state
shared_ptr< MarinerWrtTextInternal::State > m_state
the state
Definition: MarinerWrtText.hxx:127
MarinerWrtText::readFontNames
bool readFontNames(MarinerWrtEntry const &entry, int zoneId)
try to read a font name zone
Definition: MarinerWrtText.cxx:1134
MarinerWrtText::findTableStructure
bool findTableStructure(MarinerWrtTextInternal::Table &table, MWAWEntry const &entry)
try to find the table structure beginning in actual position
Definition: MarinerWrtText.cxx:1006
MWAWDebug.hxx
MarinerWrtTextInternal::Paragraph
Internal: struct used to store the paragraph of a MarinerWrtText.
Definition: MarinerWrtText.cxx:93
MarinerWrtText::readStyleNames
bool readStyleNames(MarinerWrtEntry const &entry, int zoneId)
try to read a style name zone
Definition: MarinerWrtText.cxx:1482
MarinerWrtText::readTextStruct
bool readTextStruct(MarinerWrtEntry const &entry, int zoneId)
try to read the text struct
Definition: MarinerWrtText.cxx:624
MarinerWrtText::m_mainParser
MarinerWrtParser * m_mainParser
the main parser;
Definition: MarinerWrtText.hxx:130
MarinerWrtText::MarinerWrtText
MarinerWrtText(MarinerWrtParser &parser)
constructor
Definition: MarinerWrtText.cxx:520
MWAWParserStatePtr
shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:435
MarinerWrtText::computeNumPages
int computeNumPages(MarinerWrtTextInternal::Zone const &zone) const
try to compute the number of pages of a zone, returns 0 if not data
Definition: MarinerWrtText.cxx:603
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
MarinerWrtText::readZone
bool readZone(MarinerWrtEntry const &entry, int zoneId)
try to read a text zone
Definition: MarinerWrtText.cxx:558
MarinerWrtText::setProperty
void setProperty(MarinerWrtTextInternal::Paragraph const &ruler)
sends a paragraph property to the listener
Definition: MarinerWrtText.cxx:1545