Fix the docs build
[platform/upstream/glib.git] / gio / gwin32outputstream.h
1 /* GIO - GLib Input, Output and Streaming Library
2  *
3  * Copyright (C) 2006-2010 Red Hat, Inc.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General
16  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
17  *
18  * Author: Alexander Larsson <alexl@redhat.com>
19  * Author: Tor Lillqvist <tml@iki.fi>
20  */
21
22 #ifndef __G_WIN32_OUTPUT_STREAM_H__
23 #define __G_WIN32_OUTPUT_STREAM_H__
24
25 #include <gio/gio.h>
26
27 G_BEGIN_DECLS
28
29 #define G_TYPE_WIN32_OUTPUT_STREAM         (g_win32_output_stream_get_type ())
30 #define G_WIN32_OUTPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_WIN32_OUTPUT_STREAM, GWin32OutputStream))
31 #define G_WIN32_OUTPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_WIN32_OUTPUT_STREAM, GWin32OutputStreamClass))
32 #define G_IS_WIN32_OUTPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_WIN32_OUTPUT_STREAM))
33 #define G_IS_WIN32_OUTPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_WIN32_OUTPUT_STREAM))
34 #define G_WIN32_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_WIN32_OUTPUT_STREAM, GWin32OutputStreamClass))
35
36 /**
37  * GWin32OutputStream:
38  *
39  * Implements #GOutputStream for outputting to Windows file handles
40  **/
41 typedef struct _GWin32OutputStream         GWin32OutputStream;
42 typedef struct _GWin32OutputStreamClass    GWin32OutputStreamClass;
43 typedef struct _GWin32OutputStreamPrivate  GWin32OutputStreamPrivate;
44
45 struct _GWin32OutputStream
46 {
47   GOutputStream parent_instance;
48
49   /*< private >*/
50   GWin32OutputStreamPrivate *priv;
51 };
52
53 struct _GWin32OutputStreamClass
54 {
55   GOutputStreamClass parent_class;
56
57   /*< private >*/
58   /* Padding for future expansion */
59   void (*_g_reserved1) (void);
60   void (*_g_reserved2) (void);
61   void (*_g_reserved3) (void);
62   void (*_g_reserved4) (void);
63   void (*_g_reserved5) (void);
64 };
65
66 GLIB_AVAILABLE_IN_ALL
67 GType           g_win32_output_stream_get_type         (void) G_GNUC_CONST;
68
69 GLIB_AVAILABLE_IN_ALL
70 GOutputStream * g_win32_output_stream_new              (void               *handle,
71                                                         gboolean            close_handle);
72 GLIB_AVAILABLE_IN_ALL
73 void            g_win32_output_stream_set_close_handle (GWin32OutputStream *stream,
74                                                         gboolean           close_handle);
75 GLIB_AVAILABLE_IN_ALL
76 gboolean        g_win32_output_stream_get_close_handle (GWin32OutputStream *stream);
77 GLIB_AVAILABLE_IN_ALL
78 void           *g_win32_output_stream_get_handle       (GWin32OutputStream *stream);
79 G_END_DECLS
80
81 #endif /* __G_WIN32_OUTPUT_STREAM_H__ */