ryujinx/GtkSharp
1
0
Fork 0
mirror of https://github.com/Ryujinx/GtkSharp.git synced 2024-12-26 14:15:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix bulleted list in Fixed.xml

Browse source 
Add First draft for MessageDialog.xml and InputDialog.xml

svn path=/trunk/gtk-sharp/; revision=15015
This commit is contained in:
John Luke 2003-05-31 01:14:01 +00:00
parent 775cae7bb2
commit d77d6bbcea
4 changed files with 108 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/ChangeLog
View file

@ -1,9 +1,11 @@
2003-05-30 John Luke <jluke@cfl.rr.com> 2003-05-30 John Luke <jluke@cfl.rr.com>
* en/Gtk/ToggleButton.xml: Fix typo. * en/Gtk/ToggleButton.xml: Fix typo, bulleted list.
* en/Gtk/Progress.xml: Fix typo. * en/Gtk/Progress.xml: Fix typo.
* en/Gtk/Tooltips.xml: Fix method signature. * en/Gtk/Tooltips.xml: Fix method signature.
* en/Gtk/Button.xml: Add some info. * en/Gtk/Button.xml: Add some info.
* en/Gtk/MessageDialog.xml: Add first draft
* en/Gtk/InputDialog: Add first draft
2003-05-29 Lee Mallabone <gnome@fonicmonkey.net> 2003-05-29 Lee Mallabone <gnome@fonicmonkey.net>

11
doc/en/Gtk/Fixed.xml
View file

@ -12,11 +12,12 @@
<para>The <see cref="T:Gtk.Fixed" /> widget is a container which can place child widgets at fixed positions and with fixed sizes, given in pixels. <see cref="T:Gtk.Fixed" /> performs no automatic layout management.</para> <para>The <see cref="T:Gtk.Fixed" /> widget is a container which can place child widgets at fixed positions and with fixed sizes, given in pixels. <see cref="T:Gtk.Fixed" /> performs no automatic layout management.</para>
<para>For most applications, you should not use this container! It keeps you from having to learn about the other Gtk# containers, but it results in broken applications. With <see cref="T:Gtk.Fixed" />, the following things will result in truncated text, overlapping widgets, and other display bugs: <para>For most applications, you should not use this container! It keeps you from having to learn about the other Gtk# containers, but it results in broken applications. With <see cref="T:Gtk.Fixed" />, the following things will result in truncated text, overlapping widgets, and other display bugs:
<list type="bullet"> <list type="bullet">
<item>Themes, which may change widget sizes.</item> <item><term>Themes, which may change widget sizes.</term></item>
<item>Fonts other than the one you used to write the app will of course change the size of widgets containing text; keep in mind that users may use a larger font because of difficulty reading the default, or they may be using Windows or the framebuffer port of GTK+, where different fonts are available.</item> <item><term>Fonts other than the one you used to write the app will of course change the size of widgets containing text; keep in mind that users may use a larger font because of difficulty reading the default, or they may be using Windows or the framebuffer port of GTK+, where different fonts are available.</term></item>
<item>Translation of text into other languages changes its size. Also, display of non-English text will use a different font in many cases.</item> <item><term>Translation of text into other languages changes its size. Also, display of non-English text will use a different font in many cases.</term></item>
</list></para> </list>
<para>In addition, the fixed widget can't properly be mirrored in right-to-left languages such as Hebrew and Arabic. i.e. normally GTK+ will flip the interface to put labels to the right of the thing they label, but it can't do that with <see cref="T:Gtk.Fixed" />. So your application will not be usable in right-to-left languages.</para> </para>
<para>In addition, the fixed widget can't properly be mirrored in right-to-left languages such as Hebrew and Arabic. i.e. normally Gtk# will flip the interface to put labels to the right of the thing they label, but it can't do that with <see cref="T:Gtk.Fixed" />. So your application will not be usable in right-to-left languages.</para>
<para>Finally, fixed positioning makes it kind of annoying to add/remove GUI elements, since you have to reposition all the other elements. This is a long-term maintenance problem for your application.</para> <para>Finally, fixed positioning makes it kind of annoying to add/remove GUI elements, since you have to reposition all the other elements. This is a long-term maintenance problem for your application.</para>
<para>If you know none of these things are an issue for your application, and prefer the simplicity of <see cref="T:Gtk.Fixed" />, by all means use the widget. But you should be aware of the tradeoffs.</para> <para>If you know none of these things are an issue for your application, and prefer the simplicity of <see cref="T:Gtk.Fixed" />, by all means use the widget. But you should be aware of the tradeoffs.</para>
</remarks> </remarks>

43
doc/en/Gtk/InputDialog.xml
View file

