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

en/Gtk/Dialog.xml: fixes

Browse source 
en/Gtj/Application.xml: add example, fix methods

svn path=/trunk/gtk-sharp/; revision=15947
This commit is contained in:
John Luke 2003-07-04 21:36:15 +00:00
parent 7962dfd294
commit bef993d3cc
3 changed files with 64 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/ChangeLog
View file

@ -1,3 +1,8 @@
2003-07-04 John Luke <jluke@cfl.rr.com>
* en/Gtk/Dialog.xml: fixes
* en/Gtk/Application.xml: add example, fix methods
2003-07-04 Duncan Mak <duncan@ximian.com> 2003-07-04 Duncan Mak <duncan@ximian.com>
* en/Gtk/AccelGroup.xml: revert parts of my last patch, as some of * en/Gtk/AccelGroup.xml: revert parts of my last patch, as some of
@ -17,7 +22,7 @@
* en/Gtk/ResponseType.xml: documented. * en/Gtk/ResponseType.xml: documented.
2003-07-02 John Luke <jluke@cfl.rr.com> 2003-07-03 John Luke <jluke@cfl.rr.com>
* en/Gtk/Container.xml: add first draft * en/Gtk/Container.xml: add first draft

73
doc/en/Gtk/Application.xml
View file

@ -1,5 +1,5 @@
<Type Name="Application" FullName="Gtk.Application"> <Type Name="Application" FullName="Gtk.Application">
<TypeSignature Language="C#" Value="public class Application" Maintainer="auto" /> <TypeSignature Language="C#" Value="public class Application" Maintainer="John Luke" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -11,11 +11,38 @@
<remarks> <remarks>
<para> <para>
Provides the initialization and event loop iteration related Provides the initialization and event loop iteration related
methods for the GTK widget library. Since GTK+ is an event methods for the Gtk# widget library. Since Gtk# is an event
driven toolkit, Applications register callbacks against various driven toolkit, Applications register callbacks against various
events to handle user input. These callbacks are invoked from events to handle user input. These callbacks are invoked from
the main event loop when events are detected. the main event loop when events are detected.
</para> </para>
<example>
<code lang="C#">
using Gtk;
using GtkSharp;
using System;
public class HelloWorld {
public static int Main (string[] args)
{
Application.Init ();
Gtk.Window win = new Gtk.Window ("Gtk# Hello World");
win.DeleteEvent += new DeleteEventHandler (Window_Delete);
win.ShowAll ();
Application.Run ();
return 0;
}
static void Window_Delete (object obj, DeleteEventArgs args)
{
SignalArgs sa = (SignalArgs) args;
Application.Quit ();
sa.RetVal = true;
}
}
</code>
</example>
</remarks> </remarks>
</Docs> </Docs>
<Base> <Base>
@ -52,8 +79,8 @@
<remarks> <remarks>
<para> <para>
Runs a single iteration of the mainloop. If no events are Runs a single iteration of the mainloop. If no events are
waiting to be processed GTK+ will block until the next waiting to be processed Gtk# will block until the next
event is noticed. If you don't want to block look at <see cref="M:Gtk.Application.RunIteration(bool)" /> or check if event is noticed. If you do not want to block look at <see cref="M:Gtk.Application.RunIteration(System.Boolean)" /> or check if
any events are pending with <see cref="M:Gtk.Application.EventsPending()" /> first. any events are pending with <see cref="M:Gtk.Application.EventsPending()" /> first.
</para> </para>
</remarks> </remarks>
@ -68,7 +95,7 @@
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Whether there are events on the queue</summary> <summary>Whether there are events on the queue</summary>
<returns>true if events are available to be processed, false otherwise</returns> <returns><see langword="true"/> if events are available to be processed, <see langword="false"/> otherwise</returns>
<remarks> <remarks>
<para> <para>
Checks if any events are pending. This can be used to Checks if any events are pending. This can be used to
@ -77,8 +104,8 @@
</para> </para>
<example> <example>
<code lang="C#"> <code lang="C#">
void LongComputation () void LongComputation ()
{ {
while (!done){ while (!done){
ComputationChunk (); ComputationChunk ();
@ -86,7 +113,7 @@
while (Application.EventsPending ()) while (Application.EventsPending ())
Application.RunIteration (); Application.RunIteration ();
} }
} }
</code> </code>
</example> </example>
</remarks> </remarks>
@ -104,7 +131,7 @@
<remarks> <remarks>
<para> <para>
Runs the main loop until <see cref="M:Gtk.Application.Quit()" /> is called. You can nest Runs the main loop until <see cref="M:Gtk.Application.Quit()" /> is called. You can nest
calls to <see cref="Gtk.Application.Run()" />. In that calls to <see cref="M:Gtk.Application.Run()" />. In that
case <see cref="M:Gtk.Application.Quit()" /> will make the case <see cref="M:Gtk.Application.Quit()" /> will make the
innermost invocation of the main loop return. innermost invocation of the main loop return.
</para> </para>
@ -121,11 +148,11 @@
<Parameter Name="args" Type="System.String []&amp;" /> <Parameter Name="args" Type="System.String []&amp;" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Initializes GTK+ for operation.</summary> <summary>Initializes Gtk# for operation.</summary>
<param name="args">The arguments to pass to the toolkit</param> <param name="args">The arguments to pass to the toolkit</param>
<remarks> <remarks>
<para> <para>
Call this function before using any other GTK+ functions Call this function before using any other Gtk# functions
in your GUI applications. It will initialize everything in your GUI applications. It will initialize everything
needed to operate the toolkit. needed to operate the toolkit.
</para> </para>
@ -133,7 +160,7 @@
This function will terminate your program if it was unable This function will terminate your program if it was unable
to initialize the GUI for some reason. If you want your to initialize the GUI for some reason. If you want your
program to fall back to a textual interface you want to program to fall back to a textual interface you want to
call <see cref="M:Gtk.Application.InitCheck()" /> instead. call <see cref="M:Gtk.Application.InitCheck(System.String []&amp;)" /> instead.
</para> </para>
<para> <para>
The args values will be modified after Gtk has removed the The args values will be modified after Gtk has removed the
@ -152,13 +179,13 @@
<Parameter Name="args" Type="System.String []&amp;" /> <Parameter Name="args" Type="System.String []&amp;" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Initializes GTK+ for operation, probes window system.</summary> <summary>Initializes Gtk# for operation, probes window system.</summary>
<returns>true if the toolkit was initialized, false if the <returns>true if the toolkit was initialized, false if the
windowing system can not be initilized.</returns> windowing system can not be initilized.</returns>
<param name="args">The arguments to pass to the toolkit</param> <param name="args">The arguments to pass to the toolkit</param>
<remarks> <remarks>
<para> <para>
You use this call to initialize GTK+ for your GUI You use this call to initialize Gtk# for your GUI
applications. This method will allow your application to applications. This method will allow your application to
be both GUI/text. A true return value means that the be both GUI/text. A true return value means that the
toolkit was initialized, a false value means that the toolkit was initialized, a false value means that the
@ -169,7 +196,7 @@
This function will terminate your program if it was unable This function will terminate your program if it was unable
to initialize the GUI for some reason. If you want your to initialize the GUI for some reason. If you want your
program to fall back to a textual interface you want to program to fall back to a textual interface you want to
call <see cref="M:Gtk.Application.InitCheck()" /> instead. call <see cref="M:Gtk.Application.InitCheck(System.String []&amp;)" /> instead.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -185,7 +212,7 @@
<summary>Initializes GTK+ for operation.</summary> <summary>Initializes GTK+ for operation.</summary>
<remarks> <remarks>
<para> <para>
Call this function before using any other GTK+ functions Call this function before using any other Gtk# functions
in your GUI applications. It will initialize everything in your GUI applications. It will initialize everything
needed to operate the toolkit. needed to operate the toolkit.
</para> </para>
@ -193,11 +220,11 @@
This function will terminate your program if it was unable This function will terminate your program if it was unable
to initialize the GUI for some reason. If you want your to initialize the GUI for some reason. If you want your
program to fall back to a textual interface you want to program to fall back to a textual interface you want to
call <see cref="M:Gtk.Application.InitCheck()" /> instead. call <see cref="M:Gtk.Application.InitCheck(System.String []&amp;)" /> instead.
</para> </para>
<para> <para>
If you want to pass arguments from the command line use If you want to pass arguments from the command line use
the <see cref="T:Gtk.Application.Init(ref string [])" /> the <see cref="T:Gtk.Application.Init(System.String []&amp;)" />
method instead. method instead.
</para> </para>
</remarks> </remarks>
@ -210,16 +237,16 @@
<ReturnType>System.Boolean</ReturnType> <ReturnType>System.Boolean</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="blocking" Type="System.Boolean;" /> <Parameter Name="blocking" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary /> <summary />
<param name="block">A boolean value, whether the iteration should block or not</param> <param name="block">A boolean value, whether the iteration should block or not</param>
<remarks> <remarks>
<para> <para>
Runs a single iteration of the mainloop. If <paramref name="blocking" /> is true, then if no events are Runs a single iteration of the mainloop. If <paramref name="blocking" /> is <see langword="true"/>, then if no events are
waiting to be processed GTK+ will block until the next event is noticed; If <paramref name="blocking" /> is false, waiting to be processed Gtk# will block until the next event is noticed; If <paramref name="blocking" /> is <see langword="false"/>,
then it if no events are waiting to be processed Gtk+ routine will return immediately. then it if no events are waiting to be processed Gtk#, routine will return immediately.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
@ -232,7 +259,7 @@
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>To be added: an object of type 'object'</returns> <returns>an object of type <see cref="System.Object"/></returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>

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

