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

* en/Gtk/FontSelectionDialog.xml: Doc 1 property
	* en/Gtk/TargetEntry.xml
	* en/Gtk/TargetPair.xml
	* en/Gtk/SelectionData.xml
	* en/Gtk/SelectionGetArgs.xml
	* en/Gtk/SelectionNotifyEventArgs.xml
	* en/Gtk/SelectionRequestEventArgs.xml: Docs for selection-related
	and DND code.
	* en/Gtk/Stock.xml: Doc some new items for 2.4
	* en/Gtk/ToolButton.xml: Add docs


svn path=/trunk/gtk-sharp/; revision=37890
This commit is contained in:
Shane Landrum 2004-12-17 17:52:22 +00:00
parent fb2a4b6c9a
commit 93209fbd15
10 changed files with 113 additions and 81 deletions

View File

@ -1,3 +1,16 @@
2004-12-17 Shane Landrum <epicene@pobox.com>
* en/Gtk/FontSelectionDialog.xml: Doc 1 property
* en/Gtk/TargetEntry.xml
* en/Gtk/TargetPair.xml
* en/Gtk/SelectionData.xml
* en/Gtk/SelectionGetArgs.xml
* en/Gtk/SelectionNotifyEventArgs.xml
* en/Gtk/SelectionRequestEventArgs.xml: Docs for selection-related
and DND code.
* en/Gtk/Stock.xml: Doc some new items for 2.4
* en/Gtk/ToolButton.xml: Add docs
2004-12-17 Shane Landrum <epicene@pobox.com>
* en/Gtk/RadioAction.xml

View File

