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 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
|
/*
* This file is part of gtkD.
*
* gtkD 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 3
* of the License, or (at your option) any later version, with
* some exceptions, please read the COPYING file.
*
* gtkD 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 gtkD; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
*/
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage
module glib.HookList;
private import glib.Hook;
private import glib.MemorySlice;
private import glib.c.functions;
public import glib.c.types;
public import gtkc.glibtypes;
private import gtkd.Loader;
/**
* The #GHookList struct represents a list of hook functions.
*/
public final class HookList
{
/** the main Gtk struct */
protected GHookList* gHookList;
protected bool ownedRef;
/** Get the main Gtk struct */
public GHookList* getHookListStruct(bool transferOwnership = false)
{
if (transferOwnership)
ownedRef = false;
return gHookList;
}
/** the main Gtk struct as a void* */
protected void* getStruct()
{
return cast(void*)gHookList;
}
/**
* Sets our main struct and passes it to the parent class.
*/
public this (GHookList* gHookList, bool ownedRef = false)
{
this.gHookList = gHookList;
this.ownedRef = ownedRef;
}
~this ()
{
if ( Linker.isLoaded(LIBRARY_GLIB) && ownedRef )
sliceFree(gHookList);
}
/**
* the next free #GHook id
*/
public @property gulong seqId()
{
return gHookList.seqId;
}
/** Ditto */
public @property void seqId(gulong value)
{
gHookList.seqId = value;
}
/**
* the size of the #GHookList elements, in bytes
*/
public @property uint hookSize()
{
return gHookList.hookSize;
}
/** Ditto */
public @property void hookSize(uint value)
{
gHookList.hookSize = value;
}
/**
* 1 if the #GHookList has been initialized
*/
public @property uint isSetup()
{
return gHookList.isSetup;
}
/** Ditto */
public @property void isSetup(uint value)
{
gHookList.isSetup = value;
}
/**
* the first #GHook element in the list
*/
public @property Hook hooks()
{
return new Hook(gHookList.hooks, false);
}
/** Ditto */
public @property void hooks(Hook value)
{
gHookList.hooks = value.getHookStruct();
}
/**
* the function to call to finalize a #GHook element.
* The default behaviour is to call the hooks @destroy function
*/
public @property GHookFinalizeFunc finalizeHook()
{
return gHookList.finalizeHook;
}
/** Ditto */
public @property void finalizeHook(GHookFinalizeFunc value)
{
gHookList.finalizeHook = value;
}
/**
* Removes all the #GHook elements from a #GHookList.
*/
public void clear()
{
g_hook_list_clear(gHookList);
}
/**
* Initializes a #GHookList.
* This must be called before the #GHookList is used.
*
* Params:
* hookSize = the size of each element in the #GHookList,
* typically `sizeof (GHook)`.
*/
public void init(uint hookSize)
{
g_hook_list_init(gHookList, hookSize);
}
/**
* Calls all of the #GHook functions in a #GHookList.
*
* Params:
* mayRecurse = %TRUE if functions which are already running
* (e.g. in another thread) can be called. If set to %FALSE,
* these are skipped
*/
public void invoke(bool mayRecurse)
{
g_hook_list_invoke(gHookList, mayRecurse);
}
/**
* Calls all of the #GHook functions in a #GHookList.
* Any function which returns %FALSE is removed from the #GHookList.
*
* Params:
* mayRecurse = %TRUE if functions which are already running
* (e.g. in another thread) can be called. If set to %FALSE,
* these are skipped
*/
public void invokeCheck(bool mayRecurse)
{
g_hook_list_invoke_check(gHookList, mayRecurse);
}
/**
* Calls a function on each valid #GHook.
*
* Params:
* mayRecurse = %TRUE if hooks which are currently running
* (e.g. in another thread) are considered valid. If set to %FALSE,
* these are skipped
* marshaller = the function to call for each #GHook
* marshalData = data to pass to @marshaller
*/
public void marshal(bool mayRecurse, GHookMarshaller marshaller, void* marshalData)
{
g_hook_list_marshal(gHookList, mayRecurse, marshaller, marshalData);
}
/**
* Calls a function on each valid #GHook and destroys it if the
* function returns %FALSE.
*
* Params:
* mayRecurse = %TRUE if hooks which are currently running
* (e.g. in another thread) are considered valid. If set to %FALSE,
* these are skipped
* marshaller = the function to call for each #GHook
* marshalData = data to pass to @marshaller
*/
public void marshalCheck(bool mayRecurse, GHookCheckMarshaller marshaller, void* marshalData)
{
g_hook_list_marshal_check(gHookList, mayRecurse, marshaller, marshalData);
}
}
|