gdkcontentserializer.h 5.43 KB
Newer Older
Benjamin Otte's avatar
Benjamin Otte committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
/* GTK - The GIMP Toolkit
 * Copyright (C) 2017 Benjamin Otte
 *
 * 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 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef __GTK_CONTENT_SERIALIZER_H__
#define __GTK_CONTENT_SERIALIZER_H__

21
#if !defined (__GDK_H_INSIDE__) && !defined (GTK_COMPILATION)
Benjamin Otte's avatar
Benjamin Otte committed
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
#error "Only <gdk/gdk.h> can be included directly."
#endif


#include <gdk/gdkversionmacros.h>
#include <gdk/gdktypes.h>

G_BEGIN_DECLS

#define GDK_TYPE_CONTENT_SERIALIZER         (gdk_content_serializer_get_type ())
#define GDK_CONTENT_SERIALIZER(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), GDK_TYPE_CONTENT_SERIALIZER, GdkContentSerializer))
#define GDK_IS_CONTENT_SERIALIZER(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), GDK_TYPE_CONTENT_SERIALIZER))

typedef struct _GdkContentSerializer GdkContentSerializer;

37
38
/**
 * GdkContentSerializeFunc:
Matthias Clasen's avatar
Matthias Clasen committed
39
 * @serializer: a `GdkContentSerializer`
40
41
 *
 * The type of a function that can be registered with gdk_content_register_serializer().
Matthias Clasen's avatar
Matthias Clasen committed
42
 *
43
44
45
46
 * When the function gets called to operate on content, it can call functions on the
 * @serializer object to obtain the mime type, output stream, user data, etc. for its
 * operation.
 */
Benjamin Otte's avatar
Benjamin Otte committed
47
48
typedef void (* GdkContentSerializeFunc) (GdkContentSerializer *serializer);

Matthias Clasen's avatar
Matthias Clasen committed
49
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
50
51
GType                   gdk_content_serializer_get_type                 (void) G_GNUC_CONST;

Matthias Clasen's avatar
Matthias Clasen committed
52
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
53
const char *            gdk_content_serializer_get_mime_type            (GdkContentSerializer   *serializer);
Matthias Clasen's avatar
Matthias Clasen committed
54
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
55
GType                   gdk_content_serializer_get_gtype                (GdkContentSerializer   *serializer);
Matthias Clasen's avatar
Matthias Clasen committed
56
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
57
const GValue *          gdk_content_serializer_get_value                (GdkContentSerializer   *serializer);
Matthias Clasen's avatar
Matthias Clasen committed
58
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
59
GOutputStream *         gdk_content_serializer_get_output_stream        (GdkContentSerializer   *serializer);
Matthias Clasen's avatar
Matthias Clasen committed
60
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
61
int                     gdk_content_serializer_get_priority             (GdkContentSerializer   *serializer);
Matthias Clasen's avatar
Matthias Clasen committed
62
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
63
GCancellable *          gdk_content_serializer_get_cancellable          (GdkContentSerializer   *serializer);
Matthias Clasen's avatar
Matthias Clasen committed
64
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
65
gpointer                gdk_content_serializer_get_user_data            (GdkContentSerializer   *serializer);
Matthias Clasen's avatar
Matthias Clasen committed
66
GDK_AVAILABLE_IN_ALL
67
68
69
void                    gdk_content_serializer_set_task_data            (GdkContentSerializer   *serializer,
                                                                         gpointer                data,
                                                                         GDestroyNotify          notify);
Matthias Clasen's avatar
Matthias Clasen committed
70
GDK_AVAILABLE_IN_ALL
71
gpointer                gdk_content_serializer_get_task_data            (GdkContentSerializer   *serializer);
Benjamin Otte's avatar
Benjamin Otte committed
72

Matthias Clasen's avatar
Matthias Clasen committed
73
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
74
void                    gdk_content_serializer_return_success           (GdkContentSerializer   *serializer);
Matthias Clasen's avatar
Matthias Clasen committed
75
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
76
77
78
void                    gdk_content_serializer_return_error             (GdkContentSerializer   *serializer,
                                                                         GError                 *error);

Matthias Clasen's avatar
Matthias Clasen committed
79
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
80
GdkContentFormats *     gdk_content_formats_union_serialize_gtypes      (GdkContentFormats      *formats);
Matthias Clasen's avatar
Matthias Clasen committed
81
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
82
83
GdkContentFormats *     gdk_content_formats_union_serialize_mime_types  (GdkContentFormats      *formats);

Matthias Clasen's avatar
Matthias Clasen committed
84
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
85
86
87
88
89
void                    gdk_content_register_serializer                 (GType                   type,
                                                                         const char             *mime_type,
                                                                         GdkContentSerializeFunc serialize,
                                                                         gpointer                data,
                                                                         GDestroyNotify          notify);
Matthias Clasen's avatar
Matthias Clasen committed
90
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
91
92
93
94
95
96
97
void                    gdk_content_serialize_async                     (GOutputStream          *stream,
                                                                         const char             *mime_type,
                                                                         const GValue           *value,
                                                                         int                     io_priority,
                                                                         GCancellable           *cancellable,
                                                                         GAsyncReadyCallback     callback,
                                                                         gpointer                user_data);
Matthias Clasen's avatar
Matthias Clasen committed
98
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
99
100
101
102
103
104
105
gboolean                gdk_content_serialize_finish                    (GAsyncResult           *result,
                                                                         GError                **error);


G_END_DECLS

#endif /* __GDK_CONTENT_SERIALIZER_H__ */