2004-08-27 Shane Landrum <epicene@pobox.com>

* en/Gtk/Style.xml: bugfixes, more docs.
	* en/Gtk/TextBTree.xml: internal class, do not use.
	* en/Gtk/Accel*.xml: Accelerator-related docs.
	* en/Gtk/CurrentParagraphAlignmentChangedArgs.xml
	* en/Gtk/CurrentParagraphStyleChangedArgs.xml: Event data docs.

svn path=/trunk/gtk-sharp/; revision=32960
This commit is contained in:
Shane Landrum 2004-08-28 02:40:04 +00:00
parent fa3e9a5e70
commit 2d2b5a2157
13 changed files with 65 additions and 56 deletions

View File

@ -1,3 +1,11 @@
2004-08-27 Shane Landrum <epicene@pobox.com>
* en/Gtk/Style.xml: bugfixes, more docs.
* en/Gtk/TextBTree.xml: internal class, do not use.
* en/Gtk/Accel*.xml: Accelerator-related docs.
* en/Gtk/CurrentParagraphAlignmentChangedArgs.xml
* en/Gtk/CurrentParagraphStyleChangedArgs.xml: Event data docs.
2004-08-27 Shane Landrum <epicene@pobox.com>
* en/Gtk/WindowKeysForeachFunc.xml

View File

@ -39,9 +39,9 @@
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>A pointer to the accelerator that was changed.</summary>
<returns>To be added: an object of type 'IntPtr'</returns>
<remarks>To be added</remarks>
<summary>A pointer to the underlying C data of the accelerator that was changed.</summary>
<returns>A <see cref="T:IntPtr"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="Modifier">
@ -69,4 +69,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -7,8 +7,9 @@
</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 delegate to activate all the accelerators in a given
<see cref="T:Gtk.AccelGroup"/>.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -32,4 +33,4 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
</Type>
</Type>

View File

@ -10,8 +10,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>One item within a <see cref="T:Gtk.AccelGroup"/>.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>An empty <see cref="T:Gtk.AccelGroupEntry"/>.</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="New">
@ -41,10 +41,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gtk.AccelGroupEntry'</returns>
<remarks>To be added</remarks>
<summary>Internal constructor; do not use.</summary>
<param name="raw"><see cref="T:IntPtr"/>, pointer to the underlying C object.</param>
<returns>a <see cref="T:Gtk.AccelGroupEntry"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="Key">
@ -56,8 +56,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The key for this accelerator.</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="AccelPathQuark">
@ -74,4 +74,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 delegate to locate a particular accelerator.</summary>
<remarks>See <see cref="M:Gtk.AccelGroup.Find"/>.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -32,4 +32,4 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
</Type>
</Type>

View File

@ -96,7 +96,7 @@
<Parameter Name="flags" Type="Gtk.AccelFlags" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Public constructor.</summary>
<param name="key">a <see cref="T:System.Int32" /> enumerated in <see cref="T:Gdk.Key" /></param>
<param name="mods">a <see cref="T:System.Int32" /> enumerated in <see cref="T:Gdk.ModifierType" />, the modifiers (shift, ctrl, etc) that apply for this AccelKey</param>
<param name="flags">a <see cref="T:System.Int32" /> enumerated in <see cref="T:Gdk.AccelFlags" /> for whether this AccelKey should be displayed in the menu</param>
@ -105,4 +105,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -127,8 +127,8 @@
</Parameters>
<Docs>
<summary>Sets the closure to be monitored by this accelerator label.</summary>
<param name="value">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'IntPtr'</returns>
<param name="value">A <see cref="T:IntPtr"/></param>
<returns>A <see cref="T:IntPtr"/></returns>
<remarks>
<para>
Sets the closure to be monitored by this accelerator label. The closure must be connected to an accelerator group. See <see cref="P:Gtk.AccelLabel.AccelWidget" />.
@ -183,4 +183,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -7,8 +7,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 delegate for running over each entry in an accelerator.</summary>
<remarks>See <see cref="M:Gtk.Accel.MapForeach"/>.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -33,4 +33,4 @@
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>