@ -1,5 +1,5 @@
<Type Name="InputDialog" FullName="Gtk.InputDialog"> <Type Name="InputDialog" FullName="Gtk.InputDialog">
<TypeSignature Language="C#" Value="public class InputDialog : Gtk.Dialog, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" /> <TypeSignature Language="C#" Value="public class InputDialog : Gtk.Dialog, Implementor, IWrapper, IWrapper, IDisposable" 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>
@ -7,8 +7,23 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Configure devices for the XInput extension.</summary>
<remarks>To be added</remarks> <remarks>
<para>
NOTE: this <see cref="T:Gtk.Widget"/> is considered too specialized/little-used for Gtk#, and will in the future be moved to some other package.
If your application needs this <see cref="T:Gtk.Widget"/>, feel free to use it, as the <see cref="T:Gtk.Widget"/> does work and is useful in some applications; it's just not of general interest.
However, we are not accepting new features for the <see cref="T:Gtk.Widget"/>, and it will eventually move out of the Gtk# distribution.
</para>
<para>
<see cref="T:Gtk.InputDialog"/> displays a <see cref="T:Gtk.Dialog"/> which allows the user to configure XInput extension devices.
For each device, they can control the mode of the device (disabled, screen-relative, or window-relative), the mapping of axes to coordinates, and the mapping of the devices macro keys to key press events.
</para>
<para>
<see cref="T:Gtk.InputDialog"/> contains two <see cref="T:Gtk.Button"/>s to which the application can connect; one for closing the <see cref="T:Gtk.Dialog"/>, and one for saving the changes.
No actions are bound to these by default.
The changes that the user makes take effect immediately.
</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.Dialog</BaseTypeName> <BaseTypeName>Gtk.Dialog</BaseTypeName>
@ -63,9 +78,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Creates an instance of <see cref="T:Gtk.InputDialog"/></summary>
<returns>To be added: an object of type 'Gtk.InputDialog'</returns> <returns>an object of type <see cref="T:Gtk.InputDialog"/></returns>
<remarks>To be added</remarks> <remarks>Creates an instance of <see cref="T:Gtk.InputDialog"/></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -75,8 +90,8 @@
<ReturnType>System.UInt32</ReturnType> <ReturnType>System.UInt32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>The GLib Type for Gtk.InputDialog</summary> <summary>The <see cref="T:GLib.Type"/> for <see cref="T:Gtk.InputDialog"/></summary>
<returns>The GLib Type for the Gtk.InputDialog class.</returns> <returns>The <see cref="T:GLib.Type"/> for the <see cref="T:Gtk.InputDialog"/> class.</returns>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -86,8 +101,10 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Emitted when the user changes the mode of a device from a GDK_MODE_SCREEN or GDK_MODE_WINDOW to GDK_MODE_ENABLED.</summary>
<remarks>To be added</remarks> <remarks>
This signal is emitted when the user changes the mode of a device from a GDK_MODE_SCREEN or GDK_MODE_WINDOW to GDK_MODE_ENABLED.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="EnableDevice"> <Member MemberName="EnableDevice">
@ -96,8 +113,10 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Emitted when the user changes the mode of a device from GDK_MODE_DISABLED to a GDK_MODE_SCREEN or GDK_MODE_WINDOW.</summary>
<remarks>To be added</remarks> <remarks>
This signal is emitted when the user changes the mode of a device from GDK_MODE_DISABLED to a GDK_MODE_SCREEN or GDK_MODE_WINDOW.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">

87
doc/en/Gtk/MessageDialog.xml
View file

