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

* en/Gtk/Dialog.xml: add more info

Browse source 
* en/Gtk/DialogFlags: add first draft

svn path=/trunk/gtk-sharp/; revision=15423
This commit is contained in:
John Luke 2003-06-15 16:44:25 +00:00
parent edc0d396cb
commit af529da444
3 changed files with 106 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/ChangeLog
View file

@ -1,3 +1,7 @@
2003-06-15 John Luke <jluke@cfl.rr.com>
* en/Gtk/Dialog.xml: add more info
* en/Gtk/DialogFlags: add first draft
2003-06-13 John Luke <jluke@cfl.rr.com>
* en/Gtk/ProgressBarStyle.xml
* en/Gtk/ProgressBarOrientation.xml

139
doc/en/Gtk/Dialog.xml
View file

@ -9,11 +9,11 @@
<Docs>
<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>
<para><see cref="T:Gtk.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 by the user.</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 modal, use the <see cref="P:Gtk.Window.Modal" /> 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 <see cref="T:Gtk.ResponseType"/> corresponding to the <see cref="T:Gtk.Button"/> the user clicked.</para>
<para>For a simple dialog, you would probably use <see cref="T:Gtk.MessageDialog" /> to save yourself some effort. However, you would need to create the <see cref="T:Gtk.Dialog"/> contents manually if you had more than a simple message in the <see cref="T:Gtk.Dialog"/>.</para>
</remarks>
</Docs>
<Base>
@ -46,10 +46,13 @@
<Parameter Name="response_id" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="child">To be added: an object of type 'Gtk.Widget'</param>
<param name="response_id">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<summary>Adds an activatable widget to the <see cref="T:Gtk.Dialog.ActionArea"/> of a <see cref="T:Gtk.Dialog"/>.</summary>
<param name="child">an object of type <see cref="T:Gtk.Widget"/>.</param>
<param name="response_id">an object of type <see cref="T:System.UInt32"/>.</param>
<remarks>
Adds an activatable <see cref="T:Gtk.Widget"/> to the <see cref="T:Gtk.Dialog.ActionArea"/> of a <see cref="T:Gtk.Dialog"/>, connecting a signal handler that will <see cref="E:Gtk.Dialog.Response"/> on the <see cref="T:Gtk.Dialog"/> when the <see cref="T:Gtk.Widget"/> is activated.
The <see cref="T:Gtk.Widget"/> is appended to the end of the <see cref="T:Gtk.Dialog.ActionArea"/>. If you want to add a non-activatable <see cref="T:Gtk.Widget"/>, simply pack it into the <see cref="T:Gtk.Dialog.ActionArea"/> field of the <see cref="T:Gtk.Dialog"/>.
</remarks>
</Docs>
</Member>
<Member MemberName="Run">
@ -60,9 +63,27 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Waits for the <see cref="E:Gtk.Dialog.Response"/> event or the <see cref="T:Gtk.Dialog"/> to be detroyed.</summary>
<returns>an object of type <see cref="T:System.UInt32"/>.</returns>
<remarks>
<para>
Waits for the <see cref="E:Gtk.Dialog.Response"/> event or the <see cref="T:Gtk.Dialog"/> to be destroyed.
If the <see cref="T:Gtk.Dialog"/> is destroyed during the call to <see cref="M:Gtk.Dialog.Run()"/>, <see cref="T:Gtk.Dialog"/> returns <see cref="F:Gtk.ResponseType.None"/>.
Otherwise, it returns the response ID from the <see cref="E:Gtk.Dialog.Response"/> event.
Before entering the recursive main loop, <see cref="M:Gtk.Dialog.Run()"/> calls <see cref="M:Gtk.Widget.Show()"/> on the <see cref="T:Gtk.Dialog"/> for you.
Note that you still need to show any children of the <see cref="T:Gtk.Dialog"/> yourself.
</para>
<para>
During <see cref="M:Gtk.Dialog.Run()"/>, the default behavior of <see cref="E:Gtk.Window.DeleteEvent"/> is disabled;
if the <see cref="T:Gtk.Dialog"/> receives <see cref="E:Gtk.Window.DeleteEvent"/>, it will not be destroyed as usual, and <see cref="M:Gtk.Dialog.Run()"/> will return <see cref="F:Gtk.ResponseType.DeleteEvent"/>.
Also, during <see cref="M:Gtk.Dialog.Run()"/> the <see cref="T:Gtk.Dialog"/> will be modal.
You can force <see cref="M:Gtk.Dialog.Run()"/> to return at any time by calling <see cref="M:Gtk.Dialog.Respond"/> to emit the <see cref="E:Gtk.Dialog.Response"/> event.
Destroying the <see cref="T:Gtk.Dialog"/> during <see cref="M:Gtk.Dialog.Run()"/> is a very bad idea, because your post-run code will not know whether the <see cref="T:Gtk.Dialog"/> was destroyed or not.
</para>
<para>
After <see cref="M:Gtk.Dialog.Run()"/> returns, you are responsible for hiding or destroying the <see cref="T:Gtk.Dialog"/> if you wish to do so.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Respond">
@ -75,9 +96,13 @@
<Parameter Name="response_id" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="response_id">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<summary>Emits the <see cref="E:Gtk.Dialog.Response"/> event with the given response ID.</summary>
<param name="response_id">an object of type <see cref="T:System.UInt32"/>.</param>
<remarks>
Emits the <see cref="E:Gtk.Dialog.Response"/> event with the given response ID.
Used to indicate that the user has responded to the <see cref="T:Gtk.Dialog"/> in some way;
typically either you or <see cref="M:Gtk.Dialog.Run()"/> will be monitoring the <see cref="E:Gtk.Dialog.Response"/> event and take appropriate action.
</remarks>
</Docs>
</Member>
<Member MemberName="AddButton">
@ -91,11 +116,16 @@
<Parameter Name="response_id" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="button_text">To be added: an object of type 'string'</param>
<param name="response_id">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'Gtk.Widget'</returns>
<remarks>To be added</remarks>
<summary>Adds a <see cref="T:Gtk.Button"/> with the given text.</summary>
<param name="button_text">an object of type <see cref="T:System.String"/>.</param>
<param name="response_id">an object of type <see cref="T:System.UInt32"/>.</param>
<returns>an object of type <see cref="T:Gtk.Widget"/></returns>
<remarks>
Adds a <see cref="T:Gtk.Button"/> with the given text (or a stock button, if button_text is a stock ID)
and sets things up so that clicking the <see cref="T:Gtk.Button"/> will emit a <see cref="E:Gtk.Dialog.Response"/> with the given response_id.
The <see cref="T:Gtk.Button"/> is appended to the end of the <see cref="T:Gtk.Dialog.ActionArea"/>.
The <see cref="T:Gtk.Button"/> is returned, but usually you do not need it.
</remarks>
</Docs>
</Member>
<Member MemberName="SetResponseSensitive">
@ -109,10 +139,13 @@
<Parameter Name="setting" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="response_id">To be added: an object of type 'int'</param>
<param name="setting">To be added: an object of type 'bool'</param>
<remarks>To be added</remarks>
<summary>A convenient way to sensitize/desensitize dialog buttons.</summary>
<param name="response_id">an object of type <see cref="T:System.UInt32"/>.</param>
<param name="setting">an object of type <see cref="T:System.Boolean"/>.</param>
<remarks>
Calls <see cref="M:Gtk.Widget.SetSensitive(System.Int32,System.Boolean)"/> for each widget in the <see cref="P:Gtk.Dialog.ActionArea"/> with the given response_id.
A convenient way to sensitize/desensitize dialog buttons.
</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -149,9 +182,12 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.Dialog'</returns>
<remarks>To be added</remarks>
<summary>Creates a new dialog box.</summary>
<returns>an object of type <see cref="T:Gtk.Dialog"/>.</returns>
<remarks>
Creates a new dialog box.
This is an internal constructor, and should not be used by user code.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -164,12 +200,16 @@
<Parameter Name="flags" Type="Gtk.DialogFlags" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="title">To be added: an object of type 'string'</param>
<param name="parent">To be added: an object of type 'Gtk.Window'</param>
<param name="flags">To be added: an object of type 'Gtk.DialogFlags'</param>
<returns>To be added: an object of type 'Gtk.Dialog'</returns>
<remarks>To be added</remarks>
<summary>Creates a new dialog box.</summary>
<param name="title">an object of type <see cref="T:System.String"/>.</param>
<param name="parent">an object of type <see cref="T:Gtk.Window"/>.</param>
<param name="flags">an object of type <see cref="T:Gtk.DialogFlags"/>.</param>
<returns>an object of type <see cref="T:Gtk.Dialog"/>.</returns>
<remarks>
Creates a new <see cref="T:Gtk.Dialog"/> with the specified title and parent widget.
The <see cref="T:Gtk.DialogFlags"/> argument can be used to make the dialog modal (<see cref="F:Gtk.DialogFlags.Modal"/>)
and/or to have it destroyed along with its parent (<see cref="F:Gtk.DialogFlags.DestroyWithParent"/>).
</remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -179,8 +219,8 @@
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gtk.Dialog</summary>
<returns>The GLib Type for the Gtk.Dialog class.</returns>
<summary>The <see cref="T:GLib.Type"/> for <see cref="T:Gtk.Dialog"/>.</summary>
<returns>The <see cref="T:GLib.Type"/> for the <see cref="T:Gtk.Dialog"/> class.</returns>
<remarks />
</Docs>
</Member>
@ -192,7 +232,7 @@
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.VBox'</returns>
<returns>an object of type <see cref="T:Gtk.VBox"/></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -204,7 +244,7 @@
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.VBox'</returns>
<returns>an object of type <see cref="T:Gtk.VBox"/>.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -218,10 +258,10 @@
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Sets the default response_id.</summary>
<param name="value">an object of type <see cref="T:System.Int32"/></param>
<returns>an object of type <see cref="T:System.Int32"/></returns>
<remarks>Sets the default response_id.</remarks>
</Docs>
</Member>
<Member MemberName="HasSeparator">
@ -234,10 +274,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>Whether to display a <see cref="T:Gtk.HSeperator"/>.</summary>
<param name="value">an object of type <see cref="T:System.Boolean"/></param>
<returns>an object of type <see cref="T:System.Boolean"/></returns>
<remarks>Whether to display a <see cref="T:Gtk.HSeperator"/> in the <see cref="T:Gtk.Dialog"/> above the <see cref="P:Gtk.Dialog.ActionArea"/></remarks>
</Docs>
</Member>
<Member MemberName="Response">
@ -247,7 +287,12 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks>
Emitted when an action widget is clicked, the <see cref="T:Gtk.Dialog"/>
receives a delete event, or the application programmer calls <see cref="M:Gtk.Dialog.Respond()"/>.
On a delete event, the response ID is <see cref="F:Gtk.ResponseType.None"/>.
Otherwise, it depends on which action widget was clicked.
</remarks>
</Docs>
</Member>
<Member MemberName="Close">
@ -277,4 +322,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

