Documentation for various enumerations and the beginning of the

Gtk.Dialog class.

svn path=/trunk/gtk-sharp/; revision=11663
This commit is contained in:
Duncan Mak 2003-02-18 01:46:37 +00:00
parent f57c89c21d
commit fc1641eafb
12 changed files with 117 additions and 107 deletions

View file

@ -1,5 +1,5 @@
<Type Name="ArrowType" FullName="Gtk.ArrowType">
<TypeSignature Language="C#" Value="public sealed struct ArrowType;" Maintainer="auto" />
<TypeSignature Language="C#" Value="public sealed struct ArrowType;" Maintainer="Duncan Mak" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,7 +7,7 @@
</AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<summary>Used to indicate the direction in which a GtkArrow should point.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -34,7 +34,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Represents an upward pointing arrow.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -46,7 +46,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Represents an downward pointing arrow.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -58,7 +58,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Represents a left pointing arrow.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -70,7 +70,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Represents a right pointing arrow.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

View file

@ -1,5 +1,5 @@
<Type Name="AttachOptions" FullName="Gtk.AttachOptions">
<TypeSignature Language="C#" Value="public sealed struct AttachOptions;" Maintainer="auto" />
<TypeSignature Language="C#" Value="public sealed struct AttachOptions;" Maintainer="Duncan Mak" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,7 +7,7 @@
</AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<summary>Denotes the expansion properties that a widget will have when it (or it's parent) is resized.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -34,7 +34,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>the widget should expand to take up any extra space in its container that has been allocated.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -46,7 +46,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>the widget should shrink as and when possible.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -58,7 +58,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>the widget should fill the space allocated to it.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

View file

@ -1,5 +1,5 @@
<Type Name="CurveType" FullName="Gtk.CurveType">
<TypeSignature Language="C#" Value="public sealed struct CurveType;" Maintainer="auto" />
<TypeSignature Language="C#" Value="public sealed struct CurveType;" Maintainer="Duncan Mak" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -34,7 +34,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>linear interpolation</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -46,7 +46,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>spline interpolation</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -58,7 +58,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>free form curve </summary>
<remarks>To be added</remarks>
</Docs>
</Member>

View file

@ -1,5 +1,5 @@
<Type Name="Dialog" FullName="Gtk.Dialog">
<TypeSignature Language="C#" Value="public class Dialog : Gtk.Window, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class Dialog : Gtk.Window, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Duncan Mak" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,14 @@
</AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Creates popup windows.</summary>
<remarks>
<para>Dialog boxes are a convenient way to prompt the user for a small amount of input, eg. to display a message, ask a question, or anything else that does not require extensive effort on the user's part.</para>
<para>GTK+ treats a dialog as a window split vertically. The top section is a <see cref="T:Gtk.VBox"/>, and is where widgets such as a <see cref="T:Gtk.Label"/> or an <see cref="T:Gtk.Entry"/> should be packed. The bottom area is known as the <see cref="P:Gtk.Dialog.ActionArea"/>. This is generally used for packing buttons into the dialog which may perform functions such as cancel, ok, or apply. The two areas are separated by a <see cref="T:Gtk.HSeparator"/>.</para>
<para>The two primary areas of a dialog can be accessed as the <see cref="P:Gtk.Dialog.Vbox"/> property and the <see cref="P:Gtk.Dialog.ActionArea"/> property. To set the dialog to be model, use the <see cref="P:Gtk.Window.Model"/> property.</para>
<para>If you want to block waiting for a dialog to return before returning control flow to your code, you can call <see cref="M:Gtk.Dialog.Run"/>. This function enters a recursive main loop and waits for the user to respond to the dialog, returning the response ID corresponding to the button the user clicked.</para>
<para>For the simple dialog, in reality you'd probably use a <see cref="T:Gtk.MessageDialog"/> to save yourself some effort. But you'd need to create the dialog contents manually if you had more than a simple message in the dialog.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Window</BaseTypeName>

View file

@ -54,8 +54,8 @@ See also the <see cref="T:Gtk.TextView"/> widget for displaying and editing larg
<Docs>
<summary>Add arbitrary text to the entry.</summary>
<param name="new_text">the text to add</param>
<returns>The number of characters added</returns>
<remarks>Use this method to insert a string at the current CursorPosition.</remarks>
<returns><para>The number of characters added.</para></returns>
<remarks><para>Use this method to insert a string at the current CursorPosition.</para></remarks>
</Docs>
</Member>
<Member MemberName="StartEditing">
@ -118,7 +118,7 @@ See also the <see cref="T:Gtk.TextView"/> widget for displaying and editing larg
<MemberSignature Language="C#" Value="public virtual string GetChars (int start_pos, int end_pos);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
<ReturnType><para>System.String</para></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="start_pos" Type="System.Int32" />
@ -128,7 +128,7 @@ See also the <see cref="T:Gtk.TextView"/> widget for displaying and editing larg
<summary>Specific implementation of Gtk.Editable.GetChars for the Entry widget.</summary>
<param name="start_pos">The index of the first character to get, (zero-indexed).</param>
<param name="end_pos">The index of the character to retrieve up to.</param>
<returns>A string representing the characters from <paramref name="start_pos"/>, up to, but not including <paramref name="end_pos"/>. If <paramref name="end_pos"/> is negative, then the the characters retrieved will be those characters from <paramref name="start_pos"/> to the end of the text. </returns>
<returns><para>A string representing the characters from <paramref name="start_pos"/>, up to, but not including <paramref name="end_pos"/>. If <paramref name="end_pos"/> is negative, then the the characters retrieved will be those characters from <paramref name="start_pos"/> to the end of the text.</para> </returns>
<remarks></remarks>
</Docs>
</Member>
@ -187,7 +187,7 @@ See also the <see cref="T:Gtk.TextView"/> widget for displaying and editing larg
<summary>Get the the positions of the start and end of the current selection, if there is one.</summary>
<param name="start">output variable for the character index of the selection start</param>
<param name="end">output variable for the character index of the end of the selection</param>
<returns>true if there is a selection, false otherwise</returns>
<returns><para><see cref="langword:true"/> if there is a selection, <see cref="langword:false"/> otherwise.</para></returns>
<remarks></remarks>
</Docs>
</Member>
@ -219,7 +219,7 @@ See also the <see cref="T:Gtk.TextView"/> widget for displaying and editing larg
<param name="new_text">The text to add to the Entry</param>
<param name="new_text_length">The length of the new text to add, in bytes.</param>
<param name="position">An in/out parameter. The caller initializes it to the position at which to insert the text. After the call it points at the position after the newly inserted text.</param>
<remarks>Implements the Gtk.Editable.InsertText interface method for this Entry.</remarks>
<remarks><para>Implements the Gtk.Editable.InsertText interface method for this Entry.</para></remarks>
</Docs>
</Member>
<Member MemberName="PasteClipboard">
@ -230,7 +230,7 @@ See also the <see cref="T:Gtk.TextView"/> widget for displaying and editing larg
</ReturnValue>
<Parameters />
<Docs>
<summary>Causes the contents of the clipboard to be pasted into the Entry at the current cursor position. </summary>
<summary>Causes the contents of the clipboard to be pasted into the Entry at the current cursor position.</summary>
<remarks></remarks>
</Docs>
</Member>
@ -248,9 +248,9 @@ See also the <see cref="T:Gtk.TextView"/> widget for displaying and editing larg
<summary>Obtains the position of the PangoLayout used to render text in the entry, in widget coordinates.</summary>
<param name="x">X offset output of the layout</param>
<param name="y">Y offset output of the layout</param>
<remarks>Useful if you want to line up the text in an entry with some other text, e.g. when using the entry to implement editable cells in a sheet widget.
<remarks><para>Useful if you want to line up the text in an entry with some other text, e.g. when using the entry to implement editable cells in a sheet widget.</para>
Also useful to convert mouse events into coordinates inside the PangoLayout, e.g. to take some action if some part of the entry text is clicked. </remarks>
<para>Also useful to convert mouse events into coordinates inside the PangoLayout, e.g. to take some action if some part of the entry text is clicked.</para> </remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -312,8 +312,8 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
</ReturnValue>
<Docs>
<summary>Get the type of this object, as registered with the GLib object system.</summary>
<returns>A number that uniquely identifies this type in the GLib object system.</returns>
<remarks>Mostly for internal use.</remarks>
<returns><para>A number that uniquely identifies this type in the GLib object system.</para></returns>
<remarks><para>Mostly for internal use.</para></remarks>
</Docs>
</Member>
<Member MemberName="IsEditable">
@ -328,7 +328,7 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<Docs>
<summary>Implements the concrete version of Gtk.Editable.IsEditable, to determine if the text of the Entry can be edited.</summary>
<param name="value">true to allow editing of the Entry, false otherwise.</param>
<returns>true if the Entry is editable, false otherwise.</returns>
<returns><para>true if the Entry is editable, false otherwise.</para></returns>
<remarks></remarks>
</Docs>
</Member>
@ -344,8 +344,8 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<Docs>
<summary>The position of the cursor.</summary>
<param name="value">the new cursor position, in characters.</param>
<returns>the current cursor position</returns>
<remarks>The cursor is displayed before the character with the given (base 0) index in the widget. The value must be less than or equal to the number of characters in the widget. A value of -1 indicates that the position should be set after the last character in the entry. Note that this position is in characters, not in bytes. </remarks>
<returns><para>the current cursor position</para></returns>
<remarks><para>The cursor is displayed before the character with the given (base 0) index in the widget. The value must be less than or equal to the number of characters in the widget. A value of -1 indicates that the position should be set after the last character in the entry. Note that this position is in characters, not in bytes. </para></remarks>
</Docs>
</Member>
<Member MemberName="Layout">
@ -355,9 +355,9 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<ReturnType>Pango.Layout</ReturnType>
</ReturnValue>
<Docs>
<summary>Get the object used by this Entry for text layout</summary>
<returns>The Pango.Layout used to render the text of this entry</returns>
<remarks>This property is read only.</remarks>
<summary>Get the object used by this Entry for text layout.</summary>
<returns><para>The Pango.Layout used to render the text of this entry.</para></returns>
<remarks><para>This property is read only.</para></remarks>
</Docs>
</Member>
<Member MemberName="Visibility">
@ -370,10 +370,10 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>Determine whether to display characters entered, or whether to mask them</summary>
<summary>Determine whether to display characters entered, or whether to mask them.</summary>
<param name="value">true to display characters in the Entry, false to mask them</param>
<returns>true if characters are being displayed, false if they are being masked</returns>
<remarks>This property should be used to create entry widgets for sensitive data such as passwords.</remarks>
<returns><para>true if characters are being displayed, false if they are being masked.</para></returns>
<remarks><para>This property should be used to create entry widgets for sensitive data such as passwords.</para></remarks>
</Docs>
</Member>
<Member MemberName="MaxLength">
@ -388,8 +388,8 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<Docs>
<summary>The maximum number of characters that can be placed in this Entry.</summary>
<param name="value">How many characters to limit this Entry to</param>
<returns>The maximum number of characters that can currently be set in this Entry</returns>
<remarks>This property can be useful for ensuring no more than a specific number of characters are put in an entry.</remarks>
<returns><para>The maximum number of characters that can currently be set in this Entry.</para></returns>
<remarks><para>This property can be useful for ensuring no more than a specific number of characters are put in an entry.</para></remarks>
</Docs>
</Member>
<Member MemberName="CursorPosition">
@ -399,9 +399,9 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>The position of the cursor in the Entry's text</summary>
<returns>The current character of the cursor.</returns>
<remarks>Use this property to manipulate the position of the cursor - it is displayed before the character with the given (base 0) index in the widget. The value must be less than or equal to the number of characters in the widget. A value of -1 indicates that the position should be set after the last character in the entry. Note that this position is in characters, not in bytes.</remarks>
<summary>The position of the cursor in the Entry's text.</summary>
<returns><para>The current character of the cursor.</para></returns>
<remarks><para>Use this property to manipulate the position of the cursor - it is displayed before the character with the given (base 0) index in the widget. The value must be less than or equal to the number of characters in the widget. A value of -1 indicates that the position should be set after the last character in the entry. Note that this position is in characters, not in bytes.</para></remarks>
</Docs>
</Member>
<Member MemberName="SelectionBound">
@ -411,8 +411,8 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>The length of the selected text</summary>
<returns>the number of selected characters</returns>
<summary>The length of the selected text.</summary>
<returns><para>The number of selected characters.</para></returns>
<remarks></remarks>
</Docs>
</Member>
@ -426,9 +426,9 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>Manipulate the current text contents of an Entry</summary>
<summary>Manipulate the current text contents of an Entry.</summary>
<param name="value">The new string to display in the Entry - overwrites any existing text in the widget.</param>
<returns>The current text in an Entry</returns>
<returns><para>The current text in an Entry.</para></returns>
<remarks></remarks>
</Docs>
</Member>
@ -456,8 +456,8 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<Docs>
<summary>Changes the size request of the entry to be about the right size for <paramref name="n_chars"/> characters.</summary>
<param name="value">Requested width, in characters</param>
<returns>The number of characters requested</returns>
<remarks>Note that it changes the size request, the size can still be affected by how you pack the widget into containers. If n_chars is -1, the size reverts to the default entry size.</remarks>
<returns><para>The number of characters requested.</para></returns>
<remarks><para>Note that it changes the size request, the size can still be affected by how you pack the widget into containers. If n_chars is -1, the size reverts to the default entry size.</para></remarks>
</Docs>
</Member>
<Member MemberName="Editable">
@ -470,10 +470,10 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>Whether or not this Entry is editable</summary>
<param name="value">true to make this Entry read-only, false to allow editing.</param>
<returns>true if this entry can be edited, false otherwise</returns>
<remarks>Set this property to false if you need to stop input into an Entry widget. For displaying textual data, it is more normal to use a <see cref="T:Gtk.Label"/> instead.</remarks>
<summary>Whether or not this Entry is editable.</summary>
<param name="value"><para><see langword="true"/> to make this Entry read-only, <see langword="false"/> to allow editing.</para></param>
<returns><para><see langword="true"/> if this entry can be edited, <see langword="false"/> otherwise.</para></returns>
<remarks><para>Set this property to false if you need to stop input into an Entry widget. For displaying textual data, it is more normal to use a <see cref="T:Gtk.Label"/> instead.</para></remarks>
</Docs>
</Member>
<Member MemberName="ActivatesDefault">
@ -487,11 +487,11 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
</Parameters>
<Docs>
<summary>Determine whether to activate the 'default widget' in the window when the return key is pressed.</summary>
<param name="value">set to true to activate the default button when enter is pressed, false otherwise</param>
<returns>true if the default button will be activated, false otherwise.</returns>
<remarks><para>If the value is true, pressing Enter in the entry will activate the default widget for the window containing the entry. This usually means that the dialog box containing the entry will be closed, since the default widget is usually one of the dialog buttons.</para>
<param name="value">set to <see langword="true"/> to activate the default button when enter is pressed, <see langword="false"/> otherwise</param>
<returns><para><see langword="true"/> if the default button will be activated, false otherwise.</para></returns>
<remarks><para>If the value is <see langword="true"/>, pressing Enter in the entry will activate the default widget for the window containing the entry. This usually means that the dialog box containing the entry will be closed, since the default widget is usually one of the dialog buttons.</para>
<para>
(For experts: if the value is true, the entry calls ActivateDefault() on the <see cref="T:Gtk.Window"/> containing the entry, in the default handler for the "activate" event).</para></remarks>
(For experts: if the value is <see langword="true"/>, the entry calls <see cref="M:Gtk.Window.ActivateDefault"/> on the <see cref="T:Gtk.Window"/> containing the entry, in the default handler for the <see cref="E:Gtk.Window.Activated"/> event).</para></remarks>
</Docs>
</Member>
<Member MemberName="HasFrame">
@ -504,10 +504,10 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>Whether or not this Entry should be surrounded by a 3D frame</summary>
<param name="value">true to surround this Entry in a frmae (the default), false otherwise.</param>
<returns>true if a frame surrounds this Entry, false otherwise</returns>
<remarks>Unless there is a very specific reason for doing so, this property is best left to its default to ensure consistency in Entry widgets across applications.</remarks>
<summary>Whether or not this Entry should be surrounded by a 3D frame.</summary>
<param name="value"><see langword="true"/> to surround this Entry in a frame (the default), <see langword="false"/> otherwise.</param>
<returns><see langword="true"/> if a frame surrounds this Entry, <see langword="false"/> otherwise</returns>
<remarks><para>Unless there is a very specific reason for doing so, this property is best left to its default to ensure consistency in Entry widgets across applications.</para></remarks>
</Docs>
</Member>
<Member MemberName="WidgetRemoved">
@ -526,7 +526,7 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<ReturnValue />
<Parameters />
<Docs>
<summary>Implements the EditingDone method of the <see cref="T:Gtk.CellEditable"/> interface. </summary>
<summary>Implements the EditingDone method of the <see cref="T:Gtk.CellEditable"/> interface.</summary>
<remarks></remarks>
</Docs>
</Member>
@ -566,7 +566,7 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<ReturnValue />
<Parameters />
<Docs>
<summary>Connect to this event handler to be notified when the cursor of an Entry moves</summary>
<summary>Connect to this event handler to be notified when the cursor of an Entry moves.</summary>
<remarks>Data pertaining to this event is passed with a <see cref="T:GtkSharp.MoveCursorHandler"/>.</remarks>
</Docs>
</Member>
@ -587,7 +587,7 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<Parameters />
<Docs>
<summary>Connect to this event to be notified when the user hits 'return'.</summary>
<remarks>Connect to this event with a standard <see cref="T:System.EventHandler"/>.</remarks>
<remarks><para>Connect to this event with a standard <see cref="T:System.EventHandler"/>.</para></remarks>
</Docs>
</Member>
<Member MemberName="DeleteFromCursor">
@ -597,7 +597,7 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<Parameters />
<Docs>
<summary>Connect to this event to find out when text is deleted from the Entry by the user.</summary>
<remarks>Data pertaining to this event is encapsulated in a <see cref="T:GtkSharp.DeleteFromCursorHandler"/>.</remarks>
<remarks><para>Data pertaining to this event is encapsulated in a <see cref="T:GtkSharp.DeleteFromCursorHandler"/>.</para></remarks>
</Docs>
</Member>
<Member MemberName="ClipboardPasted">
@ -607,7 +607,7 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<Parameters />
<Docs>
<summary>Connect to this event to be notified when the clipboard contents are pasted into this Entry.</summary>
<remarks>Connect to this event with a standard <see cref="T:System.EventHandler"/>.</remarks>
<remarks><para>Connect to this event with a standard <see cref="T:System.EventHandler"/>.</para></remarks>
</Docs>
</Member>
<Member MemberName="ClipboardCopied">
@ -617,7 +617,7 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<Parameters />
<Docs>
<summary>Connect to this event to be notified when the contents of the Entry are copied to the clipboard.</summary>
<remarks>Connect to this event with a standard <see cref="T:System.EventHandler"/>.</remarks>
<remarks><para>Connect to this event with a standard <see cref="T:System.EventHandler"/>.</para></remarks>
</Docs>
</Member>
<Member MemberName="PopulatePopup">
@ -627,7 +627,7 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>Data pertaining to this event is encapsulated in a <see cref="T:GtkSharp.PopulatePopupHandler"/>.</remarks>
<remarks><para>Data pertaining to this event is encapsulated in a <see cref="T:GtkSharp.PopulatePopupHandler"/>.</para></remarks>
</Docs>
</Member>
<Member MemberName="ToggleOverwrite">
@ -637,7 +637,7 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<Parameters />
<Docs>
<summary>Connect to this event to discover when the Overwrite state has been changed by the user. This is usually done by pressing the 'Insert' key on a keyboard.</summary>
<remarks>Connect to this event with a standard <see cref="T:System.EventHandler"/>.</remarks>
<remarks><para>Connect to this event with a standard <see cref="T:System.EventHandler"/>.</para></remarks>
</Docs>
</Member>
<Member MemberName="InsertAtCursor">
@ -647,7 +647,7 @@ Also useful to convert mouse events into coordinates inside the PangoLayout, e.g
<Parameters />
<Docs>
<summary>Connect to this event to discover when text is inserted at the cursor position - usually when the user types something in.</summary>
<remarks>Data pertaining to this event is encapsulated in an <see cref="T:GtkSharp.InsertAtCursorHandler"/>.</remarks>
<remarks><para>Data pertaining to this event is encapsulated in an <see cref="T:GtkSharp.InsertAtCursorHandler"/>.</para></remarks>
</Docs>
</Member>
</Members>

View file

@ -1,5 +1,5 @@
<Type Name="Justification" FullName="Gtk.Justification">
<TypeSignature Language="C#" Value="public sealed struct Justification;" Maintainer="auto" />
<TypeSignature Language="C#" Value="public sealed struct Justification;" Maintainer="Duncan Mak" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,7 +7,7 @@
</AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<summary>Used for justifying the text inside a <see cref="T:Gtk.Label"/> widget.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -34,7 +34,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The text is placed at the left edge of the label.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -46,7 +46,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The text is placed at the right edge of the label.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -58,7 +58,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The text is placed in the center of the label.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -70,7 +70,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The text is placed is distributed across the label.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

View file

@ -1,5 +1,5 @@
<Type Name="PackType" FullName="Gtk.PackType">
<TypeSignature Language="C#" Value="public sealed struct PackType;" Maintainer="auto" />
<TypeSignature Language="C#" Value="public sealed struct PackType;" Maintainer="Duncan Mak" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,7 +7,7 @@
</AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<summary>Represents the packing location of <see cref="T:Gtk.Box"/> children. (See: <see cref="T:Gtk.VBox"/>, <see cref="T:Gtk.HBox"/>, and <see cref="T:Gtk.ButtonBox"/>).</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -34,7 +34,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The child is packed into the start of the box.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -46,7 +46,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The child is packed into the end of the box</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

View file

@ -1,5 +1,5 @@
<Type Name="PolicyType" FullName="Gtk.PolicyType">
<TypeSignature Language="C#" Value="public sealed struct PolicyType;" Maintainer="auto" />
<TypeSignature Language="C#" Value="public sealed struct PolicyType;" Maintainer="Duncan Mak" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,7 +7,7 @@
</AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<summary>Determines when a scroll bar will be visible.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -34,7 +34,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The scrollbar is always visible.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -46,7 +46,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The scrollbar will appear and disappear as necessary.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -58,7 +58,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The scrollbar will never appear.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

View file

@ -1,5 +1,5 @@
<Type Name="ShadowType" FullName="Gtk.ShadowType">
<TypeSignature Language="C#" Value="public sealed struct ShadowType;" Maintainer="auto" />
<TypeSignature Language="C#" Value="public sealed struct ShadowType;" Maintainer="Duncan Mak" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,7 +7,7 @@
</AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<summary>Used to change the appearance of an outline typically provided by a <see cref="T:Gtk.Frame"/>.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -34,7 +34,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>No outline.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -46,7 +46,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The outline is bevelled inwards.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -58,7 +58,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The outline is bevelled outwards like a button.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -70,7 +70,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The outline itself is an inward bevel, but the frame is an outward bevel.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -82,7 +82,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The outline itself is an outward bevel, but the frame is an inward bevel.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

View file

@ -1,5 +1,5 @@
<Type Name="SortType" FullName="Gtk.SortType">
<TypeSignature Language="C#" Value="public sealed struct SortType;" Maintainer="auto" />
<TypeSignature Language="C#" Value="public sealed struct SortType;" Maintainer="Duncan Mak" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,7 +7,7 @@
</AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<summary>Determines the direction of a sort.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -34,7 +34,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Sorting is in ascending order.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -46,7 +46,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Sorting is in descending order.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

View file

@ -1,5 +1,5 @@
<Type Name="WindowPosition" FullName="Gtk.WindowPosition">
<TypeSignature Language="C#" Value="public sealed struct WindowPosition;" Maintainer="auto" />
<TypeSignature Language="C#" Value="public sealed struct WindowPosition;" Maintainer="Duncan Mak" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,7 +7,7 @@
</AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<summary>Window placement can be influenced using this enumeration.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -34,7 +34,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>No influence is made on placement.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -46,7 +46,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Windows should be placed in the center of the screen.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -58,7 +58,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Windows should be placed at the current mouse position.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -70,7 +70,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Keep window centered as it changes size, etc.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -82,7 +82,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Center the window on its transient parent (see <see cref="P:Gtk.Window.TransientFor"/>).</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

View file

@ -1,5 +1,5 @@
<Type Name="WindowType" FullName="Gtk.WindowType">
<TypeSignature Language="C#" Value="public sealed struct WindowType;" Maintainer="auto" />
<TypeSignature Language="C#" Value="public sealed struct WindowType;" Maintainer="Duncan Mak" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -8,7 +8,11 @@
<ThreadSafetyStatement>To be added</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks>
<para>A <see cref="T:Gtk.Window"/> can be one of these types. Most things you'd consider a "window" should have type <see cref="T:Gtk.WindowType.TopLevel"/> ; windows with this type are managed by the window manager and have a frame by default (call <see cref="P:Gtk.Window.Decorated"/> to toggle the frame). Windows with type <see cref="T:Gtk.Window.Popup"/> are ignored by the window manager; window manager keybindings won't work on them, the window manager won't decorate the window with a frame, many GTK+ features that rely on the window manager will not work (e.g. resize grips and maximization/minimization).</para>
<para><see cref="T:Gtk.WindowType.Popup"/> is used to implement widgets such as <see cref="T:Gtk.Menu"/> or tooltips that you normally don't think of as windows per se. Nearly all windows should be <see cref="T:Gtk.Window.Toplevel"/>. In particular, do not use <see cref="T:Gtk.Window.Popup"/> just to turn off the window borders; use <see cref="P:Gtk.Window.Decorated"/> for instead.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -34,7 +38,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>A regular window, such as a dialog.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -46,7 +50,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>A special window such as a tooltip.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>