ryujinx/GtkSharp
1
0
Fork 0
mirror of https://github.com/Ryujinx/GtkSharp.git synced 2025-06-03 11:38:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

* en/Gtk/Icon.xml

Browse source 
* en/Gtk/ItemFactory.xml: Full docs.
	* en/Gtk/TODO: Added file with list of missing Gtk docs.

svn path=/trunk/gtk-sharp/; revision=18624
This commit is contained in:
Hector E. Gomez Morales 2003-10-05 07:38:14 +00:00
parent be9946dca2
commit 17be196384
5 changed files with 204 additions and 134 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/ChangeLog
View file

@ -1,3 +1,9 @@
2003-10-04 Hector E. Gomez Morales <hgomez_36@flashmail.com>
* en/Gtk/Icon.xml
* en/Gtk/ItemFactory.xml: Full docs.
* en/Gtk/TODO: Added file with list of missing Gtk docs.
2003-10-03 John Luke <jluke@cfl.rr.com> 2003-10-03 John Luke <jluke@cfl.rr.com>
* en/Gnome/Popup.xml: documented w/ simple example * en/Gnome/Popup.xml: documented w/ simple example

96
doc/en/Gtk/Icon.xml
View file

@ -1,5 +1,5 @@
<Type Name="Icon" FullName="Gtk.Icon"> <Type Name="Icon" FullName="Gtk.Icon">
<TypeSignature Language="C#" Value="public class Icon" Maintainer="auto" /> <TypeSignature Language="C#" Value="public class Icon" Maintainer="Hector Gomez M" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey /> <AssemblyPublicKey />
@ -9,8 +9,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Methods for handling icon properties.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Object</BaseTypeName> <BaseTypeName>System.Object</BaseTypeName>
@ -29,10 +29,14 @@
<Parameter Name="target" Type="Gtk.IconSize" /> <Parameter Name="target" Type="Gtk.IconSize" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Registers <paramref name="alias" /> as another name for <paramref name="target" />.</summary>
<param name="alias">a <see cref="T:System.String" /></param> <param name="alias">An alias for <paramref name="name" />.</param>
<param name="target">a <see cref="T:Gtk.IconSize" /></param> <param name="target">An existing icon size.</param>
<remarks>To be added</remarks> <remarks>
<para>
Calling <see cref="M:Gtk.Icon.SizeFromName" /> with <paramref name="alias" /> as argument will return <paramref name="target" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SizeFromName"> <Member MemberName="SizeFromName">
@ -45,10 +49,10 @@
<Parameter Name="name" Type="System.String" /> <Parameter Name="name" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Looks up the icon size associated with <paramref name="name" />.</summary>
<param name="name">a <see cref="T:System.String" /></param> <param name="name">The name to look up.</param>
<returns>a <see cref="T:Gtk.IconSize" /></returns> <returns>The icon size with the given name.</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SizeRegister"> <Member MemberName="SizeRegister">
@ -63,12 +67,16 @@
<Parameter Name="height" Type="System.Int32" /> <Parameter Name="height" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Registers a new icon size.</summary>
<param name="name">a <see cref="T:System.String" /></param> <param name="name">Name of the icon size.</param>
<param name="width">a <see cref="T:System.Int32" /></param> <param name="width">The icon width.</param>
<param name="height">a <see cref="T:System.Int32" /></param> <param name="height">The icon height.</param>
<returns>a <see cref="T:Gtk.IconSize" /></returns> <returns>Integer value representing the size.</returns>
<remarks>To be added</remarks> <remarks>
<para>
Along the same lines as <see cref="F:Gtk.IconSize.Menu" />. Returns integer value for the size.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SizeGetName"> <Member MemberName="SizeGetName">
@ -81,10 +89,14 @@
<Parameter Name="size" Type="Gtk.IconSize" /> <Parameter Name="size" Type="Gtk.IconSize" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the canonical name of the given icon size.</summary>
<param name="size">a <see cref="T:Gtk.IconSize" /></param> <param name="size">A <see cref="T:Gtk.IconSize" />.</param>
<returns>a <see cref="T:System.String" /></returns> <returns>The name of the given icon size.</returns>
<remarks>To be added</remarks> <remarks>
<para>
The returned string is statically allocated and should not be freed.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SizeLookupForSettings"> <Member MemberName="SizeLookupForSettings">
@ -100,13 +112,17 @@
<Parameter Name="height" Type="System.Int32" /> <Parameter Name="height" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the pixel size of a semantic icon size, possibly modified by user preferences for a particular <see cref="T:Gtk.Settings" />.</summary>
<param name="settings">a <see cref="T:Gtk.Settings" /></param> <param name="settings">A <see cref="T:Gtk.Settings" /> object, used to determine which set of user preferences to use.</param>
<param name="size">a <see cref="T:Gtk.IconSize" /></param> <param name="size">An icon size.</param>
<param name="width">a <see cref="T:System.Int32" /></param> <param name="width">Location to store icon width.</param>
<param name="height">a <see cref="T:System.Int32" /></param> <param name="height">Location to store icon height.</param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns><see langword="true" /> if <paramref name="size" /> was a valid size.</returns>
<remarks>To be added</remarks> <remarks>
<para>
Normally size would be <see cref="F:Gtk.IconSize.Menu" />, <see cref="F:Gtk.IconSize.Button" />, etc. This method isn't normally needed, <see cref="M:Gtk.Widget.RenderIcon" /> is the usual way to get an icon for rendering, then just look at the size of the rendered pixbuf. The rendered pixbuf may not even correspond to the width/height returned by <see cref="M:Gtk.Icon.SizeLookup" />, because themes are free to render the pixbuf however they like, including changing the usual size.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SizeLookup"> <Member MemberName="SizeLookup">
@ -121,12 +137,16 @@
<Parameter Name="height" Type="System.Int32" /> <Parameter Name="height" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the pixel size of a semantic icon size, possibly modified by user preferences fot the default <see cref="T:Gtk.Settings" />.</summary>
<param name="size">a <see cref="T:Gtk.IconSize" /></param> <param name="size">An icon size.</param>
<param name="width">a <see cref="T:System.Int32" /></param> <param name="width">Location to store icon width.</param>
<param name="height">a <see cref="T:System.Int32" /></param> <param name="height">Location to store icon height.</param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns><see langword="true" /> if <paramref name="size" /> was a valid size.</returns>
<remarks>To be added</remarks> <remarks>
<para>
Normally size would be <see cref="F:Gtk.IconSize.Menu" />, <see cref="F:Gtk.IconSize.Button" />, etc. This method isn't normally needed, <see cref="M:Gtk.Widget.RenderIcon" /> is the usual way to get an icon for rendering, then just look at the size of the rendered pixbuf. The rendered pixbuf may not even correspond to the width/height returned by <see cref="M:Gtk.Icon.SizeLookup" />, because themes are free to render the pixbuf however they like, including changing the usual size.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -135,10 +155,10 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>A constructor.</summary>
<returns>a <see cref="T:Gtk.Icon" /></returns> <returns>A new instance of <see cref="T:Gtk.Icon" />.</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

