2004-12-17 Shane Landrum <epicene@pobox.com>

* en/Gtk/Tooltips.xml
	* en/Gtk/ToggleToolButton.xml
	* en/Gtk/ToolItem.xml
	* en/Gtk/ToolbarChildType.xml
	* en/Gtk/SeparatorToolItem.xml
	* en/Gtk/TooltipSetArgs.xml: Docs for tooltips and toolbar tools.


svn path=/trunk/gtk-sharp/; revision=37895
This commit is contained in:
Shane Landrum 2004-12-17 19:15:25 +00:00
parent 104dbedf07
commit 43932ea8ae
7 changed files with 75 additions and 62 deletions

View File

@ -1,3 +1,12 @@
2004-12-17 Shane Landrum <epicene@pobox.com>
* en/Gtk/Tooltips.xml
* en/Gtk/ToggleToolButton.xml
* en/Gtk/ToolItem.xml
* en/Gtk/ToolbarChildType.xml
* en/Gtk/SeparatorToolItem.xml
* en/Gtk/TooltipSetArgs.xml: Docs for tooltips and toolbar tools.
2004-12-17 Dan Winship <danw@novell.com>
* en/Gnome/FontPicker.xml (SetFontName):

View File

@ -9,8 +9,8 @@
</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>
<summary>Separator object for toolbars.</summary>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.ToolItem</BaseTypeName>
@ -36,22 +36,22 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Override for actions needed before object destruction.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected SeparatorToolItem (GLib.GType gtype);" />
<MemberSignature Language="C#" Value="protected SeparatorToolItem (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Protected constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.SeparatorToolItem" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -62,10 +62,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<summary>Constructor for internal use only.</summary>
<param name="raw">a <see cref="T:System.IntPtr" />, pointer to underlying C object.</param>
<returns>a <see cref="T:Gtk.SeparatorToolItem" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -74,9 +74,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Public constructor.</summary>
<returns>a <see cref="T:Gtk.SeparatorToolItem" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -87,9 +87,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The <see cref="T:GLib.GType" /> of this object. </summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Draw">
@ -100,10 +100,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Returns whether this object is drawn as a line (true), or
just blank (false). </summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -9,8 +9,8 @@
</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>
<summary>A base class for toolbar buttons that behave like toggles.</summary>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.ToolButton</BaseTypeName>
@ -36,8 +36,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Override to perform actions before object destruction.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="OnToggled">
@ -60,10 +60,10 @@
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Protected constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.ToggleToolButton" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -74,10 +74,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<summary>Constructor for internal use.</summary>
<param name="raw">a <see cref="T:System.IntPtr" />, pointer to underlying C object.</param>
<returns>a <see cref="T:Gtk.ToggleToolButton" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -86,9 +86,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Public constructor.</summary>
<returns>a <see cref="T:Gtk.ToggleToolButton" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -99,10 +99,10 @@
<Parameter Name="stock_id" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="stock_id">a <see cref="T:System.String" /></param>
<summary>Public constructor for use with stock items.</summary>
<param name="stock_id">a <see cref="T:System.String" />, the id of a stock item whose icon and label you want to use</param>
<returns>a <see cref="T:Gtk.ToggleToolButton" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -113,9 +113,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The <see cref="T:GLib.GType" /> of this object.</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Active">
@ -126,9 +126,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>The current state of the toggle button.</summary>
<returns>a <see cref="T:System.Boolean" />, true if button is pressed in and false if it is raised.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Toggled">
@ -139,9 +139,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted whenever the toggle button changes state.</summary>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -223,7 +223,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The <see cref="T:GLib.GType" /> of this object.</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks/>
</Docs>

View File

@ -52,8 +52,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Add blank space to the toolbar.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GtkToolbarChildButton">
@ -65,8 +65,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Add buttons to the toolbar.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GtkToolbarChildTogglebutton">
@ -78,8 +78,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Add toggle buttons to the toolbar.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GtkToolbarChildRadiobutton">
@ -91,8 +91,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Add radio buttons to the toolbar.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GtkToolbarChildWidget">
@ -104,8 +104,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Add widgets to the toolbar.</summary>
<remarks></remarks>
</Docs>
</Member>
</Members>

View File

@ -39,9 +39,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The tooltips group.</summary>
<returns>a <see cref="T:Gtk.Tooltips" /></returns>
<remarks>To be added</remarks>
<remarks>(XXX: should this be the entire tooltips group, or just the tooltip that was set?)</remarks>
</Docs>
</Member>
<Member MemberName="TipText">
@ -52,9 +52,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The public tooltip text that was set.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="TipPrivate">
@ -65,10 +65,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The private/detail tooltip text that was set.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -210,9 +210,9 @@ class ToolTipsExample
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>Number of milliseconds of mouse-hover before tooltips pop up.</summary>
<returns>a <see cref="T:System.UInt32" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetInfoFromTipWindow">
@ -227,13 +227,16 @@ class ToolTipsExample
<Parameter Name="current_widget" Type="Gtk.Widget" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary> Determines the tooltips and the widget they belong
to from the window in which they are displayed. </summary>
<param name="tip_window">a <see cref="T:Gtk.Window" /></param>
<param name="tooltips">a <see cref="T:Gtk.Tooltips" /></param>
<param name="current_widget">a <see cref="T:Gtk.Widget" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>This function is mostly intended for use by
accessibility technologies; applications should have little use for
it.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>