20
doc/en/Gtk/DialogFlags.xml
View file

@ -1,5 +1,5 @@
<Type Name="DialogFlags" FullName="Gtk.DialogFlags">
<TypeSignature Language="C#" Value="public sealed struct DialogFlags;" Maintainer="auto" />
<TypeSignature Language="C#" Value="public sealed struct DialogFlags;" Maintainer="John Luke" />
<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>Flags used in <see cref="T:Gtk.Dialog"/> creation.</summary>
<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>Sets the property <see cref="P:Gtk.Window.Modal"/> = <see langword="true"/> for the <see cref="Gtk.Dialog"/>.</summary>
<remarks>Sets the property <see cref="P:Gtk.Window.Modal"/> = <see langword="true"/> for the <see cref="Gtk.Dialog"/>.</remarks>
</Docs>
</Member>
<Member MemberName="DestroyWithParent">
@ -46,8 +46,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Destroying the parent <see cref="T:Gtk.Window"/> will also destroy the <see cref="T:Gtk.Dialog"/>.</summary>
<remarks>Destroying the parent <see cref="T:Gtk.Window"/> will also destroy the <see cref="T:Gtk.Dialog"/>.</remarks>
</Docs>
</Member>
<Member MemberName="NoSeparator">
@ -58,8 +58,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>No separator bar above the buttons.</summary>
<remarks>No separator bar above the buttons.</remarks>
</Docs>
</Member>
<Member MemberName="value__">
@ -75,4 +75,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>