/usr/include/giomm-2.4/giomm/fileoutputstream.h is in libglibmm-2.4-dev 2.42.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GIOMM_FILEOUTPUTSTREAM_H
#define _GIOMM_FILEOUTPUTSTREAM_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
/* Copyright (C) 2007 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <giomm/outputstream.h>
#include <giomm/seekable.h>
#include <giomm/fileinfo.h>
#include <glibmm/object.h>
#include <glibmm/iochannel.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GFileOutputStream GFileOutputStream;
typedef struct _GFileOutputStreamClass GFileOutputStreamClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{ class FileOutputStream_Class; } // namespace Gio
namespace Gio
{
/** FileOutputStream provides output streams that write their content to a file.
*
* FileOutputStream implements Seekable, which allows the output stream to jump
* to arbitrary positions in the file and to truncate the file, provided the
* file system of the file supports these operations.
* Use the methods of the Seekable base class for seeking and positioning.
*
* @ingroup Streams
*
* @newin{2,16}
*/
class FileOutputStream
: public OutputStream,
public Seekable
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef FileOutputStream CppObjectType;
typedef FileOutputStream_Class CppClassType;
typedef GFileOutputStream BaseObjectType;
typedef GFileOutputStreamClass BaseClassType;
private: friend class FileOutputStream_Class;
static CppClassType fileoutputstream_class_;
private:
// noncopyable
FileOutputStream(const FileOutputStream&);
FileOutputStream& operator=(const FileOutputStream&);
protected:
explicit FileOutputStream(const Glib::ConstructParams& construct_params);
explicit FileOutputStream(GFileOutputStream* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~FileOutputStream();
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GFileOutputStream* gobj() { return reinterpret_cast<GFileOutputStream*>(gobject_); }
///Provides access to the underlying C GObject.
const GFileOutputStream* gobj() const { return reinterpret_cast<GFileOutputStream*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GFileOutputStream* gobj_copy();
private:
public:
/** Queries a file output stream for the given @a attributes .
* This function blocks while querying the stream. For the asynchronous
* version of this function, see query_info_async().
* While the stream is blocked, the stream will set the pending flag
* internally, and any other operations on the stream will throw a Gio::Error with
* PENDING.
*
* Can fail if the stream was already closed (with a
* CLOSED error), the stream has pending operations (with a PENDING error),
* or if querying info is not supported for
* the stream's interface (with a NOT_SUPPORTED error). In
* all cases of failure, an empty RefPtr will be returned.
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED may be thrown, and an empty RefPtr will
* be returned.
*
* @param cancellable A Cancellable object.
* @param attributes A file attribute query string.
* @return A FileInfo for the stream, or an empty RefPtr on error.
*/
Glib::RefPtr<FileInfo> query_info(const Glib::RefPtr<Cancellable>& cancellable, const std::string& attributes = "*");
/** Queries a file output stream for the given @a attributes .
* This function blocks while querying the stream. For the asynchronous
* version of this function, see query_info_async().
* While the stream is blocked, the stream will set the pending flag
* internally, and any other operations on the stream will throw a Gio::Error with
* PENDING.
*
* Can fail if the stream was already closed (with a CLOSED error),
* the stream has pending operations (with an PENDING error),
* or if querying info is not supported for
* the stream's interface (with a NOT_SUPPORTED error). In
* all cases of failure, an empty RefPtr will be returned.
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED may be thrown, and an empty RefPtr will
* be returned.
*
* @param attributes A file attribute query string.
* @return A FileInfo for the stream, or an empty RefPtr on error.
*/
Glib::RefPtr<FileInfo> query_info(const std::string& attributes = "*");
/** Queries the stream information asynchronously.
* When the operation is finished @a slot will be called.
* You can then call query_info_finish()
* to get the result of the operation.
*
* For the synchronous version of this function,
* see query_info().
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED may be thrown
*
* @param slot Callback to call when the request is satisfied.
* @param cancellable A Cancellable object.
* @param attributes A file attribute query string.
* @param io_priority The <io-priority of the request.
*/
void query_info_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, const std::string& attributes = "*", int io_priority = Glib::PRIORITY_DEFAULT);
/** Queries the stream information asynchronously.
* When the operation is finished @a slot will be called.
* You can then call query_info_finish()
* to get the result of the operation.
*
* For the synchronous version of this function,
* see query_info().
*
* @param slot Callback to call when the request is satisfied.
* @param attributes A file attribute query string.
* @param io_priority The <io-priority of the request.
*/
void query_info_async(const SlotAsyncReady& slot, const std::string& attributes = "*", int io_priority = Glib::PRIORITY_DEFAULT);
/** Finalizes the asynchronous query started
* by g_file_output_stream_query_info_async().
*
* @param result A AsyncResult.
* @return A FileInfo for the finished query.
*/
Glib::RefPtr<FileInfo> query_info_finish(const Glib::RefPtr<AsyncResult>& result);
/** Gets the entity tag for the file when it has been written.
* This must be called after the stream has been written
* and closed, as the etag can change while writing.
*
* @return The entity tag for the stream.
*/
std::string get_etag() const;
//These seem to be just C convenience functions - they are already in the Seekable base class:
//See http://bugzilla.gnome.org/show_bug.cgi?id=509990
// _WRAP_METHOD(goffset tell() const, g_file_output_stream_tell)
// _WRAP_METHOD(bool can_seek() const, g_file_output_stream_can_seek)
// _WRAP_METHOD(bool seek(goffset offset, Glib::SeekType type, const Glib::RefPtr<Cancellable>& cancellable),
// g_file_output_stream_seek,
// errthrow)
// _WRAP_METHOD(bool can_truncate() const, g_file_output_stream_can_truncate)
// _WRAP_METHOD(bool truncate(goffset size, const Glib::RefPtr<Cancellable>& cancellable),
// g_file_output_stream_truncate,
// errthrow)
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
};
} // namespace Gio
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gio::FileOutputStream
*/
Glib::RefPtr<Gio::FileOutputStream> wrap(GFileOutputStream* object, bool take_copy = false);
}
#endif /* _GIOMM_FILEOUTPUTSTREAM_H */
|