View File

@ -10,8 +10,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>An accelerator.</summary>
<remarks>TODO: explain the relationship between this class and <see cref="T:Gtk.Accel"/>.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -75,10 +75,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>A mask to specify the default modifier key(s).</summary>
<param name="value">a <see cref="T:Gdk.ModifierType" /></param>
<returns>a <see cref="T:Gdk.ModifierType" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="Parse">
@ -93,12 +93,12 @@
<Parameter Name="accelerator_mods" Type="Gdk.ModifierType&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary> Parses a string representing an accelerator. The format looks like "&lt;Control&gt;a" or "&lt;Shift&gt;&lt;Alt&gt;F1" or "&lt;Release&gt;z" (the last one is for key release). The parser is fairly liberal and allows lower or upper case, and also abbreviations such as "&lt;Ctl&gt;" and "&lt;Ctrl&gt;".</summary>
<param name="accelerator">a <see cref="T:System.String" /></param>
<param name="accelerator_key">a <see cref="T:System.UInt32&amp;" /></param>
<param name="accelerator_mods">a <see cref="T:Gdk.ModifierType&amp;" /></param>
<remarks>To be added</remarks>
<param name="accelerator_key">a <see cref="T:System.UInt32&amp;" />, thekey to map to.</param>
<param name="accelerator_mods">a <see cref="T:Gdk.ModifierType&amp;" /> to fill with data.</param>
<remarks>If the parse fails, <paramref name="accelerator_key"/> and <paramref name="accelerator_mods"/> will be set to 0 (zero).</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -41,8 +41,8 @@
<Docs>
<summary>The new alignment of the paragraph.</summary>
<returns>a <see cref="Gtk.HTMLParagraphAlignment" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -39,10 +39,10 @@
<ReturnType>Gtk.HTMLParagraphStyle</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.HTMLParagraphStyle'</returns>
<remarks>To be added</remarks>
<summary>The new style that was set.</summary>
<returns>a <see cref="T:Gtk.HTMLParagraphStyle"/></returns>
<remarks/>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -200,7 +200,7 @@ color or pixmap specified by this style for <paramref name="state"/>.</summary>
<Parameter Name="stock_id" Type="System.String" />
</Parameters>
<Docs>
<summary>Gets the icon set for the given <paramref name="stock_id">.</summary>
<summary>Gets the icon set for the given <paramref name="stock_id"/>.</summary>
<param name="stock_id">A <see cref="T:System.String"/></param>
<returns>A <see cref="T:Gtk.IconSet"/></returns>
<remarks/>
@ -359,9 +359,9 @@ color or pixmap specified by this style for <paramref name="state"/>.</summary>
<ReturnType>Gdk.GC []</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>Gets the graphics context objects for the background.</summary>
<returns>A <see cref="T:Gdk.GC []"/></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="ForegroundGCs">
@ -371,9 +371,9 @@ color or pixmap specified by this style for <paramref name="state"/>.</summary>
<ReturnType>Gdk.GC []</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>Gets the graphics context objects for the foreground.</summary>
<returns>A <see cref="T:Gdk.GC []"/></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="BlackGC">
@ -383,9 +383,9 @@ color or pixmap specified by this style for <paramref name="state"/>.</summary>
<ReturnType>Gdk.GC</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>Gets a white graphics context.</summary>
<returns>A <see cref="T:Gdk.GC"/></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="WhiteGC">
@ -395,9 +395,9 @@ color or pixmap specified by this style for <paramref name="state"/>.</summary>
<ReturnType>Gdk.GC</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>Gets a black graphics context.</summary>
<returns>A <see cref="T:Gdk.GC"/></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="SetForegroundGC">

View File

@ -10,8 +10,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>Internal class. Do not use.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
@ -40,4 +40,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>