2005-01-05 Shane Landrum <epicene@pobox.com>

* en/Gtk/XEmbedMessageType.xml
	* en/Gtk/TargetPair.xml : Marked "Do not use."
	* en/Gtk/ToggleAction.xml
	* en/Gtk/Socket.xml
	* en/Gtk/Style.xml
	* en/Gtk/ToggleActionEntry.xml
	* en/Gtk/VButtonBox.xml: Added docs.


svn path=/trunk/gtk-sharp/; revision=38397
This commit is contained in:
Shane Landrum 2005-01-05 22:40:29 +00:00
parent 2eb246518a
commit 4e699edd17
8 changed files with 141 additions and 98 deletions

View file

@ -1,3 +1,13 @@
2005-01-05 Shane Landrum <epicene@pobox.com>
* en/Gtk/XEmbedMessageType.xml
* en/Gtk/TargetPair.xml : Marked "Do not use."
* en/Gtk/ToggleAction.xml
* en/Gtk/Socket.xml
* en/Gtk/Style.xml
* en/Gtk/ToggleActionEntry.xml
* en/Gtk/VButtonBox.xml: Added docs.
2005-01-05 Shane Landrum <epicene@pobox.com> 2005-01-05 Shane Landrum <epicene@pobox.com>
* en/Gtk/SignalFunc.xml * en/Gtk/SignalFunc.xml

View file

@ -205,10 +205,21 @@ Console.WriteLine ("The ID of the sockets window is {0}", socket.Id);
<Parameter Name="wid" Type="System.UInt32" /> <Parameter Name="wid" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<param name="wid">a <see cref="T:System.UInt32" /></param> Reparents a pre-existing toplevel window into a <see cref="T:Gtk.Socket" />.
<remarks>To be added</remarks> </summary>
<param name="wid">a <see cref="T:System.UInt32" />, the window
ID of an existing toplevel window.</param>
<remarks>
This is meant to embed clients that do not know about
embedding into a <see cref="T:Gtk.Socket" />, however doing
so is inherently unreliable, and using this function is not
recommended.
The <see cref="T:Gtk.Socket" /> must have already been added
into a toplevel window before you can make this call.
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

View file

@ -1425,9 +1425,14 @@ color or pixmap specified by this style for <paramref name="state" />.</summary>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Deprecated.</summary>
<returns>a <see cref="T:Gdk.Font" /></returns> <returns>a <see cref="T:Gdk.Font" /></returns>
<remarks>To be added</remarks> <remarks>
The <see cref="T:Gdk.Font"/> to use for a given style. This
is deprecated and should not be used in new code. New code
should use <see cref="P:Gtk.Style.FontDescription"/>
instead.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Unrealize"> <Member MemberName="Unrealize">
@ -1438,8 +1443,16 @@ color or pixmap specified by this style for <paramref name="state" />.</summary>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>
<remarks>To be added</remarks> Event fired when the aspects of the style specific to a
particular colormap and depth are being cleaned up.
</summary>
<remarks>
A connection to this signal can be useful if a widget wants
to cache objects like a <see cref="T:Gdk.GC"/> as object
data on <see cref="T:Gtk.Style"/>. This signal provides a
convenient place to free such cached objects.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Realize"> <Member MemberName="Realize">
@ -1450,8 +1463,15 @@ color or pixmap specified by this style for <paramref name="state" />.</summary>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>
<remarks>To be added</remarks> Event triggered when the style has been initialized for a particular
colormap and depth.
</summary>
<remarks>
Connecting to this signal is probably seldom
useful since most of the time applications and widgets only
deal with styles that have been already realized.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnUnrealize"> <Member MemberName="OnUnrealize">
@ -1486,9 +1506,9 @@ color or pixmap specified by this style for <paramref name="state" />.</summary>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Deprecated. Do not use.</summary>
<returns>a <see cref="T:Gtk.Style" /></returns> <returns>a <see cref="T:Gtk.Style" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Unref"> <Member MemberName="Unref">
@ -1499,9 +1519,9 @@ color or pixmap specified by this style for <paramref name="state" />.</summary>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Deprecated. Do not use.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

View file

@ -56,7 +56,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Do not use.</summary>
<param name="value">a <see cref="T:Gdk.Atom" /></param> <param name="value">a <see cref="T:Gdk.Atom" /></param>
<returns>a <see cref="T:Gdk.Atom" /></returns> <returns>a <see cref="T:Gdk.Atom" /></returns>
<remarks /> <remarks />
@ -71,7 +71,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Do not use.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -84,7 +84,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Do not use.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>