@ -1,5 +1,5 @@
<Type Name="MessageDialog" FullName="Gtk.MessageDialog"> <Type Name="MessageDialog" FullName="Gtk.MessageDialog">
<TypeSignature Language="C#" Value="public class MessageDialog : Gtk.Dialog, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" /> <TypeSignature Language="C#" Value="public class MessageDialog : Gtk.Dialog, Implementor, IWrapper, IWrapper, IDisposable" 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>
@ -7,8 +7,42 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Convenient message window</summary>
<remarks>To be added</remarks> <remarks>
<para>
<see cref="T:Gtk.MessageDialog"/> presents a <see cref="T:Gtk.Dialog"/> with an image representing the <see cref="T:Gtk.MessageType"/> (Error, Question, etc.) alongside some message text.
It's simply a convenience <see cref="T:Gtk.Widget"/>; you could construct the equivalent of <see cref="T:Gtk.MessageDialog"/> from <see cref="T:Gtk.Dialog"/> without too much effort, but <see cref="T:Gtk.MessageDialog"/> saves typing.
</para>
<para>
The easiest way to do a modal message dialog is to use <see cref="M:Gtk.Dialog.Run()"/>,
though you can also pass in the <see cref="F:Gtk.DialogFlags.Modal"/> flag, <see cref="M:Gtk.Dialog.Run()"/> automatically makes the <see cref="T:Gtk.MessageDialog"/> from <see cref="T:Gtk.Dialog"/> modal and waits for the user to respond to it.
<see cref="M:Gtk.Dialog.Run()"/> returns when any <see cref="T:Gtk.Button"/> in the <see cref="T:Gtk.Dialog"/> is clicked.
</para>
<para>A modal dialog
<example>
<code lang="C#">
MessageDialog md = new MessageDialog
(parent_window, Gtk.DialogFlags.DestroyWithParent,
Gtk.MessageType.Error, Gtk.ButtonsType.Close, "Error loading file");
md.Run ();
md.Destroy ();
</code>
</example>
</para>
<para>A non-modal dialog
<example>
<code lang="C#">
MessageDialog md = new MessageDialog
(parent_window, Gtk.DialogFlags.DestroyWithParent,
Gtk.MessageType.Error, Gtk.ButtonsType.Close, "Error loading file");
// Destroy the dialog when the user responds to it (e.g. clicks a button)
// ::add signal handler code here::
</code>
</example>
</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.Dialog</BaseTypeName> <BaseTypeName>Gtk.Dialog</BaseTypeName>
@ -51,7 +85,7 @@
<Docs> <Docs>
<summary>Internal constructor</summary> <summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param> <param name="raw">Pointer to the C object.</param>
<returns>An instance of MessageDialog, wrapping the C object.</returns> <returns>An instance of <see cref="T:Gtk.MessageDialog"/>, wrapping the C object.</returns>
<remarks> <remarks>
<para>This is an internal constructor, and should not be used by user code.</para> <para>This is an internal constructor, and should not be used by user code.</para>
</remarks> </remarks>
@ -63,9 +97,11 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<returns>To be added: an object of type 'Gtk.MessageDialog'</returns> <returns>an object of type <see cref="T:Gtk.MessageDialog"/></returns>
<remarks>To be added</remarks> <remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -80,14 +116,23 @@
<Parameter Name="msg" Type="System.String" /> <Parameter Name="msg" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Creates an instance of <see cref="T:Gtk.MessageDialog"/></summary>
<param name="parent_window">To be added: an object of type 'Gtk.Window'</param> <param name="parent_window">an object of type <see cref="T:Gtk.Window"/></param>
<param name="flags">To be added: an object of type 'Gtk.DialogFlags'</param> <param name="flags">an object of type <see cref="T:Gtk.DialogFlags"/></param>
<param name="type">To be added: an object of type 'Gtk.MessageType'</param> <param name="type">an object of type <see cref="T:Gtk.MessageType"/></param>
<param name="bt">To be added: an object of type 'Gtk.ButtonsType'</param> <param name="bt">an object of type <see cref="T:Gtk.ButtonsType"/></param>
<param name="msg">To be added: an object of type 'string'</param> <param name="msg">an object of type <see cref="T:System.String"/></param>
<returns>To be added: an object of type 'Gtk.MessageDialog'</returns> <returns>an object of type <see cref="T:Gtk.MessageDialog"/></returns>
<remarks>To be added</remarks> <remarks><para>
Creates an instance of <see cref="T:Gtk.MessageDialog"/>
<example>
<code lang="C#">
MessageDialog md = new MessageDialog
(parent_window, Gtk.DialogFlags.DestroyWithParent,
Gtk.MessageType.Error, Gtk.ButtonsType.Close, "Error loading file");
</code>
</example>
</para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -97,8 +142,8 @@
<ReturnType>System.UInt32</ReturnType> <ReturnType>System.UInt32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>The GLib Type for Gtk.MessageDialog</summary> <summary>The <see cref="T:GLib.Type"/> for <see cref="T:Gtk.MessageDialog"/></summary>
<returns>The GLib Type for the Gtk.MessageDialog class.</returns> <returns>The <see cref="T:GLib.Type"/> for the <see cref="T:Gtk.MessageDialog"/> class.</returns>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -109,9 +154,9 @@
<ReturnType>Gtk.MessageType</ReturnType> <ReturnType>Gtk.MessageType</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The <see cref="T:Gtk.MessageType"/> of the <see cref="T:Gtk.Dialog"/></summary>
<returns>To be added: an object of type 'Gtk.MessageType'</returns> <returns>an object of type <see cref="T:Gtk.MessageDialog"/></returns>
<remarks>To be added</remarks> <remarks>The <see cref="T:Gtk.MessageType"/> of the <see cref="T:Gtk.Dialog"/></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -124,7 +169,7 @@
<Docs> <Docs>
<summary>Internal constructor</summary> <summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param> <param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of MessageDialog, using the GLib-provided type</returns> <returns>Creates a new instance of <see cref="T:Gtk.MessageDialog"/>, using the GLib-provided type</returns>
<remarks> <remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gtk.MessageDialog" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para> <para>This is a constructor used by derivative types of <see cref="T:Gtk.MessageDialog" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks> </remarks>