MWAWHeader.hxx Source File documentation

MWAWHeader.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#ifndef MWAW_HEADER_H
35#define MWAW_HEADER_H
40#include <vector>
41
42#include <librevenge-stream/librevenge-stream.h>
43
44#include <libmwaw/libmwaw.hxx>
45#include "MWAWInputStream.hxx"
46
56 class MWAWHeader
57{
58public:
59 typedef enum MWAWDocument::Type Type;
60 typedef enum MWAWDocument::Kind Kind;
61
62
69 explicit MWAWHeader(MWAWDocument::Type type=MWAWDocument::MWAW_T_UNKNOWN, int version=0,
70 MWAWDocument::Kind kind = MWAWDocument::MWAW_K_TEXT);
71 MWAWHeader(MWAWHeader const &)=default;
72 MWAWHeader &operator=(MWAWHeader const &)=default;
74 virtual ~MWAWHeader();
75
80 static std::vector<MWAWHeader> constructHeader
81 (MWAWInputStreamPtr input, std::shared_ptr<MWAWRSRCParser> rsrcParser);
82
84 void reset(MWAWDocument::Type type, int vers, Kind kind = MWAWDocument::MWAW_K_TEXT)
85 {
86 m_docType = type;
87 m_version = vers;
88 m_docKind = kind;
89 }
90
92 int getMajorVersion() const
93 {
94 return m_version;
95 }
97 void setMajorVersion(int version)
98 {
99 m_version=version;
100 }
101
103 Type getType() const
104 {
105 return m_docType;
106 }
108 void setType(Type type)
109 {
110 m_docType = type;
111 }
112
114 Kind getKind() const
115 {
116 return m_docKind;
117 }
119 void setKind(Kind kind)
120 {
121 m_docKind = kind;
122 }
123
124private:
126 int m_version;
128 Type m_docType;
130 Kind m_docKind;
131};
132
133#endif /* MWAWHEADER_H */
134// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWInputStream.hxx
MWAWDocument::Type
Type
an enum to define the different type of document
Definition: MWAWDocument.hxx:99
MWAWDocument::MWAW_T_UNKNOWN
@ MWAW_T_UNKNOWN
Unrecognised file type.
Definition: MWAWDocument.hxx:100
MWAWDocument::Kind
Kind
an enum to define the kind of document
Definition: MWAWDocument.hxx:80
MWAWDocument::MWAW_K_TEXT
@ MWAW_K_TEXT
word processing file
Definition: MWAWDocument.hxx:82
MWAWHeader
a function used by MWAWDocument to store the version of document
Definition: MWAWHeader.hxx:57
MWAWHeader::operator=
MWAWHeader & operator=(MWAWHeader const &)=default
MWAWHeader::setType
void setType(Type type)
sets the document type
Definition: MWAWHeader.hxx:108
MWAWHeader::setKind
void setKind(Kind kind)
sets the document kind
Definition: MWAWHeader.hxx:119
MWAWHeader::getType
Type getType() const
returns the document type
Definition: MWAWHeader.hxx:103
MWAWHeader::Kind
enum MWAWDocument::Kind Kind
Definition: MWAWHeader.hxx:60
MWAWHeader::MWAWHeader
MWAWHeader(MWAWHeader const &)=default
MWAWHeader::m_docKind
Kind m_docKind
the document kind
Definition: MWAWHeader.hxx:130
MWAWHeader::m_docType
Type m_docType
the document type
Definition: MWAWHeader.hxx:128
MWAWHeader::reset
void reset(MWAWDocument::Type type, int vers, Kind kind=MWAWDocument::MWAW_K_TEXT)
resets the data
Definition: MWAWHeader.hxx:84
MWAWHeader::m_version
int m_version
the document version
Definition: MWAWHeader.hxx:126
MWAWHeader::Type
enum MWAWDocument::Type Type
Definition: MWAWHeader.hxx:59
MWAWHeader::MWAWHeader
MWAWHeader(MWAWDocument::Type type=MWAWDocument::MWAW_T_UNKNOWN, int version=0, MWAWDocument::Kind kind=MWAWDocument::MWAW_K_TEXT)
constructor given the input
Definition: MWAWHeader.cxx:49
MWAWHeader::constructHeader
static std::vector< MWAWHeader > constructHeader(MWAWInputStreamPtr input, std::shared_ptr< MWAWRSRCParser > rsrcParser)
tests the input file and returns a header if the file looks like a MWAW document ( trying first to us...
Definition: MWAWHeader.cxx:64
MWAWHeader::~MWAWHeader
virtual ~MWAWHeader()
destructor
Definition: MWAWHeader.cxx:56
MWAWHeader::getMajorVersion
int getMajorVersion() const
returns the major version
Definition: MWAWHeader.hxx:92
MWAWHeader::setMajorVersion
void setMajorVersion(int version)
sets the major version
Definition: MWAWHeader.hxx:97
MWAWHeader::getKind
Kind getKind() const
returns the document kind
Definition: MWAWHeader.hxx:114
libmwaw.hxx
libmwaw API: main libmwaw interface header
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551