View file

@ -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>An action which can be toggled between two states</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.Action</BaseTypeName> <BaseTypeName>Gtk.Action</BaseTypeName>
@ -58,8 +58,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fires the <see cref="E:Gtk.ToggleAction.Toggled"/> event.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -85,7 +85,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Internal constructor</summary> <summary>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> label displayed in menu items and on buttons <param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gtk.ToggleAction" /></returns> <returns>a <see cref="T:Gtk.ToggleAction" /></returns>
<remarks>This is not typically used by C# code.</remarks> <remarks>This is not typically used by C# code.</remarks>
</Docs> </Docs>
@ -101,13 +101,13 @@
<Parameter Name="stock_id" Type="System.String" /> <Parameter Name="stock_id" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor.</summary>
<param name="name">a <see cref="T:System.String" /></param> <param name="name">a <see cref="T:System.String" />, a unique name for the action</param>
<param name="label">a <see cref="T:System.String" /></param> <param name="label">a <see cref="T:System.String" />, the label displayed in menu items and on buttons</param>
<param name="tooltip">a <see cref="T:System.String" /></param> <param name="tooltip">a <see cref="T:System.String" />, a tooltip for the action</param>
<param name="stock_id">a <see cref="T:System.String" /></param> <param name="stock_id">a <see cref="T:System.String" />, the stock icon to display in widgets representing the action</param>
<returns>a <see cref="T:Gtk.ToggleAction" /></returns> <returns>a <see cref="T:Gtk.ToggleAction" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -131,9 +131,11 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>
Whether the action should have proxies like a radio action.
</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Active"> <Member MemberName="Active">
@ -144,9 +146,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the checked state on the toggle action.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" />, <see langword="true"/> if checked</returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Toggled"> <Member MemberName="Toggled">
@ -157,9 +159,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Event fired when the toggle is changed.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

View file

