efa9acf122
* en/*/*.xml: Updated all the docs to match the new API. All the nodes that no longer have a corresponding member in the type are now marked as deprecated. We'll have to wait for Miguel to implement this in the browser to stop displaying them. All gtype constructors have been regenerated, because of the 'uint' to 'GLib.Type' change. However, this patch will preserve (well, it was regenerated) the customized text for those GType constructors. A lot of the 'Finalized' methods are also now marked as deprecated, because the classes implement 'Dispose' instead. This is a possible place for customized scripts to generate template documentation, similar to the GType property and GType constructors. svn path=/trunk/gtk-sharp/; revision=12270
445 lines
No EOL
18 KiB
XML
445 lines
No EOL
18 KiB
XML
<Type Name="ItemFactory" FullName="Gtk.ItemFactory">
|
|
<TypeSignature Language="C#" Value="public class ItemFactory : Gtk.Object, IWrapper, IDisposable" Maintainer="auto" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>gtk-sharp</AssemblyName>
|
|
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
<Attributes />
|
|
</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>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
<Base>
|
|
<BaseTypeName>Gtk.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>GLib.IWrapper</InterfaceName>
|
|
</Interface>
|
|
<Interface>
|
|
<InterfaceName>System.IDisposable</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Attributes />
|
|
<Members>
|
|
<Member MemberName="PathFromWidget">
|
|
<MemberSignature Language="C#" Value="public static string PathFromWidget (Gtk.Widget widget);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="widget" Type="Gtk.Widget" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="widget">To be added: an object of type 'Gtk.Widget'</param>
|
|
<returns>To be added: an object of type 'string'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="FromWidget">
|
|
<MemberSignature Language="C#" Value="public static Gtk.ItemFactory FromWidget (Gtk.Widget widget);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.ItemFactory</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="widget" Type="Gtk.Widget" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="widget">To be added: an object of type 'Gtk.Widget'</param>
|
|
<returns>To be added: an object of type 'Gtk.ItemFactory'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PopupDataFromWidget">
|
|
<MemberSignature Language="C#" Value="public static IntPtr PopupDataFromWidget (Gtk.Widget widget);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.IntPtr</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="widget" Type="Gtk.Widget" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="widget">To be added: an object of type 'Gtk.Widget'</param>
|
|
<returns>To be added: an object of type 'IntPtr'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AddForeign">
|
|
<MemberSignature Language="C#" Value="public static void AddForeign (Gtk.Widget accel_widget, string full_path, Gtk.AccelGroup accel_group, uint keyval, Gdk.ModifierType modifiers);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="accel_widget" Type="Gtk.Widget" />
|
|
<Parameter Name="full_path" Type="System.String" />
|
|
<Parameter Name="accel_group" Type="Gtk.AccelGroup" />
|
|
<Parameter Name="keyval" Type="System.UInt32" />
|
|
<Parameter Name="modifiers" Type="Gdk.ModifierType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="accel_widget">To be added: an object of type 'Gtk.Widget'</param>
|
|
<param name="full_path">To be added: an object of type 'string'</param>
|
|
<param name="accel_group">To be added: an object of type 'Gtk.AccelGroup'</param>
|
|
<param name="keyval">To be added: an object of type 'uint'</param>
|
|
<param name="modifiers">To be added: an object of type 'Gdk.ModifierType'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DeleteEntries">
|
|
<MemberSignature Language="C#" Value="public void DeleteEntries (uint n_entries, Gtk.ItemFactoryEntry entries);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="n_entries" Type="System.UInt32" />
|
|
<Parameter Name="entries" Type="Gtk.ItemFactoryEntry" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="n_entries">To be added: an object of type 'uint'</param>
|
|
<param name="entries">To be added: an object of type 'Gtk.ItemFactoryEntry'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PopupWithData">
|
|
<MemberSignature Language="C#" Value="public void PopupWithData (IntPtr popup_data, Gtk.DestroyNotify destroy, uint x, uint y, uint mouse_button, uint time);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="popup_data" Type="System.IntPtr" />
|
|
<Parameter Name="destroy" Type="Gtk.DestroyNotify" />
|
|
<Parameter Name="x" Type="System.UInt32" />
|
|
<Parameter Name="y" Type="System.UInt32" />
|
|
<Parameter Name="mouse_button" Type="System.UInt32" />
|
|
<Parameter Name="time" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="popup_data">To be added: an object of type 'IntPtr'</param>
|
|
<param name="destroy">To be added: an object of type 'Gtk.DestroyNotify'</param>
|
|
<param name="x">To be added: an object of type 'uint'</param>
|
|
<param name="y">To be added: an object of type 'uint'</param>
|
|
<param name="mouse_button">To be added: an object of type 'uint'</param>
|
|
<param name="time">To be added: an object of type 'uint'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetItemByAction">
|
|
<MemberSignature Language="C#" Value="public Gtk.Widget GetItemByAction (uint action);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.Widget</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="action" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="action">To be added: an object of type 'uint'</param>
|
|
<returns>To be added: an object of type 'Gtk.Widget'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Popup">
|
|
<MemberSignature Language="C#" Value="public void Popup (uint x, uint y, uint mouse_button, uint time);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="x" Type="System.UInt32" />
|
|
<Parameter Name="y" Type="System.UInt32" />
|
|
<Parameter Name="mouse_button" Type="System.UInt32" />
|
|
<Parameter Name="time" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="x">To be added: an object of type 'uint'</param>
|
|
<param name="y">To be added: an object of type 'uint'</param>
|
|
<param name="mouse_button">To be added: an object of type 'uint'</param>
|
|
<param name="time">To be added: an object of type 'uint'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Construct">
|
|
<MemberSignature Language="C#" Value="public void Construct (uint container_type, string path, Gtk.AccelGroup accel_group);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="container_type" Type="System.UInt32" />
|
|
<Parameter Name="path" Type="System.String" />
|
|
<Parameter Name="accel_group" Type="Gtk.AccelGroup" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="container_type">To be added: an object of type 'uint'</param>
|
|
<param name="path">To be added: an object of type 'string'</param>
|
|
<param name="accel_group">To be added: an object of type 'Gtk.AccelGroup'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DeleteEntry">
|
|
<MemberSignature Language="C#" Value="public void DeleteEntry (Gtk.ItemFactoryEntry entry);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="entry" Type="Gtk.ItemFactoryEntry" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="entry">To be added: an object of type 'Gtk.ItemFactoryEntry'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="CreateItem">
|
|
<MemberSignature Language="C#" Value="public void CreateItem (Gtk.ItemFactoryEntry entry, IntPtr callback_data, uint callback_type);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="entry" Type="Gtk.ItemFactoryEntry" />
|
|
<Parameter Name="callback_data" Type="System.IntPtr" />
|
|
<Parameter Name="callback_type" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="entry">To be added: an object of type 'Gtk.ItemFactoryEntry'</param>
|
|
<param name="callback_data">To be added: an object of type 'IntPtr'</param>
|
|
<param name="callback_type">To be added: an object of type 'uint'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetWidgetByAction">
|
|
<MemberSignature Language="C#" Value="public Gtk.Widget GetWidgetByAction (uint action);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.Widget</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="action" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="action">To be added: an object of type 'uint'</param>
|
|
<returns>To be added: an object of type 'Gtk.Widget'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetItem">
|
|
<MemberSignature Language="C#" Value="public Gtk.Widget GetItem (string path);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.Widget</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="path" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="path">To be added: an object of type 'string'</param>
|
|
<returns>To be added: an object of type 'Gtk.Widget'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DeleteItem">
|
|
<MemberSignature Language="C#" Value="public void DeleteItem (string path);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="path" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="path">To be added: an object of type 'string'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PopupData">
|
|
<MemberSignature Language="C#" Value="public IntPtr PopupData ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.IntPtr</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>To be added: an object of type 'IntPtr'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="CreateItems">
|
|
<MemberSignature Language="C#" Value="public void CreateItems (uint n_entries, Gtk.ItemFactoryEntry entries, IntPtr callback_data);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="n_entries" Type="System.UInt32" />
|
|
<Parameter Name="entries" Type="Gtk.ItemFactoryEntry" />
|
|
<Parameter Name="callback_data" Type="System.IntPtr" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="n_entries">To be added: an object of type 'uint'</param>
|
|
<param name="entries">To be added: an object of type 'Gtk.ItemFactoryEntry'</param>
|
|
<param name="callback_data">To be added: an object of type 'IntPtr'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetWidget">
|
|
<MemberSignature Language="C#" Value="public Gtk.Widget GetWidget (string path);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.Widget</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="path" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="path">To be added: an object of type 'string'</param>
|
|
<returns>To be added: an object of type 'Gtk.Widget'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetTranslateFunc">
|
|
<MemberSignature Language="C#" Value="public void SetTranslateFunc (Gtk.TranslateFunc func, IntPtr data, Gtk.DestroyNotify notify);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="func" Type="Gtk.TranslateFunc" />
|
|
<Parameter Name="data" Type="System.IntPtr" />
|
|
<Parameter Name="notify" Type="Gtk.DestroyNotify" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="func">To be added: an object of type 'Gtk.TranslateFunc'</param>
|
|
<param name="data">To be added: an object of type 'IntPtr'</param>
|
|
<param name="notify">To be added: an object of type 'Gtk.DestroyNotify'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Finalize">
|
|
<MemberSignature Language="C#" Value="protected virtual void Finalize ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Disposes the resources associated with the object.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor" Deprecated="true">
|
|
<MemberSignature Language="C#" Value="protected ItemFactory (uint gtype);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="gtype" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Internal constructor</summary>
|
|
<param name="gtype">GLib type for the type</param>
|
|
<returns>Creates a new instance of ItemFactory, using the GLib-provided type</returns>
|
|
<remarks>
|
|
<para>This is a constructor used by derivative types of <see cref="T:Gtk.ItemFactory" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public ItemFactory (IntPtr raw);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="raw" Type="System.IntPtr" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Internal constructor</summary>
|
|
<param name="raw">Pointer to the C object.</param>
|
|
<returns>An instance of ItemFactory, wrapping the C object.</returns>
|
|
<remarks>
|
|
<para>This is an internal constructor, and should not be used by user code.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public ItemFactory (uint container_type, string path, Gtk.AccelGroup accel_group);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="container_type" Type="System.UInt32" />
|
|
<Parameter Name="path" Type="System.String" />
|
|
<Parameter Name="accel_group" Type="Gtk.AccelGroup" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="container_type">To be added: an object of type 'uint'</param>
|
|
<param name="path">To be added: an object of type 'string'</param>
|
|
<param name="accel_group">To be added: an object of type 'Gtk.AccelGroup'</param>
|
|
<returns>To be added: an object of type 'Gtk.ItemFactory'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected ItemFactory ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>To be added: an object of type 'Gtk.ItemFactory'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GType">
|
|
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.UInt32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>The GLib Type for Gtk.ItemFactory</summary>
|
|
<returns>The GLib Type for the Gtk.ItemFactory class.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected ItemFactory (GLib.Type gtype);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="gtype" Type="GLib.Type" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Internal constructor</summary>
|
|
<param name="gtype">GLib type for the type</param>
|
|
<returns>Creates a new instance of ItemFactory, using the GLib-provided type</returns>
|
|
<remarks>
|
|
<para>This is a constructor used by derivative types of <see cref="T:Gtk.ItemFactory" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |