mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-09-08 07:53:17 +02:00
Add full docs for some classes, first draft for File & Color Selection.
svn path=/trunk/gtk-sharp/; revision=11958
This commit is contained in:
Lee Mallabone
parent
935bcf45a7
commit
f674efc1e8
@ -1,3 +1,12 @@
|
||||
2003-02-25 Lee Mallabone <mono-docs@fonicmonkey.net>
|
||||
|
||||
* en/Gtk/AspectFrame.xml: full doc, based on C docs.
|
||||
* en/Gtk/FileSelection.xml: first draft
|
||||
* en/Gtk/ColorSelection.xml: first draft, incorrect API left undocumented and reported as bug #38672.
|
||||
* en/Gtk/ColorSelectionDialog.xml: full doc.
|
||||
* en/Gtk/CheckMenuItem.xml: full doc, based on C docs.
|
||||
* en/Gtk/UpdateType.xml: simple docs for a simple enum.
|
||||
|
||||
2003-02-25 Duncan Mak <duncan@ximian.com>
|
||||
|
||||
* en/Gtk/WrapMode.xml: From Hector.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<Type Name="AspectFrame" FullName="Gtk.AspectFrame">
|
||||
<TypeSignature Language="C#" Value="public class AspectFrame : Gtk.Frame, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public class AspectFrame : Gtk.Frame, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
|
||||
<AssemblyInfo>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
@ -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 frame that constrains its child to a particular aspect ratio.</summary>
|
||||
<remarks><para>The AspectFrame is useful when you want pack a widget so that it can resize but always retains the same aspect ratio. For instance, one might be drawing a small preview of a larger image. AspectFrame derives from <see cref="T:Gtk.Frame"/>, so it can draw a label and a frame around the child. The frame will be "shrink-wrapped" to the size of the child.</para></remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>Gtk.Frame</BaseTypeName>
|
||||
@ -42,12 +42,12 @@
|
||||
<Parameter Name="obey_child" Type="System.Boolean" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="xalign">To be added: an object of type 'float'</param>
|
||||
<param name="yalign">To be added: an object of type 'float'</param>
|
||||
<param name="ratio">To be added: an object of type 'float'</param>
|
||||
<param name="obey_child">To be added: an object of type 'bool'</param>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Set the size and alignment properties of this AspectFrame.</summary>
|
||||
<param name="xalign">Horizontal alignment of the child within the allocation of the AspectFrame.</param>
|
||||
<param name="yalign">Vertical alignment of the child within the allocation of the AspectFrame.</param>
|
||||
<param name="ratio">The desired aspect ratio.</param>
|
||||
<param name="obey_child">If <langword name="true"/>, ratio is ignored, and the aspect ratio is taken from the requistion of the child.</param>
|
||||
<remarks><para>Alignment values range from 0.0 (left/top aligned) to 1.0 (right/bottom aligned).</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Finalize">
|
||||
@ -106,14 +106,14 @@
|
||||
<Parameter Name="obey_child" Type="System.Boolean" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="label">To be added: an object of type 'string'</param>
|
||||
<param name="xalign">To be added: an object of type 'float'</param>
|
||||
<param name="yalign">To be added: an object of type 'float'</param>
|
||||
<param name="ratio">To be added: an object of type 'float'</param>
|
||||
<param name="obey_child">To be added: an object of type 'bool'</param>
|
||||
<returns>To be added: an object of type 'Gtk.AspectFrame'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The main way to construct a new AspectFrame.</summary>
|
||||
<param name="label">A title for the frame, can be <langword name="null"/>.</param>
|
||||
<param name="xalign">Horizontal alignment of the child within the allocation of the AspectFrame.</param>
|
||||
<param name="yalign">Vertical alignment of the child within the allocation of the AspectFrame.</param>
|
||||
<param name="ratio">The desired aspect ratio.</param>
|
||||
<param name="obey_child">If <langword name="true"/>, ratio is ignored, and the aspect ratio is taken from the requistion of the child.</param>
|
||||
<returns>A new AspectFrame</returns>
|
||||
<remarks><para>Alignment values range from 0.0 (left/top aligned) to 1.0 (right/bottom aligned).</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
@ -122,9 +122,9 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.AspectFrame'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Internal constructor</summary>
|
||||
<returns></returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GType">
|
||||
@ -149,10 +149,10 @@
|
||||
<Parameter Name="value" Type="System.Single" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'float'</param>
|
||||
<returns>To be added: an object of type 'float'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Vertical alignment of the child widget in the AspectFrame.</summary>
|
||||
<param name="value">A value between 0.0 (top aligned) and 1.0 (bottom aligned).</param>
|
||||
<returns>A value between 0.0 and 1.0.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Xalign">
|
||||
@ -165,10 +165,10 @@
|
||||
<Parameter Name="value" Type="System.Single" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'float'</param>
|
||||
<returns>To be added: an object of type 'float'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Horiontal alignment of the child widget in the AspectFrame.</summary>
|
||||
<param name="value">A value between 0.0 (left aligned) and 1.0 (right aligned).</param>
|
||||
<returns>A value between 0.0 and 1.0.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Ratio">
|
||||
@ -181,10 +181,10 @@
|
||||
<Parameter Name="value" Type="System.Single" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'float'</param>
|
||||
<returns>To be added: an object of type 'float'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The aspect ratio of the child widget's size.</summary>
|
||||
<param name="value">A ratio between 0.0 and 1.0</param>
|
||||
<returns>The aspect ratio between 0.0 and 1.0 representing the child's size constraints.</returns>
|
||||
<remarks><para>Setting this ratio is ignored if <see cref="P:Gtk.AspectFrame.ObeyChild"/> is set to <langword name="true"/>.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ObeyChild">
|
||||
@ -197,10 +197,10 @@
|
||||
<Parameter Name="value" Type="System.Boolean" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'bool'</param>
|
||||
<returns>To be added: an object of type 'bool'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Allow the frame to use its child widget's aspect ratio.</summary>
|
||||
<param name="value"><langword name="true"/> for the AspectFrame to use the child widget's size ratio, <langword name="false"/> for <see cref="P:Gtk.AspectFrame.Ratio"/> to control the ratio.</param>
|
||||
<returns>The current size ratio of the child widget</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<Type Name="CheckMenuItem" FullName="Gtk.CheckMenuItem">
|
||||
<TypeSignature Language="C#" Value="public class CheckMenuItem : Gtk.MenuItem, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public class CheckMenuItem : Gtk.MenuItem, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
|
||||
<AssemblyInfo>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
@ -7,8 +7,11 @@
|
||||
</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 menu item with a check box.</summary>
|
||||
<remarks><para>A CheckMenuItem is a menu item that maintains the state of a boolean value in addition to a <see cref="T:Gtk.MenuItem"/>'s usual role in activating application code.</para>
|
||||
<para>A check box indicating the state of the boolean value is displayed at the left side of the <see cref="T:Gtk.MenuItem"/>. Activating the <see cref="T:Gtk.MenuItem"/> toggles the value.</para>
|
||||
<para>Whether the CheckMenuItem is 'on' or not can be determined with the <see cref="P:Gtk.CheckMenuItem.Active"/> property.</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>Gtk.MenuItem</BaseTypeName>
|
||||
@ -39,10 +42,10 @@
|
||||
<Parameter Name="label" Type="System.String" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="label">To be added: an object of type 'string'</param>
|
||||
<returns>To be added: an object of type 'Gtk.CheckMenuItem'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>A static way of creating a new CheckMenuItem</summary>
|
||||
<param name="label">The name of the menu item</param>
|
||||
<returns>A new CheckMenuItem</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Toggle">
|
||||
@ -53,8 +56,8 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Toggles the state of the check box between active and inactive.</summary>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Finalize">
|
||||
@ -107,9 +110,9 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.CheckMenuItem'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Creates a CheckMenuItem with no label</summary>
|
||||
<returns>A new CheckMenuItem</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
@ -120,10 +123,10 @@
|
||||
<Parameter Name="label" Type="System.String" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="label">To be added: an object of type 'string'</param>
|
||||
<returns>To be added: an object of type 'Gtk.CheckMenuItem'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Create a new CheckMenuItem with the specified <paramref name="label"/>.</summary>
|
||||
<param name="label">The text to appear on the menu item.</param>
|
||||
<returns>A new CheckMenuItem</returns>
|
||||
<remarks><para>The text label will be created using <see cref="M:Gtk.Label.NewWithNmemonic"/>, so underscores in the label indicate the mnemonic for the menu item.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GType">
|
||||
@ -148,10 +151,12 @@
|
||||
<Parameter Name="value" Type="System.Boolean" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'bool'</param>
|
||||
<returns>To be added: an object of type 'bool'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Manages whether the CheckMenuItem is in the 'inconsistent' state.</summary>
|
||||
<param name="value"><langword name="true"/> to mark the check box as inconsistent, <langword name="false"/> otherwise.</param>
|
||||
<returns><langword name="true"/> if this CheckMenuItem is in the inconsistent state, <langword name="false"/> otherwise.</returns>
|
||||
<remarks><para>If the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a boolean setting, and the current values in that range are inconsistent, you may want to display the check in an "in between" state. This property turns on "in between" display.</para>
|
||||
<para>Normally you would turn off the inconsistent state again if the user explicitly selects a setting. This has to be done manually, this property only affects visual appearance, it doesn't affect the semantics of the widget.</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Active">
|
||||
@ -164,10 +169,10 @@
|
||||
<Parameter Name="value" Type="System.Boolean" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'bool'</param>
|
||||
<returns>To be added: an object of type 'bool'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The 'active' state of the CheckMenuItem</summary>
|
||||
<param name="value"><langword name="true"/> if the menu item has been set active, <langword name="false"/> otherwise.</param>
|
||||
<returns></returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Toggled">
|
||||
@ -176,8 +181,8 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>An event that is fired whenever the state of the CheckMenuItem is toggled.</summary>
|
||||
<remarks><para>Connect to this event with a standard <see cref="T:System.EventHandler"/>.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<Type Name="ColorSelection" FullName="Gtk.ColorSelection">
|
||||
<TypeSignature Language="C#" Value="public class ColorSelection : Gtk.VBox, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public class ColorSelection : Gtk.VBox, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
|
||||
<AssemblyInfo>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
@ -7,8 +7,10 @@
|
||||
</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 widget for selecting a color.</summary>
|
||||
<remarks><para>The ColorSelection consists of a color wheel and number of sliders and entry boxes for color parameters such as hue, saturation, value, red, green, blue, and opacity. It is found on the standard color selection dialog box, <see cref="Gtk.ColorSelectionDialog"/>.</para>
|
||||
<para>This widget displays the 'selected' color as well as the previously selected color.</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>Gtk.VBox</BaseTypeName>
|
||||
@ -105,9 +107,9 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'bool'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Gets the current state of the ColorSelection</summary>
|
||||
<returns><langword name="true"/> if the user is currently dragging a color around, <langword name="false"/> if the selection has stopped. </returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Finalize">
|
||||
@ -160,9 +162,9 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.ColorSelection'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The main way to create a new ColorSelection</summary>
|
||||
<returns>A new ColorSelection</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GType">
|
||||
@ -187,10 +189,10 @@
|
||||
<Parameter Name="value" Type="System.UInt16" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'ushort'</param>
|
||||
<returns>To be added: an object of type 'ushort'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Get the alpha value of the previous color</summary>
|
||||
<param name="value">A new setting for the 'previous' alpha value.</param>
|
||||
<returns>The previous alpha value - an integer between 0 and 65535.</returns>
|
||||
<remarks><para>It may be confusing for a user if this property is set with no interaction from them.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="CurrentColor">
|
||||
@ -203,10 +205,10 @@
|
||||
<Parameter Name="value" Type="Gdk.Color" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'Gdk.Color'</param>
|
||||
<returns>To be added: an object of type 'Gdk.Color'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Manage the current color of the ColorSelection.</summary>
|
||||
<param name="value">A color to set as the 'current' color.</param>
|
||||
<returns>The currently selected color in this ColorSelection.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="HasPalette">
|
||||
@ -219,10 +221,10 @@
|
||||
<Parameter Name="value" Type="System.Boolean" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'bool'</param>
|
||||
<returns>To be added: an object of type 'bool'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Manage whether or not the ColorSelection displays a palette.</summary>
|
||||
<param name="value"><langword name="true"/> to display a palette in the ColorSelection, <langword name="false"/> otherwise.</param>
|
||||
<returns><langword name="true"/> if a palette is currently part of the ColorSelection, <langword name="false"/> otherwise.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="HasOpacityControl">
|
||||
@ -235,10 +237,10 @@
|
||||
<Parameter Name="value" Type="System.Boolean" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'bool'</param>
|
||||
<returns>To be added: an object of type 'bool'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Manage whether or not opacity is part of the ColorSelection.</summary>
|
||||
<param name="value"><langword name="true"/> to display opacity controls, <langword name="false"/> otherwise.</param>
|
||||
<returns><langword name="true"/> if the user can edit opacity, <langword name="false"/> otherwise.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="CurrentAlpha">
|
||||
@ -251,10 +253,10 @@
|
||||
<Parameter Name="value" Type="System.UInt16" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'ushort'</param>
|
||||
<returns>To be added: an object of type 'ushort'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Manage the current alpha value of the ColorSelection.</summary>
|
||||
<param name="value">Sets the current opacity.</param>
|
||||
<returns>The existing opacity of this ColorSelection.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ColorChanged">
|
||||
@ -263,8 +265,8 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>This event is fired when the current color changes in the ColorSelection.</summary>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<Type Name="ColorSelectionDialog" FullName="Gtk.ColorSelectionDialog">
|
||||
<TypeSignature Language="C#" Value="public class ColorSelectionDialog : Gtk.Dialog, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public class ColorSelectionDialog : Gtk.Dialog, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
|
||||
<AssemblyInfo>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
@ -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 standard dialog box for selecting a color.</summary>
|
||||
<remarks><para>The ColorSelectionDialog provides a standard <see cref="T:Gtk.Dialog"/> which allows the user to select a color much like the <see cref="T:Gtk.FileSelection"/> provides a standard dialog for file selection.</para></remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>Gtk.Dialog</BaseTypeName>
|
||||
@ -81,10 +81,10 @@
|
||||
<Parameter Name="title" Type="System.String" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="title">To be added: an object of type 'string'</param>
|
||||
<returns>To be added: an object of type 'Gtk.ColorSelectionDialog'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The main way to construct a new color selector.</summary>
|
||||
<param name="title">A title that will appear in the window's title bar.</param>
|
||||
<returns>A new ColorSelectionDialog</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
@ -93,9 +93,9 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.ColorSelectionDialog'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Internal constructor</summary>
|
||||
<returns></returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GType">
|
||||
@ -117,8 +117,8 @@
|
||||
<ReturnType>Gtk.Button</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Button'</returns>
|
||||
<summary>A button for providing help with this dialog</summary>
|
||||
<returns>A standard <see cref="T:Gtk.Button"/>.</returns>
|
||||
<remarks>To be added</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
@ -129,9 +129,9 @@
|
||||
<ReturnType>Gtk.Button</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Button'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>A button for cancelling this dialog</summary>
|
||||
<returns>A standard <see cref="T:Gtk.Button"/>.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="OkButton">
|
||||
@ -141,9 +141,9 @@
|
||||
<ReturnType>Gtk.Button</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Button'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>A button to confirm use of the selected color.</summary>
|
||||
<returns>A standard <see cref="T:Gtk.Button"/>.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ColorSelection">
|
||||
@ -153,9 +153,9 @@
|
||||
<ReturnType>Gtk.ColorSelection</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.ColorSelection'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>An accessor to the actual ColorSelection widget.</summary>
|
||||
<returns>The ColorSelection component of this <see cref="T:Gtk.Dialog"/>.</returns>
|
||||
<remarks><para>All color-related functions are available using the methods on this property, such as <see cref="P:Gtk.ColorSelection.CurrentColor"/>.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<Type Name="FileSelection" FullName="Gtk.FileSelection">
|
||||
<TypeSignature Language="C#" Value="public class FileSelection : Gtk.Dialog, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public class FileSelection : Gtk.Dialog, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
|
||||
<AssemblyInfo>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
@ -7,8 +7,16 @@
|
||||
</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>Creates a new dialog for the user to select one or more files, directories, or cancel.</summary>
|
||||
<remarks><para>FileSelection should be used to retrieve file or directory names from the user. It will create a new dialog window containing a directory list, and a file list corresponding to the current working directory.
|
||||
</para>
|
||||
<para>
|
||||
The filesystem can be navigated using the directory list or the drop-down history menu. Alternatively, the TAB key can be used to navigate using filename completion - common in text based editors such as emacs and jed.</para>
|
||||
<para>
|
||||
Simple file operations; create directory, delete file, and rename file, are available from buttons at the top of the dialog.</para>
|
||||
<para>
|
||||
The functionality of the FileSelection can be extended by using the available accessors to the buttons and drop downs.
|
||||
</para></remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>Gtk.Dialog</BaseTypeName>
|
||||
@ -39,9 +47,9 @@
|
||||
<Parameter Name="pattern" Type="System.String" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="pattern">To be added: an object of type 'string'</param>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Restrict the visible files and directories to those that match the given <paramref name="pattern"/>.</summary>
|
||||
<param name="pattern">A simple wildcard pattern such as '*.txt'.</param>
|
||||
<remarks><para>This method attempts to match <paramref name="pattern"/> to a valid filenames or subdirectories in the current directory. If a match can be made, the matched filename will appear in the text entry field of the file selection dialog. If a partial match can be made, the "Files" list will contain those file names which have been partially matched, and the "Folders" list will show those directories with a partial match.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ShowFileopButtons">
|
||||
@ -52,8 +60,8 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Ensures that the file operation buttons are visible.</summary>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="HideFileopButtons">
|
||||
@ -64,8 +72,8 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Ensures that the file operation buttons are hidden.</summary>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Finalize">
|
||||
@ -120,10 +128,10 @@
|
||||
<Parameter Name="title" Type="System.String" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="title">To be added: an object of type 'string'</param>
|
||||
<returns>To be added: an object of type 'Gtk.FileSelection'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The main way to construct a new file selector.</summary>
|
||||
<param name="title">A title that will appear in the window's title bar.</param>
|
||||
<returns>A new FileSelection</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
@ -132,9 +140,9 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.FileSelection'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Internal constructor</summary>
|
||||
<returns></returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GType">
|
||||
@ -180,9 +188,9 @@
|
||||
<ReturnType>Gtk.Button</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Button'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The 'rename file' button of this file selector.</summary>
|
||||
<returns></returns>
|
||||
<remarks><para>This button may or may not be visible, see <see cref="M:Gtk.FileSelection.ShowFileopButtons()"/> and <see cref="M:Gtk.FileSelection.ShowFileopButtons()"/>.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="FileopDelFile">
|
||||
@ -192,9 +200,9 @@
|
||||
<ReturnType>Gtk.Button</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Button'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The 'delete' button of this file selector.</summary>
|
||||
<returns></returns>
|
||||
<remarks><para>This button may or may not be visible, see <see cref="M:Gtk.FileSelection.ShowFileopButtons()"/> and <see cref="M:Gtk.FileSelection.ShowFileopButtons()"/>.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="FileopCDir">
|
||||
@ -204,9 +212,9 @@
|
||||
<ReturnType>Gtk.Button</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Button'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The 'create directory' button of this file selector.</summary>
|
||||
<returns></returns>
|
||||
<remarks><para>This button may or may not be visible, see <see cref="M:Gtk.FileSelection.ShowFileopButtons()"/> and <see cref="M:Gtk.FileSelection.ShowFileopButtons()"/>.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="FileopFile">
|
||||
@ -228,9 +236,9 @@
|
||||
<ReturnType>Gtk.Entry</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Entry'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The main text entry widget of this file selector.</summary>
|
||||
<returns></returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="FileopDialog">
|
||||
@ -252,9 +260,9 @@
|
||||
<ReturnType>Gtk.Menu</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Menu'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The <see cref="T:Gtk.Menu"/> that is displayed by the <see cref="P:Gtk.FileSelection.HistoryPulldown"/>.</summary>
|
||||
<returns>A menu containing the file system paths higher than the selected directory, and the user's directory history.</returns>
|
||||
<remarks><para>Note that this widget does not just contain history, it contains a list of directories above the current directory in the filesystem as well as user directory history.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="HistoryPulldown">
|
||||
@ -264,9 +272,9 @@
|
||||
<ReturnType>Gtk.OptionMenu</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.OptionMenu'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The drop down menu containing directories in the filesystem above the selected directory, and the user's directory history.</summary>
|
||||
<returns>The <see cref="T:Gtk.OptionMenu"/> at the top of the file selector.</returns>
|
||||
<remarks><para>This widget displays the menu returned by <see cref="P:Gtk.FileSelection.HistoryMenu"/>.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="HelpButton">
|
||||
@ -276,9 +284,9 @@
|
||||
<ReturnType>Gtk.Button</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Button'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>A help button, not displayed by default.</summary>
|
||||
<returns></returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="CancelButton">
|
||||
@ -288,9 +296,9 @@
|
||||
<ReturnType>Gtk.Button</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Button'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The 'cancel' of this file selector.</summary>
|
||||
<returns></returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="OkButton">
|
||||
@ -300,9 +308,9 @@
|
||||
<ReturnType>Gtk.Button</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Button'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The 'OK' button of this file selector.</summary>
|
||||
<returns></returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="SelectionText">
|
||||
@ -336,9 +344,9 @@
|
||||
<ReturnType>Gtk.TreeView</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.TreeView'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The <see cref="T:Gtk.TreeView"/> widget that displays files in this file selector.</summary>
|
||||
<returns></returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="DirList">
|
||||
@ -348,9 +356,9 @@
|
||||
<ReturnType>Gtk.TreeView</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.TreeView'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The <see cref="T:Gtk.TreeView"/> widget that displays directories in this file selector.</summary>
|
||||
<returns></returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Selections">
|
||||
@ -360,9 +368,9 @@
|
||||
<ReturnType>System.String[]</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'string[]'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Get the files that are selected</summary>
|
||||
<returns>An array of file paths</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ShowFileops">
|
||||
@ -375,10 +383,10 @@
|
||||
<Parameter Name="value" Type="System.Boolean" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'bool'</param>
|
||||
<returns>To be added: an object of type 'bool'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Manage whether buttons are displayed for doing file operations.</summary>
|
||||
<param name="value">Set to <langword name="true"/> to display the file buttons.</param>
|
||||
<returns><langword name="true"/> for buttons to be shown, <langword name="false"/> otherwise.</returns>
|
||||
<remarks><para>This manipulates whether the buttons for creating a directory, deleting files and renaming files, are displayed.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Filename">
|
||||
@ -391,10 +399,10 @@
|
||||
<Parameter Name="value" Type="System.String" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'string'</param>
|
||||
<returns>To be added: an object of type 'string'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Manage the selected filename.</summary>
|
||||
<param name="value">Sets a default path for the file requestor.</param>
|
||||
<returns>The selected filename in the on-disk encoding.</returns>
|
||||
<remarks><para>If <paramref name="value"/> includes a directory path, then the requestor will open with that path as its current working directory. The encoding of filename is the on-disk encoding, which may not be UTF-8.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="SelectMultiple">
|
||||
@ -407,11 +415,11 @@
|
||||
<Parameter Name="value" Type="System.Boolean" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'bool'</param>
|
||||
<returns>To be added: an object of type 'bool'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Manage whether more than one file can be selected.</summary>
|
||||
<param name="value">Set to <langword name="true"/> to allow more than one file to be selected in the file list, <langword name="false"/> to only allow selection of a single file.</param>
|
||||
<returns><langword name="true"/> if multiple selections are allowed, <langword name="false"/> otherwise.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
</Type>
|
||||
</Type>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<Type Name="UpdateType" FullName="Gtk.UpdateType">
|
||||
<TypeSignature Language="C#" Value="public sealed struct UpdateType;" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public sealed struct UpdateType;" Maintainer="Lee Mallabone" />
|
||||
<AssemblyInfo>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
@ -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>Provides a method of indicating how 'updates' should occur.</summary>
|
||||
<remarks><para>The purpose of this type is most easily explained in the context of its use. <see cref="T:Gtk.Range"/>, a base class for slider widgets such as <see cref="T:Gtk.HScale"/>, uses an UpdateType to determine how often to update a text value when the user is dragging a slider bar around.</para></remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>System.Enum</BaseTypeName>
|
||||
@ -34,8 +34,8 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Indicates that updates should occur as soon as possible.</summary>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Discontinuous">
|
||||
@ -46,8 +46,8 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Indicates that updates are not urgent.</summary>
|
||||
<remarks><para>This typically indicates that a whole group of updates can be done at once when a user action has finished.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Delayed">
|
||||
@ -58,8 +58,8 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Indicates that updates should happen as often as possible, but a delay between an action and its update, is allowed.</summary>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="value__">
|
||||
|
||||
Loading…
Reference in New Issue
Block a user