STOFFHeader.hxx Source File documentation

STOFFHeader.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#ifndef STOFF_HEADER_H
35#define STOFF_HEADER_H
40#include <vector>
41
42#include <librevenge-stream/librevenge-stream.h>
43
44#include <libstaroffice/libstaroffice.hxx>
45#include "STOFFInputStream.hxx"
46
56 class STOFFHeader
57{
58public:
59 typedef enum STOFFDocument::Kind Kind;
60
66 STOFFHeader(int version=0, STOFFDocument::Kind kind = STOFFDocument::STOFF_K_TEXT);
68 virtual ~STOFFHeader();
69
74 static std::vector<STOFFHeader> constructHeader(STOFFInputStreamPtr input);
75
77 void reset(int vers, Kind kind = STOFFDocument::STOFF_K_TEXT)
78 {
79 m_version = vers;
80 m_docKind = kind;
81 }
82
84 int getVersion() const
85 {
86 return m_version;
87 }
89 void setVersion(int version)
90 {
91 m_version=version;
92 }
93
95 Kind getKind() const
96 {
97 return m_docKind;
98 }
100 void setKind(Kind kind)
101 {
102 m_docKind = kind;
103 }
105 bool isEncrypted() const
106 {
107 return m_isEncrypted;
108 }
110 void setEncrypted(bool encrypted)
111 {
112 m_isEncrypted=encrypted;
113 }
114private:
116 int m_version;
118 Kind m_docKind;
120 bool m_isEncrypted;
121};
122
123#endif /* STOFFHEADER_H */
124// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
STOFFInputStream.hxx
STOFFDocument::Kind
Kind
an enum to define the kind of document
Definition: STOFFDocument.hxx:66
STOFFDocument::STOFF_K_TEXT
@ STOFF_K_TEXT
word processing file
Definition: STOFFDocument.hxx:75
STOFFHeader
a function used by STOFFDocument to store the version of document
Definition: STOFFHeader.hxx:57
STOFFHeader::setEncrypted
void setEncrypted(bool encrypted)
set the encryption mode
Definition: STOFFHeader.hxx:110
STOFFHeader::m_isEncrypted
bool m_isEncrypted
flag to know if the file is encrypted
Definition: STOFFHeader.hxx:120
STOFFHeader::m_version
int m_version
the document version
Definition: STOFFHeader.hxx:116
STOFFHeader::getKind
Kind getKind() const
returns the document kind
Definition: STOFFHeader.hxx:95
STOFFHeader::reset
void reset(int vers, Kind kind=STOFFDocument::STOFF_K_TEXT)
resets the data
Definition: STOFFHeader.hxx:77
STOFFHeader::isEncrypted
bool isEncrypted() const
returns true if the file is encypted
Definition: STOFFHeader.hxx:105
STOFFHeader::setKind
void setKind(Kind kind)
sets the document kind
Definition: STOFFHeader.hxx:100
STOFFHeader::STOFFHeader
STOFFHeader(int version=0, STOFFDocument::Kind kind=STOFFDocument::STOFF_K_TEXT)
constructor given the input
Definition: STOFFHeader.cxx:48
STOFFHeader::Kind
enum STOFFDocument::Kind Kind
Definition: STOFFHeader.hxx:59
STOFFHeader::setVersion
void setVersion(int version)
sets the major version
Definition: STOFFHeader.hxx:89
STOFFHeader::m_docKind
Kind m_docKind
the document kind
Definition: STOFFHeader.hxx:118
STOFFHeader::constructHeader
static std::vector< STOFFHeader > constructHeader(STOFFInputStreamPtr input)
tests the input file and returns a header if the file looks like a STOFF document ( trying first to u...
Definition: STOFFHeader.cxx:62
STOFFHeader::~STOFFHeader
virtual ~STOFFHeader()
destructor
Definition: STOFFHeader.cxx:55
STOFFHeader::getVersion
int getVersion() const
returns the major version
Definition: STOFFHeader.hxx:84
libstaroffice.hxx
STOFFInputStreamPtr
std::shared_ptr< STOFFInputStream > STOFFInputStreamPtr
a smart pointer of STOFFInputStream
Definition: libstaroffice_internal.hxx:489