4
doc/en/Gtk/IconSize.xml
View file

@ -1,5 +1,5 @@
<Type Name="IconSize" FullName="Gtk.IconSize"> <Type Name="IconSize" FullName="Gtk.IconSize">
<TypeSignature Language="C#" Maintainer="auto" Value="public enum IconSize;" /> <TypeSignature Language="C#" Value="public enum IconSize;" Maintainer="duncan" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -128,4 +128,4 @@
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

223
doc/en/Gtk/ItemFactory.xml
View file

@ -1,5 +1,5 @@
<Type Name="ItemFactory" FullName="Gtk.ItemFactory"> <Type Name="ItemFactory" FullName="Gtk.ItemFactory">
<TypeSignature Language="C#" Value="public class ItemFactory : Gtk.Object, IWrapper, IDisposable" Maintainer="auto" /> <TypeSignature Language="C#" Value="public class ItemFactory : Gtk.Object, IWrapper, IDisposable" Maintainer="Hector Gomez M" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>A factory for menus.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.Object</BaseTypeName> <BaseTypeName>Gtk.Object</BaseTypeName>
@ -33,10 +33,14 @@
<Parameter Name="widget" Type="Gtk.Widget" /> <Parameter Name="widget" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>If <paramref name="widget" /> has been created by an item factory, returns the full path to it.</summary>
<param name="widget">To be added: an object of type 'Gtk.Widget'</param> <param name="widget">A <see cref="T:Gtk.Widget" />.</param>
<returns>To be added: an object of type 'string'</returns> <returns>The full path to <paramref name="widget" /> if it has been created by an item factory, <see langword="null" /> otherwise. This value is owned by GTK+ and must not be modified or freed.</returns>
<remarks>To be added</remarks> <remarks>
<para>
The full path of a <paramref name="widget" /> is the concatenation of the factory path specified in <see cref="M:Gtk.ItemFactory.Construct" /> with the path specified in the <see cref="T:Gtk.ItemFactoryEntry" /> from which the <paramref name="widget" /> was created.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="FromWidget"> <Member MemberName="FromWidget">
@ -49,10 +53,10 @@
<Parameter Name="widget" Type="Gtk.Widget" /> <Parameter Name="widget" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the item factory from which a <paramref name="widget" /> was created.</summary>
<param name="widget">To be added: an object of type 'Gtk.Widget'</param> <param name="widget">A <see cref="T:Gtk.Widget" />.</param>
<returns>To be added: an object of type 'Gtk.ItemFactory'</returns> <returns>The item factory from which <paramref name="widget" /> was created, or <see langword="null" />.</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PopupDataFromWidget"> <Member MemberName="PopupDataFromWidget">
@ -65,10 +69,14 @@
<Parameter Name="widget" Type="Gtk.Widget" /> <Parameter Name="widget" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the <paramref name="popup_data" /> which was passed to <see cref="M:Gtk.ItemFactory.PopupWithData" />.</summary>
<param name="widget">To be added: an object of type 'Gtk.Widget'</param> <param name="widget">A <see cref="T:Gtk.Widget" />.</param>
<returns>To be added: an object of type 'IntPtr'</returns> <returns><paramref name="popup_data" /> associated with the item factory from which <paramref name="widget" /> was created, or <see langword="null" /> if <paramref name="widget" /> wasn't created by an item factory.</returns>
<remarks>To be added</remarks> <remarks>
<para>
This data is available until the menu is popped down again.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AddForeign"> <Member MemberName="AddForeign">
@ -85,13 +93,17 @@
<Parameter Name="modifiers" Type="Gdk.ModifierType" /> <Parameter Name="modifiers" Type="Gdk.ModifierType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Installs an accelerator for <paramref name="accel_widget" /> in <paramref name="accel_group" />, that causes the activate event to be emitted it the accelerator is activated.</summary>
<param name="accel_widget">To be added: an object of type 'Gtk.Widget'</param> <param name="accel_widget">Widget to install an accelerator on.</param>
<param name="full_path">To be added: an object of type 'string'</param> <param name="full_path">The full path for the <paramref name="accel_widget" />.</param>
<param name="accel_group">To be added: an object of type 'Gtk.AccelGroup'</param> <param name="accel_group">The accelerator group to install the accelerator in.</param>
<param name="keyval">To be added: an object of type 'uint'</param> <param name="keyval">Key value of the accelerator.</param>
<param name="modifiers">To be added: an object of type 'Gdk.ModifierType'</param> <param name="modifiers">Modifier combination of the acelerator.</param>
<remarks>To be added</remarks> <remarks>
<para>
This method can be used to make widgets participate in the accel saving/restoring functionality provided by <see cref="M:Gtk.Accel.MapSave" /> and <see cref="M:Gtk.Accel.MapLoad" />, even if they haven't been created by an item factory. The recommended API for this purpose are the <see cref="P:Gtk.Menu.AccelPath" /> and <see cref="P:Gtk.Widget.SetAccelPath" />; don't use <see cref="M:Gtk.ItemFactory.AddForeign" /> in new code, since it is likely to be removed in the future.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DeleteEntries"> <Member MemberName="DeleteEntries">
@ -105,10 +117,10 @@
<Parameter Name="entries" Type="Gtk.ItemFactoryEntry" /> <Parameter Name="entries" Type="Gtk.ItemFactoryEntry" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Deletes the menu items which were created from the entries by the given item factory.</summary>
<param name="n_entries">To be added: an object of type 'uint'</param> <param name="n_entries">The length of <paramref name="entries" />.</param>
<param name="entries">To be added: an object of type 'Gtk.ItemFactoryEntry'</param> <param name="entries">An array of <see cref="T:Gtk.ItemFactoryEntry" />s.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetItem"> <Member MemberName="GetItem">
@ -121,7 +133,7 @@
<Parameter Name="action" Type="System.UInt32" /> <Parameter Name="action" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the menu item which correponds to <paramref name="action" />.</summary>
<param name="action">To be added: an object of type 'uint'</param> <param name="action">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'Gtk.Widget'</returns> <returns>To be added: an object of type 'Gtk.Widget'</returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>
@ -139,11 +151,11 @@
<Parameter Name="accel_group" Type="Gtk.AccelGroup" /> <Parameter Name="accel_group" Type="Gtk.AccelGroup" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Initializes a item factory.</summary>
<param name="container_type">To be added: an object of type 'uint'</param> <param name="container_type">The kind of menu to create, an object of type 'uint'.</param>
<param name="path">To be added: an object of type 'string'</param> <param name="path">The factory path of <see cref="T:Gtk.ItemFactory" />, a string of the form "name".</param>
<param name="accel_group">To be added: an object of type 'Gtk.AccelGroup'</param> <param name="accel_group">A <see cref="T:Gtk.AccelGroup" /> to which the accelerators for the menu items will be added, or <see langword="null" /> to create a new one.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DeleteEntry"> <Member MemberName="DeleteEntry">
@ -156,9 +168,9 @@
<Parameter Name="entry" Type="Gtk.ItemFactoryEntry" /> <Parameter Name="entry" Type="Gtk.ItemFactoryEntry" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Deletes the menu item which was created from <paramref name="entry" /> by the given item factory.</summary>
<param name="entry">To be added: an object of type 'Gtk.ItemFactoryEntry'</param> <param name="entry">A <see cref="T:Gtk.ItemFactoryEntry" />.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CreateItem"> <Member MemberName="CreateItem">
@ -173,11 +185,11 @@
<Parameter Name="callback_type" Type="System.UInt32" /> <Parameter Name="callback_type" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Creates an item for <paramref name="entry" />.</summary>
<param name="entry">To be added: an object of type 'Gtk.ItemFactoryEntry'</param> <param name="entry">The <see cref="T:Gtk.ItemFactoryEntry" /> to create an item for.</param>
<param name="callback_data">To be added: an object of type 'IntPtr'</param> <param name="callback_data">Data passed to the callback method of <paramref name="entry" />.</param>
<param name="callback_type">To be added: an object of type 'uint'</param> <param name="callback_type">1 if the callback method of <paramref name="entry" /> is of type <see cref="T:Gtk.ItemFactoryCallback" />, 2 if it is of type <see cref="T:Gtk.ItemFactoryCallback1" />.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetWidget"> <Member MemberName="GetWidget">
@ -190,7 +202,7 @@
<Parameter Name="action" Type="System.UInt32" /> <Parameter Name="action" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the <paramref name="widget" /> which corresponds to <paramref name="action" />.</summary>
<param name="action">To be added: an object of type 'uint'</param> <param name="action">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'Gtk.Widget'</returns> <returns>To be added: an object of type 'Gtk.Widget'</returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>
@ -206,10 +218,14 @@
<Parameter Name="path" Type="System.String" /> <Parameter Name="path" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the menu item which corresponds to <paramref name="path" />.</summary>
<param name="path">To be added: an object of type 'string'</param> <param name="path">The path to the menu item.</param>
<returns>To be added: an object of type 'Gtk.Widget'</returns> <returns>The menu item for the given path, or <see langword="null" /> if <paramref name="path" /> doesn't lead to a menu item.</returns>
<remarks>To be added</remarks> <remarks>
<para>
If the <paramref name="widget" /> corresponding to <paramref name="path" /> is a menu item which opens a submenum, then the item is returned. If you are interested in the submenum, use <see cref="M:Gtk.ItemFactory.GetWidget" /> instead.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DeleteItem"> <Member MemberName="DeleteItem">
@ -222,9 +238,9 @@
<Parameter Name="path" Type="System.String" /> <Parameter Name="path" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Deletes the menu item which was created for <paramref name="path" /> by the given item factory.</summary>
<param name="path">To be added: an object of type 'string'</param> <param name="path">A path.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PopupData"> <Member MemberName="PopupData">
@ -235,9 +251,13 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the <paramref name="popup_data" /> which was passed to <see cref="M:Gtk.ItemFactory.PopupWithData" />.</summary>
<returns>To be added: an object of type 'IntPtr'</returns> <returns><paramref name="popup_data" /> associated.</returns>
<remarks>To be added</remarks> <remarks>
<para>
This data is available until the menu is popped down again.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CreateItems"> <Member MemberName="CreateItems">
@ -252,11 +272,11 @@
<Parameter Name="callback_data" Type="System.IntPtr" /> <Parameter Name="callback_data" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Creates the menu items from the <paramref name="entries" />.</summary>
<param name="n_entries">To be added: an object of type 'uint'</param> <param name="n_entries">The length of <paramref name="entries" />.</param>
<param name="entries">To be added: an object of type 'Gtk.ItemFactoryEntry'</param> <param name="entries">An array of <see cref="T:Gtk.ItemFactoryEntry" />s whose <paramref name="callback" /> members must be of type <see cref="T:Gtk.ItemFactoryCallback1" />.</param>
<param name="callback_data">To be added: an object of type 'IntPtr'</param> <param name="callback_data">Data passed to the callback methods of all entries.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetWidget"> <Member MemberName="GetWidget">
@ -269,10 +289,14 @@
<Parameter Name="path" Type="System.String" /> <Parameter Name="path" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the <paramref name="widget" /> which corresponds to <paramref name="path" />.</summary>
<param name="path">To be added: an object of type 'string'</param> <param name="path">The path to the <paramref name="widget" />.</param>
<returns>To be added: an object of type 'Gtk.Widget'</returns> <returns>The <paramref name="widget" /> for the given path, or <see langword="null" /> if <paramref name="path" /> doesn't lead to a <paramref name="widget" />.</returns>
<remarks>To be added</remarks> <remarks>
<para>
If the <paramref name="widget" /> corresponding to <paramref name="path" /> is a menu item which opens a submenu, then the submenu is returned. If you are interested in the menu item, use <see cref="M:Gtk:ItemFactory.GetItem" /> instead.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetTranslateFunc"> <Member MemberName="SetTranslateFunc">
@ -287,11 +311,11 @@
<Parameter Name="notify" Type="Gtk.DestroyNotify" /> <Parameter Name="notify" Type="Gtk.DestroyNotify" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets a method to be used for translating the path elements before they are displayed.</summary>
<param name="func">To be added: an object of type 'Gtk.TranslateFunc'</param> <param name="func">The <see cref="T:Gtk.TraslateFunc" /> delegate to be used to traslate path elements.</param>
<param name="data">To be added: an object of type 'IntPtr'</param> <param name="data">Data to pass to <paramref name="func" /> and <paramref name="notify" />.</param>
<param name="notify">To be added: an object of type 'Gtk.DestroyNotify'</param> <param name="notify">A <see cref="T:Gtk.DestroyNotify" /> delegate to be called when the <see cref="T:Gtk.ItemFactory" /> object is destroyed and when the translation is changed again.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
@ -332,12 +356,12 @@
<Parameter Name="accel_group" Type="Gtk.AccelGroup" /> <Parameter Name="accel_group" Type="Gtk.AccelGroup" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A constructor.</summary>
<param name="container_type">To be added: an object of type 'uint'</param> <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="path"></param>
<param name="accel_group">To be added: an object of type 'Gtk.AccelGroup'</param> <param name="accel_group"></param>
<returns>To be added: an object of type 'Gtk.ItemFactory'</returns> <returns>A new instance of <see cref="T:Gtk.ItemFactory" />.</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -346,9 +370,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor.</summary>
<returns>To be added: an object of type 'Gtk.ItemFactory'</returns> <returns>An instance of <see cref="T:Gtk.ItemFactory" />.</returns>
<remarks>To be added</remarks> <remarks>This is an internal constructor, and should not be used by user code.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -394,14 +418,27 @@
<Parameter Name="time_" Type="System.UInt32" /> <Parameter Name="time_" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Pops up the menu constructed form the item factory at (<paramref name="x" />, <paramref name="y" />).</summary>
<param name="popup_data">a <see cref="T:System.IntPtr" /></param> <param name="popup_data">Data available for callbacks while the menu is posted.</param>
<param name="destroy">a <see cref="T:Gtk.DestroyNotify" /></param> <param name="destroy">A <see cref="T:Gtk.DestroyNotify" /> to be called on <paramref name="popup_data" /> when the menu is unposted.</param>
<param name="x">a <see cref="T:System.UInt32" /></param> <param name="x">The x position.</param>
<param name="y">a <see cref="T:System.UInt32" /></param> <param name="y">The y position.</param>
<param name="mouse_button">a <see cref="T:System.UInt32" /></param> <param name="mouse_button">The mouse button which was pressed to initiate the popup.</param>
<param name="time_">a <see cref="T:System.UInt32" /></param> <param name="time_">The time at which the activation event ocurred.</param>
<remarks>To be added</remarks> <remarks>
<para>
Callbacks can access the <paramref name="popup_data" /> while the menu is posted via <see cref="M:Gtk.ItemFactory.PopupData" /> and <see cref="M:Gtk.ItemFactory.PopupDataFromWidget" />.
</para>
<para>
The <paramref name="mouse_button" /> should be the mouse button pressed to initiate the menu popup. If the menu popup was initiated by something other than a mouse button press, such as a mouse button release or a keypress, <paramref name="mouse_button" /> should be 0.
</para>
<para>
The <paramref name="time_" /> should be the time stamp of the event that initiated the popup. If such a event is not available, use <see cref="P:Gtk.Global.CurrentEventTime" /> instead.
</para>
<para>
The operation of the <paramref name="mouse_button" /> and the <paramref name="time_" /> is the same as the <paramref name="button" /> and <paramref name="activation_time" /> for <see cref="M:Gtk.Menu.Popup" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Popup"> <Member MemberName="Popup">
@ -417,13 +454,23 @@
<Parameter Name="time_" Type="System.UInt32" /> <Parameter Name="time_" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Pops up the menu constructed form the item factory at (<paramref name="x" />, <paramref name="y" />).</summary>
<param name="x">a <see cref="T:System.UInt32" /></param> <param name="x">The x position.</param>
<param name="y">a <see cref="T:System.UInt32" /></param> <param name="y">The y position.</param>
<param name="mouse_button">a <see cref="T:System.UInt32" /></param> <param name="mouse_button">The mouse button which was pressed to initiate the popup.</param>
<param name="time_">a <see cref="T:System.UInt32" /></param> <param name="time_">The time at which the activation event ocurred.</param>
<remarks>To be added</remarks> <remarks>
<para>
The <paramref name="mouse_button" /> should be the mouse button pressed to initiate the menu popup. If the menu popup was initiated by something other than a mouse button press, such as a mouse button release or a keypress, <paramref name="mouse_button" /> should be 0.
</para>
<para>
The <paramref name="time_" /> should be the time stamp of the event that initiated the popup. If such a event is not available, use <see cref="P:Gtk.Global.CurrentEventTime" /> instead.
</para>
<para>
The operation of the <paramref name="mouse_button" /> and the <paramref name="time_" /> is the same as the <paramref name="button" /> and <paramref name="activation_time" /> for <see cref="M:Gtk.Menu.Popup" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

