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
|
// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
/* Copyright (C) 2007 The giomm 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 <glibmm/interface.h>
#include <giomm/cancellable.h>
_DEFS(giomm,gio)
_PINCLUDE(glibmm/private/interface_p.h)
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GInitableIface GInitableIface;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{
/** Failable object initialization interface
*
* Initable is implemented by objects that can fail during initialization. If
* an object implements this interface the init() function must be called as the
* first thing after construction. If init() is not called, or if it returns an
* error, all further operations on the object should fail, generally with a
* G_IO_ERROR_NOT_INITIALIZED error.
*
* Users of objects implementing this are not intended to use the interface
* method directly, instead it will be used automatically in various ways. For C
* applications you generally just call g_initable_new() directly, or indirectly
* via a foo_thing_new() wrapper. This will call g_initable_init() under the
* cover, returning NULL and setting a GError on failure.
*
* For bindings in languages where the native constructor supports exceptions
* the binding could check for objects implemention GInitable during normal
* construction and automatically initialize them, throwing an exception on
* failure.
*
* @newin{2,22}
*/
class Initable : public Glib::Interface
{
_CLASS_INTERFACE(Initable, GInitable, G_INITABLE, GInitableIface)
protected:
_WRAP_METHOD(void init(const Glib::RefPtr<Cancellable>& cancellable),
g_initable_init, errthrow)
_WRAP_VFUNC(bool init(const Glib::RefPtr<Cancellable>& cancellable, GError** error), "init")
};
} // namespace Gio
|
