Improve the g_file_make_symbolic_link docs
[platform/upstream/glib.git] / gio / gwin32inputstream.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, write to the
17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18  * Boston, MA 02111-1307, USA.
19  *
20  * Author: Alexander Larsson <alexl@redhat.com>
21  * Author: Tor Lillqvist <tml@iki.fi>
22  */
23
24 #ifndef __G_WIN32_INPUT_STREAM_H__
25 #define __G_WIN32_INPUT_STREAM_H__
26
27 #include <gio/gio.h>
28
29 G_BEGIN_DECLS
30
31 #define G_TYPE_WIN32_INPUT_STREAM         (g_win32_input_stream_get_type ())
32 #define G_WIN32_INPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_WIN32_INPUT_STREAM, GWin32InputStream))
33 #define G_WIN32_INPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_WIN32_INPUT_STREAM, GWin32InputStreamClass))
34 #define G_IS_WIN32_INPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_WIN32_INPUT_STREAM))
35 #define G_IS_WIN32_INPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_WIN32_INPUT_STREAM))
36 #define G_WIN32_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_WIN32_INPUT_STREAM, GWin32InputStreamClass))
37
38 /**
39  * GWin32InputStream:
40  *
41  * Implements #GInputStream for reading from selectable Windows file handles
42  **/
43 typedef struct _GWin32InputStream         GWin32InputStream;
44 typedef struct _GWin32InputStreamClass    GWin32InputStreamClass;
45 typedef struct _GWin32InputStreamPrivate  GWin32InputStreamPrivate;
46
47 struct _GWin32InputStream
48 {
49   GInputStream parent_instance;
50
51   /*< private >*/
52   GWin32InputStreamPrivate *priv;
53 };
54
55 struct _GWin32InputStreamClass
56 {
57   GInputStreamClass parent_class;
58
59   /*< private >*/
60   /* Padding for future expansion */
61   void (*_g_reserved1) (void);
62   void (*_g_reserved2) (void);
63   void (*_g_reserved3) (void);
64   void (*_g_reserved4) (void);
65   void (*_g_reserved5) (void);
66 };
67
68 GType          g_win32_input_stream_get_type         (void) G_GNUC_CONST;
69
70 GInputStream * g_win32_input_stream_new              (void              *handle,
71                                                       gboolean           close_handle);
72 void           g_win32_input_stream_set_close_handle (GWin32InputStream *stream,
73                                                       gboolean           close_handle);
74 gboolean       g_win32_input_stream_get_close_handle (GWin32InputStream *stream);
75 void          *g_win32_input_stream_get_handle       (GWin32InputStream *stream);
76
77 G_END_DECLS
78
79 #endif /* __G_WIN32_INPUT_STREAM_H__ */