@ -121,11 +121,11 @@
<Parameter Name="stock_id" Type="System.String" /> <Parameter Name="stock_id" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor</summary>
<param name="name">a <see cref="T:System.String" /></param> <param name="name">a <see cref="T:System.String" />, a unique name for the action</param>
<param name="stock_id">a <see cref="T:System.String" /></param> <param name="stock_id">a <see cref="T:System.String" />, the stock icon to display in widgets representing the action</param>
<returns>a <see cref="T:Gtk.ToggleActionEntry" /></returns> <returns>a <see cref="T:Gtk.ToggleActionEntry" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -138,12 +138,12 @@
<Parameter Name="activated" Type="System.EventHandler" /> <Parameter Name="activated" Type="System.EventHandler" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor</summary>
<param name="name">a <see cref="T:System.String" /></param> <param name="name">a <see cref="T:System.String" />, a unique name for the action</param>
<param name="stock_id">a <see cref="T:System.String" /></param> <param name="stock_id">a <see cref="T:System.String" />, the stock icon to display in widgets representing the action</param>
<param name="activated">a <see cref="T:System.EventHandler" /></param> <param name="activated">a <see cref="T:System.EventHandler" />, a method to call when the toggle action is activated</param>
<returns>a <see cref="T:Gtk.ToggleActionEntry" /></returns> <returns>a <see cref="T:Gtk.ToggleActionEntry" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -157,13 +157,13 @@
<Parameter Name="active" Type="System.Boolean" /> <Parameter Name="active" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor</summary>
<param name="name">a <see cref="T:System.String" /></param> <param name="name">a <see cref="T:System.String" />, a unique name for the action</param>
<param name="stock_id">a <see cref="T:System.String" /></param> <param name="stock_id">a <see cref="T:System.String" />, the stock icon to display in widgets representing the action</param>
<param name="activated">a <see cref="T:System.EventHandler" /></param> <param name="activated">a <see cref="T:System.EventHandler" />, a method to call when the toggle action is activated</param>
<param name="active">a <see cref="T:System.Boolean" /></param> <param name="active">a <see cref="T:System.Boolean" />, <see langword="true"/> if the toggle action is currently checked</param>
<returns>a <see cref="T:Gtk.ToggleActionEntry" /></returns> <returns>a <see cref="T:Gtk.ToggleActionEntry" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -180,16 +180,16 @@
<Parameter Name="active" Type="System.Boolean" /> <Parameter Name="active" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor</summary>
<param name="name">a <see cref="T:System.String" /></param> <param name="name">a <see cref="T:System.String" />, a unique name for the action</param>
<param name="stock_id">a <see cref="T:System.String" /></param> <param name="stock_id">a <see cref="T:System.String" />, the stock icon to display in widgets representing the action</param>
<param name="label">a <see cref="T:System.String" /></param> <param name="label">a <see cref="T:System.String" />, the label displayed in menu items and on buttons</param>
<param name="accelerator">a <see cref="T:System.String" /></param> <param name="accelerator">a <see cref="T:System.String" />, the accelerator key sequence for the action</param>
<param name="tooltip">a <see cref="T:System.String" /></param> <param name="tooltip">a <see cref="T:System.String" />, a tooltip for the action</param>
<param name="activated">a <see cref="T:System.EventHandler" /></param> <param name="activated">a <see cref="T:System.EventHandler" />, a method to call when the toggle action is activated</param>
<param name="active">a <see cref="T:System.Boolean" /></param> <param name="active">a <see cref="T:System.Boolean" />, <see langword="true"/> if the toggle action is currently checked</param>
<returns>a <see cref="T:Gtk.ToggleActionEntry" /></returns> <returns>a <see cref="T:Gtk.ToggleActionEntry" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -10,7 +10,7 @@
</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>A button box should be used to provide a consistent layout of buttons throughout your application. This box provides a way of</summary> <summary>A button box should be used to provide a consistent layout of buttons throughout your application. This box provides a way of laying out buttons vertically.</summary>
<remarks> <remarks>
<para>The layout of buttons in this type of box is determined by the box's <see cref="T:Gtk.ButtonBoxStyle" />.</para> <para>The layout of buttons in this type of box is determined by the box's <see cref="T:Gtk.ButtonBoxStyle" />.</para>
<para>Methods for manipulating button boxes are provided in the super classes, <see cref="T:Gtk.ButtonBox" /> and <see cref="T:Gtk.Box" />.</para> <para>Methods for manipulating button boxes are provided in the super classes, <see cref="T:Gtk.ButtonBox" /> and <see cref="T:Gtk.Box" />.</para>
@ -109,9 +109,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The default layout style for vertical button boxes.</summary>
<returns>a <see cref="T:Gtk.ButtonBoxStyle" /></returns> <returns>a <see cref="T:Gtk.ButtonBoxStyle" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SpacingDefault"> <Member MemberName="SpacingDefault">
@ -122,10 +122,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The default spacing (in pixels) for vertical button boxes.</summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

View file

@ -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>Internal. Do not use.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Enum</BaseTypeName> <BaseTypeName>System.Enum</BaseTypeName>
@ -37,8 +37,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal. Do not use.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="WindowActivate"> <Member MemberName="WindowActivate">
@ -50,8 +50,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal. Do not use.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="WindowDeactivate"> <Member MemberName="WindowDeactivate">
@ -63,8 +63,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal. Do not use.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RequestFocus"> <Member MemberName="RequestFocus">
@ -76,8 +76,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal. Do not use.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="FocusIn"> <Member MemberName="FocusIn">
@ -89,8 +89,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal. Do not use.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="FocusOut"> <Member MemberName="FocusOut">
@ -102,8 +102,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal. Do not use.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="FocusNext"> <Member MemberName="FocusNext">
@ -115,8 +115,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal. Do not use.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="FocusPrev"> <Member MemberName="FocusPrev">
@ -128,8 +128,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal. Do not use.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GrabKey"> <Member MemberName="GrabKey">
@ -141,8 +141,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal. Do not use.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="UngrabKey"> <Member MemberName="UngrabKey">
@ -154,8 +154,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal. Do not use.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ModalityOn"> <Member MemberName="ModalityOn">
@ -167,8 +167,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal. Do not use.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ModalityOff"> <Member MemberName="ModalityOff">
@ -180,8 +180,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal. Do not use.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GtkGrabKey"> <Member MemberName="GtkGrabKey">
@ -193,8 +193,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal. Do not use.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GtkUngrabKey"> <Member MemberName="GtkUngrabKey">
@ -206,8 +206,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal. Do not use.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="value__"> <Member MemberName="value__">
@ -224,4 +224,4 @@
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>