gio.AsyncResultIF source code

1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD 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
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19  
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 /*
25  * Conversion parameters:
26  * inFile  = GAsyncResult.html
27  * outPack = gio
28  * outFile = AsyncResultIF
29  * strct   = GAsyncResult
30  * realStrct=
31  * ctorStrct=
32  * clss    = AsyncResultT
33  * interf  = AsyncResultIF
34  * class Code: No
35  * interface Code: No
36  * template for:
37  * extend  = 
38  * implements:
39  * prefixes:
40  * 	- g_async_result_
41  * omit structs:
42  * omit prefixes:
43  * omit code:
44  * omit signals:
45  * imports:
46  * 	- gobject.ObjectG
47  * structWrap:
48  * 	- GObject* -> ObjectG
49  * module aliases:
50  * local aliases:
51  * overrides:
52  */
53 
54 module gio.AsyncResultIF;
55 
56 public  import gtkc.giotypes;
57 
58 private import gtkc.gio;
59 private import glib.ConstructionException;
60 private import gobject.ObjectG;
61 
62 
63 private import gobject.ObjectG;
64 
65 
66 
67 
68 /**
69  * Description
70  * Provides a base class for implementing asynchronous function results.
71  * Asynchronous operations are broken up into two separate operations
72  * which are chained together by a GAsyncReadyCallback. To begin
73  * an asynchronous operation, provide a GAsyncReadyCallback to the
74  * asynchronous function. This callback will be triggered when the
75  * operation has completed, and will be passed a GAsyncResult instance
76  * filled with the details of the operation's success or failure, the
77  * object the asynchronous function was started for and any error codes
78  * returned. The asynchronous callback function is then expected to call
79  * the corresponding "_finish()" function, passing the object the
80  * function was called for, the GAsyncResult instance, and (optionally)
81  * an error to grab any error conditions that may have occurred.
82  * The "_finish()" function for an operation takes the generic result
83  * (of type GAsyncResult) and returns the specific result that the
84  * operation in question yields (e.g. a GFileEnumerator for a
85  * "enumerate children" operation). If the result or error status of the
86  * operation is not needed, there is no need to call the "_finish()"
87  * function; GIO will take care of cleaning up the result and error
88  * information after the GAsyncReadyCallback returns. Applications may
89  * also take a reference to the GAsyncResult and call "_finish()"
90  * later; however, the "_finish()" function may be called at most once.
91  * Example of a typical asynchronous operation flow:
92  * $(DDOC_COMMENT example)
93  * The callback for an asynchronous operation is called only once, and is
94  * always called, even in the case of a cancelled operation. On cancellation
95  * the result is a G_IO_ERROR_CANCELLED error.
96  * Some asynchronous operations are implemented using synchronous calls.
97  * These are run in a separate thread, if GThread has been initialized, but
98  * otherwise they are sent to the Main Event Loop and processed in an idle
99  * function. So, if you truly need asynchronous operations, make sure to
100  * initialize GThread.
101  */
102 public interface AsyncResultIF
103 {
104 	
105 	
106 	public GAsyncResult* getAsyncResultTStruct();
107 	
108 	/** the main Gtk struct as a void* */
109 	protected void* getStruct();
110 	
111 	
112 	/**
113 	 */
114 	
115 	/**
116 	 * Gets the user data from a GAsyncResult.
117 	 * Returns: the user data for res. [transfer full]
118 	 */
119 	public void* getUserData();
120 	
121 	/**
122 	 * Gets the source object from a GAsyncResult.
123 	 * Returns: a new reference to the source object for the res, or NULL if there is none. [transfer full]
124 	 */
125 	public ObjectG getSourceObject();
126 }