9
doc/en/Gtk/TODO
View file

@ -1,9 +1,9 @@
TODO doc for Gtk namespace. TODO doc for Gtk namespace.
There are in total 325 xml to document in Gtk. Right now there are 181 xml not documented in any proportion. There are in total 325 xml to document in Gtk. Right now there are 178 xml not documented in any proportion.
The idea is to have a easy way to know what documentation is missing, if you want to help or are helping please take out the xml that you commit The idea is to have a easy way to know what documentation is missing, if you want to help or are helping please take out the xml that you commit
from the missing list. For documentation that take some time to finish (like HTML, TextBuffer, etc) the best is that you but your name and email next from the missing list. For documentation that take some time to finish (like HTML, TextBuffer, etc) the best is that you but your name and email
to the file in this list to acknowledge that you are working in it (is recommendable that you suscribe to the mono-docs mailing list). next to the file in this list to acknowledge that you are working in it (is recommendable that you suscribe to the mono-docs mailing list).
Following is the list of undocumented xml: Following is the list of undocumented xml:
@ -65,8 +65,6 @@ IMContextSimple.xml
IMMulticontext.xml IMMulticontext.xml
IMPreedStyle.xml IMPreedStyle.xml
IMStatusStyle.xml IMStatusStyle.xml
Icon.xml
IconSize.xml
ImageAnimationData.xml ImageAnimationData.xml
ImageIconSetData.xml ImageIconSetData.xml
ImageImageData.xml ImageImageData.xml
@ -75,7 +73,6 @@ ImagePixmapData.xml
ImageStockData.xml ImageStockData.xml
Init.xml Init.xml
Input.xml Input.xml
ItemFactory.xml
ItemFactoryCallback.xml ItemFactoryCallback.xml
ItemFactoruCallback1.xml ItemFactoruCallback1.xml
ItemFactoryEntry.xml ItemFactoryEntry.xml