ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

First draft for HandleBox and PositionType docs.

Browse source 
svn path=/trunk/gtk-sharp/; revision=12457
This commit is contained in:
Lee Mallabone 2003-03-12 09:11:18 +00:00
parent bdf6fff51d
commit f9ea290f18
3 changed files with 45 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/ChangeLog
View file

@ -1,3 +1,8 @@
2003-03-12 Lee Mallabone <mono-docs@fonicmonkey.net>
* en/Gtk/PositionType.xml:
* en/Gtk/HandleBox.xml: First draft docs.
2003-03-11 Lee Mallabone <mono-docs@fonicmonkey.net> 2003-03-11 Lee Mallabone <mono-docs@fonicmonkey.net>
* en/Gtk/Range.xml: First draft. * en/Gtk/Range.xml: First draft.

55
doc/en/Gtk/HandleBox.xml
View file

@ -1,5 +1,5 @@
<Type Name="HandleBox" FullName="Gtk.HandleBox"> <Type Name="HandleBox" FullName="Gtk.HandleBox">
<TypeSignature Language="C#" Value="public class HandleBox : Gtk.Bin, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" /> <TypeSignature Language="C#" Value="public class HandleBox : Gtk.Bin, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
<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,11 @@
</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 container with a handle and a detachable child widget.</summary>
<remarks>To be added</remarks> <remarks><para>The HandleBox widget allows a portion of a window to be &quot;torn off&quot;. It is a <see cref="T:Gtk.Bin"/> widget that displays its child with a handle that the user can drag to create a separate floating window containing the child widget and the 'handle'.</para>
<para>A thin ghost is drawn in the original location of the HandleBox. By dragging the separate window back to its original location, it can be reattached. When reattaching, the ghost and float window, must be aligned along one of the edges, the <see cref="P:Gtk.HandlBox.SnapEdge"/>. This can either be specified by the application programmer explicitly, otherwise a reasonable default will be used, based on the <see cref="P:Gtk.HandleBox.HandlePosition"/>.</para>
<para>To make detaching and reattaching the HandleBox as minimally confusing as possible to the user, it is important to set the snap edge so that it does not move when the HandleBox is deattached. For instance, if the HandleBox is packed at the bottom of a <see cref="T:Gtk.VBox"/>, then when the HandleBox is detached, the bottom edge of the HandleBox's allocation will remain fixed as the height of the HandleBox shrinks, so the snap edge should be set to <see cref="P:Gtk.PositionType.Bottom"/>.</para>
<para>The child of this widget is set using the <see cref="M:Gtk.Container.Add"/> method in <see cref="T:Gtk.Container"/>.</para></remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.Bin</BaseTypeName> <BaseTypeName>Gtk.Bin</BaseTypeName>
@ -63,9 +66,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The main way to create a HandleBox.</summary>
<returns>To be added: an object of type 'Gtk.HandleBox'</returns> <returns>A new HandleBox.</returns>
<remarks>To be added</remarks> <remarks><para>Creates a new HandleBox, with the <see cref="P:Gtk.HandleBox.HandlePosition"/> set to the <see cref="P:Gtk.PositionType.Left"/>.</para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -90,10 +93,10 @@
<Parameter Name="value" Type="Gtk.PositionType" /> <Parameter Name="value" Type="Gtk.PositionType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Manage which edge a detached HandleBox must reattach to.</summary>
<param name="value">To be added: an object of type 'Gtk.PositionType'</param> <param name="value">The new edge</param>
<returns>To be added: an object of type 'Gtk.PositionType'</returns> <returns>The current edge that snapping works with.</returns>
<remarks>To be added</remarks> <remarks><para>To ensure good usability, this edge should be set to a side of the HandleBox whose position or size will not be altered when the child is detached.</para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ShadowType"> <Member MemberName="ShadowType">
@ -106,10 +109,10 @@
<Parameter Name="value" Type="Gtk.ShadowType" /> <Parameter Name="value" Type="Gtk.ShadowType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Manage the appearance of the <see cref="T:Gtk.Container"/> surrounding the child widget.</summary>
<param name="value">To be added: an object of type 'Gtk.ShadowType'</param> <param name="value">The new style of shadow to use for this HandleBox.</param>
<returns>To be added: an object of type 'Gtk.ShadowType'</returns> <returns>The current style of shadow in use.</returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="HandlePosition"> <Member MemberName="HandlePosition">
@ -122,10 +125,10 @@
<Parameter Name="value" Type="Gtk.PositionType" /> <Parameter Name="value" Type="Gtk.PositionType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Manage where the handle of this container is placed.</summary>
<param name="value">To be added: an object of type 'Gtk.PositionType'</param> <param name="value">A new position for the handle.</param>
<returns>To be added: an object of type 'Gtk.PositionType'</returns> <returns>The current position of the handle.</returns>
<remarks>To be added</remarks> <remarks><para>Note: In western cultures, anything other than a <see cref="P:Gtk.PositionType.Left"/> handle for horizontal HandleBoxes, or a <see cref="P:Gtk.PositionType.Top"/> handle for vertical HandleBoxes, may seem strange to users.</para><para>The reverse is likely to be true for cultures with languages that are written from right to left.</para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Shadow"> <Member MemberName="Shadow">
@ -138,10 +141,10 @@
<Parameter Name="value" Type="Gtk.ShadowType" /> <Parameter Name="value" Type="Gtk.ShadowType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Manage the appearance of the <see cref="T:Gtk.Container"/> surrounding the child widget.</summary>
<param name="value">To be added: an object of type 'Gtk.ShadowType'</param> <param name="value">The new style of shadow to use for this HandleBox.</param>
<returns>To be added: an object of type 'Gtk.ShadowType'</returns> <returns>The current style of shadow in use.</returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ChildAttached"> <Member MemberName="ChildAttached">
@ -150,8 +153,8 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>This event is fired when the contents of the HandleBox are reattached to the main window. </summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ChildDetached"> <Member MemberName="ChildDetached">
@ -160,8 +163,8 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>This event is fired when the contents of the handlebox are detached from the main window.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">

22
doc/en/Gtk/PositionType.xml
View file

@ -1,5 +1,5 @@
<Type Name="PositionType" FullName="Gtk.PositionType"> <Type Name="PositionType" FullName="Gtk.PositionType">
<TypeSignature Language="C#" Value="public sealed struct PositionType;" Maintainer="auto" /> <TypeSignature Language="C#" Value="public sealed struct PositionType;" Maintainer="Lee Mallabone" />
<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>Indicates a position for placement or layout.</summary>
<remarks>To be added</remarks> <remarks><para>A PositionType is used to place widgets, usually relative to other widgets or other parts of the same widget. For example, the position of a handle in a <see cref="T:Gtk.HandleBox"/>, or the position of tabs in a <see cref="T:Gtk.Notebook"/>.</para></remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Enum</BaseTypeName> <BaseTypeName>System.Enum</BaseTypeName>
@ -34,8 +34,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The relevant item should be placed on the left.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Right"> <Member MemberName="Right">
@ -46,8 +46,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The relevant item should be placed on the right.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Top"> <Member MemberName="Top">
@ -58,8 +58,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The relevant item should be placed at the top.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Bottom"> <Member MemberName="Bottom">
@ -70,8 +70,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The relevant item should be placed at the bottom.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="value__"> <Member MemberName="value__">