@ -159,10 +159,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The font that was selected using the dialog.</summary>
<returns>a <see cref="T:Gdk.Font" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -52,8 +52,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<summary>
Assuming that this selection data object holds a list
of targets, determines if any of the targets in can be used to
provide text.</summary>
<returns>a <see cref="T:System.Boolean"/></returns>
<remarks />
</Docs>
</Member>
@ -93,9 +96,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The unit length of the data in bits.</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks />
<remarks>On most systems, this is 8 for a string and 32 for
an integer.</remarks>
</Docs>
</Member>
<Member MemberName="Length">
@ -151,11 +155,11 @@
<Parameter Name="length" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets the data for a selection.</summary>
<param name="type">a <see cref="T:Gdk.Atom" /></param>
<param name="format">a <see cref="T:System.Int32" /></param>
<param name="data">a <see cref="T:System.Byte" /></param>
<param name="length">a <see cref="T:System.Int32" /></param>
<param name="format">a <see cref="T:System.Int32" />, the number of bits per data unit</param>
<param name="data">a <see cref="T:System.Byte[]" />, the data to be set</param>
<param name="length">a <see cref="T:System.Int32" />, the length of the data.</param>
<remarks />
</Docs>
</Member>
@ -171,10 +175,10 @@
<Parameter Name="data" Type="System.Byte[]" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets the data for a selection.</summary>
<param name="type">a <see cref="T:Gdk.Atom" /></param>
<param name="format">a <see cref="T:System.Int32" /></param>
<param name="data">a <see cref="T:System.Byte" /></param>
<param name="format">a <see cref="T:System.Int32" />, the number of bits per data unit</param>
<param name="data">a <see cref="T:System.Byte[]" />, the data to be set</param>
<remarks />
</Docs>
</Member>
@ -186,9 +190,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The selected data.</summary>
<returns>a <see cref="T:Gdk.Atom" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Target">
@ -199,9 +203,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The type of target being used.</summary>
<returns>a <see cref="T:Gdk.Atom" /></returns>
<remarks>To be added</remarks>
<remarks>XXX: Add a list of useful strings for target types.</remarks>
</Docs>
</Member>
<Member MemberName="Targets">
@ -212,9 +216,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Gets the selection data as an array of targets.</summary>
<returns>a <see cref="T:Gdk.Atom[]" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Type">
@ -225,10 +229,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The type of selection data</summary>
<returns>a <see cref="T:Gdk.Atom" /></returns>
<remarks>To be added</remarks>
<remarks>XXX: elaborate on the possible values here.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -51,7 +51,7 @@
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>An enumerator to identify the specific target for this selection.</summary>
<returns>A <see cref="T:System.UInt32" /></returns>
<remarks />
</Docs>
@ -69,4 +69,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -39,10 +39,10 @@
<ReturnType>Gdk.EventSelection</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.EventSelection'</returns>
<remarks>To be added</remarks>
<summary>The event which triggered this callback.</summary>
<returns>A <see cref="T:Gdk.EventSelection"/></returns>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -39,10 +39,10 @@
<ReturnType>Gdk.EventSelection</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.EventSelection'</returns>
<remarks>To be added</remarks>
<summary>The event which triggered this callback.</summary>
<returns>A <see cref="T:Gdk.EventSelection"/></returns>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -978,9 +978,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The "Harddisk" item.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Indent">
@ -991,9 +991,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The "Indent" item.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Network">
@ -1004,9 +1004,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The "Network" item.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Unindent">
@ -1017,10 +1017,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The "Unindent" item.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -74,8 +74,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks />
<summary>The target type.</summary>
<remarks>Some common types include "STRING", "GTK_TREE_MODEL_ROW",
"TEXT", "UTF8_STRING"; this is not an exhaustive list, and any given
application may define its own targets.</remarks>
</Docs>
</Member>
<Member MemberName="Flags">
@ -100,9 +102,9 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>A unique identifier for a target.</summary>
<remarks />
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -27,7 +27,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>An empty target.</summary>
<remarks />
</Docs>
</Member>
@ -41,8 +41,8 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">a <see cref="T:IntPtr" /></param>
<summary>Constructor for internal use only.</summary>
<param name="raw">a <see cref="T:IntPtr" />, pointer to the underlying C structure.</param>
<returns>a <see cref="T:Gtk.TargetPair" /></returns>
<remarks />
</Docs>
@ -89,4 +89,4 @@
</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 button for a toolbar.</summary>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.ToolItem</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="OnClicked">
@ -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.ToolButton" /></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 only.</summary>
<param name="raw">a <see cref="T:System.IntPtr" />, pointer to underlying C object.</param>
<returns>a <see cref="T:Gtk.ToolButton" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -89,11 +89,11 @@
<Parameter Name="label" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="icon_widget">a <see cref="T:Gtk.Widget" /></param>
<param name="label">a <see cref="T:System.String" /></param>
<summary>Public constructor</summary>
<param name="icon_widget">a <see cref="T:Gtk.Widget" />, a widget that will be used as icon widget, or <see langword="null"/> </param>
<param name="label">a <see cref="T:System.String" />, a label for this button, or <see langword="null"/></param>
<returns>a <see cref="T:Gtk.ToolButton" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -104,10 +104,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 that uses a stock item.</summary>
<param name="stock_id">a <see cref="T:System.String" />, the name of the stock item</param>
<returns>a <see cref="T:Gtk.ToolButton" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -118,9 +118,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="Label">
@ -131,9 +131,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The label for this button.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="StockId">
@ -144,9 +144,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>If this is a stock item, the ID for the stock item.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="LabelWidget">
@ -157,9 +157,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The label for this button in widget form.</summary>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IconWidget">
@ -170,9 +170,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The icon for this button, in widget form.</summary>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="UseUnderline">
@ -183,9 +183,21 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Whether the button label has the form "_Open".</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>
<para>
If set, an underline in the label property indicates that the next character
should be used for the mnemonic accelerator key in the overflow menu. For
example, if the label property is "_Open" and this property is set,
the label on the tool button will be "Open" and the item on the overflow
menu will have an underlined 'O'.
</para>
<para>
Labels shown on tool buttons never have mnemonics on them; this property
only affects the menu item on the overflow menu.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Clicked">
@ -196,9 +208,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>This signal is emitted when the tool button is clicked with
the mouse or activated with the keyboard.</summary>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>