RVNGDirectoryStream.h Source File documentation

- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

RVNGDirectoryStream.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
2 /* librevenge
3 * Version: MPL 2.0 / LGPLv2.1+
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * Major Contributor(s):
10 * Copyright (C) 2002-2005 William Lachance (wrlach@gmail.com)
11 * Copyright (C) 2002 Marc Maurer (uwog@uwog.net)
12 * Copyright (C) 2006 Fridrich Strba (fridrich.strba@bluewin.ch)
13 *
14 * For minor contributions see the git repository.
15 *
16 * Alternatively, the contents of this file may be used under the terms
17 * of the GNU Lesser General Public License Version 2.1 or later
18 * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
19 * applicable instead of those above.
20 */
21
22 #ifndef RVNGDIRECTORYSTREAM_H_INCLUDED
23 #define RVNGDIRECTORYSTREAM_H_INCLUDED
24
25 #include "librevenge-stream-api.h"
26
27 #include "RVNGStream.h"
28
29 namespace librevenge
30 {
31
32 struct RVNGDirectoryStreamImpl;
33
40 class REVENGE_STREAM_API RVNGDirectoryStream : public RVNGInputStream
41 {
42 // disable copying
43 RVNGDirectoryStream(const RVNGDirectoryStream &);
44 RVNGDirectoryStream &operator=(const RVNGDirectoryStream &);
45
46 public:
52 explicit RVNGDirectoryStream(const char *path);
53
54 virtual ~RVNGDirectoryStream();
55
63 static RVNGDirectoryStream *createForParent(const char *path);
64
69 static bool isDirectory(const char *path);
70
71 virtual bool isStructured();
72 virtual unsigned subStreamCount();
73 virtual const char *subStreamName(unsigned id);
74 virtual bool existsSubStream(const char *name);
75 virtual RVNGInputStream *getSubStreamByName(const char *name);
76 virtual RVNGInputStream *getSubStreamById(unsigned id);
77
78 virtual const unsigned char *read(unsigned long numBytes, unsigned long &numBytesRead);
79 virtual int seek(long offset, RVNG_SEEK_TYPE seekType);
80 virtual long tell();
81 virtual bool isEnd();
82
83 private:
84 RVNGDirectoryStreamImpl *m_impl;
85 };
86
87 }
88
89 #endif // RVNGDIRECTORYSTREAM_H_INCLUDED
90
91 /* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
librevenge::RVNGDirectoryStream::m_impl
RVNGDirectoryStreamImpl * m_impl
Definition: RVNGDirectoryStream.h:84
librevenge
Definition: RVNGBinaryData.cpp:38
REVENGE_STREAM_API
#define REVENGE_STREAM_API
Definition: librevenge-stream-api.h:34
offset
unsigned offset
Definition: RVNGZipStream.cpp:77
librevenge::RVNGDirectoryStreamImpl
Definition: RVNGDirectoryStream.cpp:92
librevenge::RVNG_SEEK_TYPE
RVNG_SEEK_TYPE
Definition: RVNGStream.h:26
librevenge-stream-api.h
librevenge::RVNGInputStream
Definition: RVNGStream.h:33
librevenge::RVNGDirectoryStream
A stream representation of a directory.
Definition: RVNGDirectoryStream.h:40
RVNGStream.h