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 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
|
<Type Name="Accel" FullName="Gtk.Accel">
<TypeSignature Language="C#" Value="public class Accel" Maintainer="Alex Combas" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Accel extends System.Object" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Accel Class</summary>
<remarks>
<para>Loadable keyboard accelerator specifications and groups.
</para>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Accel ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary />
<remarks />
</Docs>
</Member>
<Member MemberName="GroupsActivate">
<MemberSignature Language="C#" Value="public static bool GroupsActivate (GLib.Object objekt, uint accel_key, Gdk.ModifierType accel_mods);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool GroupsActivate(class GLib.Object objekt, unsigned int32 accel_key, valuetype Gdk.ModifierType accel_mods) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="objekt" Type="GLib.Object" />
<Parameter Name="accel_key" Type="System.UInt32" />
<Parameter Name="accel_mods" Type="Gdk.ModifierType" />
</Parameters>
<Docs>
<param name="objekt">An <see cref="T:GLib.Object" /> usually a <see cref="T:Gtk.Window" />, on which to activate the accelerator.</param>
<param name="accel_key">An <see cref="T:System.UInt32" /> accelerator keyval from a key event.</param>
<param name="accel_mods">A <see cref="T:Gdk.ModifierType" /> keyboard state mask from a key event.</param>
<summary>Finds the first accelerator in any <see cref="T:Gtk.AccelGroup" />.</summary>
<returns>A <see cref="T:System.Boolean" /> returns <see langword="true" /> if the accelerator was handled, and <see langword="false" /> otherwise.</returns>
<remarks>
<para>
Finds the first accelerator in any <see cref="T:Gtk.AccelGroup" /> attached
to <paramref name="objekt" /> that matches <paramref name="accel_key" /> and
<paramref name="accel_mods" />, and activates that accelerator.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="GroupsFromObject">
<MemberSignature Language="C#" Value="public static Gtk.AccelGroup[] GroupsFromObject (GLib.Object obj);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Gtk.AccelGroup[] GroupsFromObject(class GLib.Object obj) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.AccelGroup[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="GLib.Object" />
</Parameters>
<Docs>
<param name="obj">An <see cref="T:GLib.Object" /> usually a <see cref="T:Gtk.Window" />.</param>
<summary>Gets a list of all accel groups which are attached to <paramref name="obj" />.</summary>
<returns>An <see cref="T:Gtk.AccelGroup[]" /> list of all accel groups which are attached to <paramref name="obj" />.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="MapAddEntry">
<MemberSignature Language="C#" Value="public static void MapAddEntry (string accel_path, uint accel_key, Gdk.ModifierType accel_mods);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void MapAddEntry(string accel_path, unsigned int32 accel_key, valuetype Gdk.ModifierType accel_mods) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Moved to AccelMap class. Use AccelMap.AddEntry instead")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="accel_path" Type="System.String" />
<Parameter Name="accel_key" Type="System.UInt32" />
<Parameter Name="accel_mods" Type="Gdk.ModifierType" />
</Parameters>
<Docs>
<param name="accel_path">A <see cref="T:System.String" /> valid accelerator path.</param>
<param name="accel_key">An <see cref="T:System.UInt32" /> accelerator key.</param>
<param name="accel_mods">A <see cref="T:Gdk.ModifierType" /> accelerator modifier.</param>
<summary>Registers a new accelerator with the global accelerator map.</summary>
<remarks>
<para>
This function should only be called once per <paramref name="accel_path" /> with the canonical
<paramref name="accel_key" /> and <paramref name="accel_mods" /> for this path.
To change the accelerator during runtime programatically, use <see cref="M:Gtk.Accel.MapChangeEntry()" />.
</para>
<para>
The accelerator path must consist of "<WINDOWTYPE>/Category1/Category2/.../Action", where
<WINDOWTYPE> should be a unique application-specific indentifier, that corresponds to the
kind of window the accelerator is being used in, e.g. "Gimp-Image", "Abiword-Document" or
"Gnumeric-Settings". The Category1/.../Action portion is most appropriately chosen by the action
the accelerator triggers, i.e. for accelerators on menu items, choose the items's menu path,
e.g. "File/Save As", "Image/View/Zoom" or "Edit/Select All". So a valid accelerator path may
look like this: "<Gimp-Toolbox>/File/Dialogs/ToolOptions..".
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="MapAddFilter">
<MemberSignature Language="C#" Value="public static void MapAddFilter (string filter_pattern);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void MapAddFilter(string filter_pattern) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Moved to AccelMap class. Use AccelMap.AddFilter instead")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter_pattern" Type="System.String" />
</Parameters>
<Docs>
<param name="filter_pattern">A <see cref="T:System.String" /> pattern.</param>
<summary>Adds a filter to the global list of accel path filters.</summary>
<remarks>
<para>
Accel map entries whose accel path matches one of the filters are skipped
by <see cref="M:Gtk.Accel.MapForeach()" />.
This function is intended for gtk-sharp modules that create their own menus but don't want
them to be saved into the applications accelerator map dump.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="MapChangeEntry">
<MemberSignature Language="C#" Value="public static bool MapChangeEntry (string accel_path, uint accel_key, Gdk.ModifierType accel_mods, bool replace);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool MapChangeEntry(string accel_path, unsigned int32 accel_key, valuetype Gdk.ModifierType accel_mods, bool replace) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Moved to AccelMap class. Use AccelMap.ChangeEntry instead")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="accel_path" Type="System.String" />
<Parameter Name="accel_key" Type="System.UInt32" />
<Parameter Name="accel_mods" Type="Gdk.ModifierType" />
<Parameter Name="replace" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="accel_path">A <see cref="T:System.String" /> valid accelerator path.</param>
<param name="accel_key">An <see cref="T:System.UInt32" /> new accelerator key.</param>
<param name="accel_mods">A <see cref="T:Gdk.ModifierType" /> new accelerator modifier.</param>
<param name="replace">A <see cref="T:System.Boolean" /> returns <see langword="true" /> if other accelerators may be deleted upon conflicts.</param>
<summary>Changes the <paramref name="accel_key" /> and <paramref name="accel_mods" /> currently associated with <paramref name="accel_path" />.</summary>
<returns>A <see cref="T:System.Boolean" /> that returns <see langword="true" /> if the accelerator can be changed, and <see langword="false" /> otherwise.</returns>
<remarks>
<para>
Due to conflicts with other accelerators, a change may not always be possible, <paramref name="replace" />
indicates wheather other accelerators may be deleted to resolve such conflicts. A changed will only occur if all conflicts
could be resolved (which might not be the case if conflicting accelerators are locked).
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="MapForeach">
<MemberSignature Language="C#" Value="public static void MapForeach (IntPtr data, Gtk.AccelMapForeach foreach_func);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void MapForeach(native int data, class Gtk.AccelMapForeach foreach_func) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Moved to AccelMap class. Use AccelMap.Foreach instead")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.IntPtr" />
<Parameter Name="foreach_func" Type="Gtk.AccelMapForeach" />
</Parameters>
<Docs>
<param name="data">The <see cref="T:System.IntPtr" /> data to be passed into <paramref name="foreach_func" />.</param>
<param name="foreach_func">A <see cref="T:Gtk.AccelMapForeach" /> function to be executed for each accel map entry which is not filtered out.</param>
<summary>Loops over the entries in the accelerator.</summary>
<remarks>
<para>
Loops over the entries in the accelerator whose accel path doesn't match any of the filters added with <see cref="M:Gtk.Accel.MapAddFilter()" />,
and exectutes <paramref name="foreach_fun" /> on each.
</para>
<para>
The signature of <paramref name="foreach_func" /> is that of <see cref="T:Gtk.AccelMapForeach" />,
the changed parameter indicates wheather this accelerator was changed during
runtime (thus, would need saving during an accelerator map dump).
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="MapForeachUnfiltered">
<MemberSignature Language="C#" Value="public static void MapForeachUnfiltered (IntPtr data, Gtk.AccelMapForeach foreach_func);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void MapForeachUnfiltered(native int data, class Gtk.AccelMapForeach foreach_func) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Moved to AccelMap class. Use AccelMap.ForeachUnfiltered instead")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.IntPtr" />
<Parameter Name="foreach_func" Type="Gtk.AccelMapForeach" />
</Parameters>
<Docs>
<param name="data">An <see cref="T:System.IntPtr" /> data to be passed into the <paramref name="foreach_func" />.</param>
<param name="foreach_func">An <see cref="T:Gtk.AccelMapForeach" /> function to be exacuted for each accel map entry.</param>
<summary>Loops over all the entries in the accelerator map, and executes <paramref name="foreach_func" /> on each.</summary>
<remarks>
<para>
The signature of <paramref name="foreach_func" /> is that of <see cref="T:Gtk.AccelMapForeach" />,
the changed parameter indicates whether this accelerator was changed during runtime
(thus, would need saving during an accelerator map dump).
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="MapLoad">
<MemberSignature Language="C#" Value="public static void MapLoad (string file_name);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void MapLoad(string file_name) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Moved to AccelMap class. Use AccelMap.Load instead")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="file_name" Type="System.String" />
</Parameters>
<Docs>
<param name="file_name">A <see cref="T:System.String" /> file containing accelerator specifications.</param>
<summary>Parses through a file previously saved with <see cref="Gtk.Accel.MapSave()" /> for accelerator specifications, and propagates them accordingly.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="MapLoadFd">
<MemberSignature Language="C#" Value="public static void MapLoadFd (int fd);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void MapLoadFd(int32 fd) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Moved to AccelMap class. Use AccelMap.LoadFd instead")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fd" Type="System.Int32" />
</Parameters>
<Docs>
<param name="fd">An <see cref="T:System.Int32" /> valid readable file descriptor.</param>
<summary>Filedescriptor variant of <see cref="M:Gtk.Accel.MapLoad()" />.</summary>
<remarks>Note that the file descriptor will not be closed by this function.</remarks>
</Docs>
</Member>
<Member MemberName="MapLookupEntry">
<MemberSignature Language="C#" Value="public static bool MapLookupEntry (string accel_path, Gtk.AccelKey key);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool MapLookupEntry(string accel_path, valuetype Gtk.AccelKey key) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Moved to AccelMap class. Use AccelMap.LookupEntry instead")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="accel_path" Type="System.String" />
<Parameter Name="key" Type="Gtk.AccelKey" />
</Parameters>
<Docs>
<param name="accel_path">A <see cref="T:System.String" /> valid accelerator path.</param>
<param name="key">An <see cref="T:Gtk.AccelKey" /> accelerator key to be filled in (optional).</param>
<summary>Looks up the accelerator entry for <paramref name="accel_path" /> and fills in <paramref name="key" />.</summary>
<returns>A <see cref="T:System.Boolean" /> returns <see langword="true" /> if <paramref name="accel_path" /> is known, and <see langword="false" /> otherwise.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="MapSave">
<MemberSignature Language="C#" Value="public static void MapSave (string file_name);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void MapSave(string file_name) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Moved to AccelMap class. Use AccelMap.Save instead")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="file_name" Type="System.String" />
</Parameters>
<Docs>
<param name="file_name">A <see cref="T:System.String" /> file to contain accelerator specifications.</param>
<summary>Saves current accelerator specifications.</summary>
<remarks>
<para>
Saves current accelerator specifications (accelerator path, key, modifiers to
<paramref name="file_name" />. The file is written in a format suitable to be read
back in by <see cref="M:Gtk.Accel.MapLoad()" />.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="MapSaveFd">
<MemberSignature Language="C#" Value="public static void MapSaveFd (int fd);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void MapSaveFd(int32 fd) cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Moved to AccelMap class. Use AccelMap.SaveFd instead")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fd" Type="System.Int32" />
</Parameters>
<Docs>
<param name="fd">An <see cref="T:System.Int32" /> valid writeable file descriptor.</param>
<summary>Filedescriptor variant of <see cref="M:Gtk.Accel.MapSave()" />.</summary>
<remarks>Note that the file descriptor will not be closed by this function.</remarks>
</Docs>
</Member>
</Members>
</Type>
|