@ -200,7 +200,7 @@ namespace GtkDialogSample
<param name="response_id">an object of type <see cref="T:System.UInt32"/>.</param> <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> <param name="setting">an object of type <see cref="T:System.Boolean"/>.</param>
<remarks> <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. Sets <see cref="P:Gtk.Widget.Sensitive"/> = <see langword="true"/> for each widget in the <see cref="P:Gtk.Dialog.ActionArea"/> with the given response_id.
A convenient way to sensitize/desensitize dialog buttons. A convenient way to sensitize/desensitize dialog buttons.
</remarks> </remarks>
</Docs> </Docs>
@ -346,7 +346,7 @@ namespace GtkDialogSample
<summary>To be added</summary> <summary>To be added</summary>
<remarks> <remarks>
Emitted when an action widget is clicked, the <see cref="T:Gtk.Dialog"/> 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()"/>. receives a delete event, or the application programmer calls <see cref="M:Gtk.Dialog.Respond(System.Int32)"/>.
On a delete event, the response ID is <see cref="F:Gtk.ResponseType.None"/>. On a delete event, the response ID is <see cref="F:Gtk.ResponseType.None"/>.
Otherwise, it depends on which action widget was clicked. Otherwise, it depends on which action widget was clicked.
</remarks> </remarks>