* en/Gtk/Fixed.xml:

* en/Gtk/Image.xml:
	* en/Gtk/ToggleButton.xml:
	* en/Gtk/Frame.xml
	* en/Gtk/HBox.xml: small fixes

svn path=/trunk/gtk-sharp/; revision=16043
This commit is contained in:
John Luke 2003-07-08 18:44:29 +00:00
parent 2d3e7d7c9c
commit 59bcb39f2f
6 changed files with 39 additions and 31 deletions

View File

@ -1,3 +1,11 @@
2003-07-08 John Luke <jluke@cfl.rr.com>
* en/Gtk/Fixed.xml:
* en/Gtk/Image.xml:
* en/Gtk/ToggleButton.xml:
* en/Gtk/Frame.xml
* en/Gtk/HBox.xml: small fixes
2003-07-04 John Luke <jluke@cfl.rr.com>
* en/Gtk/Dialog.xml: fixes

View File

@ -17,7 +17,7 @@
<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>
<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>In addition, the fixed widget can not 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 not 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>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>
@ -144,7 +144,7 @@
<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>
<para>Gets whether the <see cref="T:Gtk.Fixed" /> has it's own <see cref="T:Gdk.Window" />.</para>
<para>Gets whether the <see cref="T:Gtk.Fixed" /> has its own <see cref="T:Gdk.Window" />.</para>
<para>Sets whether a <see cref="T:Gtk.Fixed" /> widget is created with a separate <see cref="T:Gdk.Window" /> or not. (By default, it will be created without a seperate <see cref="T:Gdk.Window" />). This function must be called while the <see cref="T:Gtk.Fixed" /> is not realized, for instance, immediately after the window is created.</para>
</remarks>
</Docs>

View File

@ -10,7 +10,7 @@
<summary>A <see cref="T:Gtk.Bin" /> with a decorative frame and optional <see cref="T:Gtk.Label" />.</summary>
<remarks>
<para>This widget draws a frame around whatever it contains, so is often used to visually group a set of widgets together.</para>
<para>If present, a label is drawn in a gap in the top side of the frame. The position of the label can be controlled with <see cref="M:Gtk.Frame.SetLabelAlign" />.</para>
<para>If present, a label is drawn in a gap in the top side of the frame. The position of the label can be controlled with <see cref="M:Gtk.Frame.SetLabelAlign(System.Single,System.Single)" />.</para>
</remarks>
</Docs>
<Base>
@ -113,8 +113,8 @@
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gtk.Frame</summary>
<returns>The GLib Type for the Gtk.Frame class.</returns>
<summary>The <see cref="T:GLib.Type"/> for <see cref="T:Gtk.Frame"/></summary>
<returns>The <see cref="T:GLib.Type"/> for the <see cref="T:Gtk.Frame"/> class.</returns>
<remarks />
</Docs>
</Member>
@ -250,4 +250,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -98,8 +98,8 @@
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gtk.HBox</summary>
<returns>The GLib Type for the Gtk.HBox class.</returns>
<summary>The <see cref="T:GLib.Type"/> for <see cref="T:Gtk.HBox"/></summary>
<returns>The <see cref="T:GLib.Type"/> for the <see cref="T:Gtk.HBox"/> class.</returns>
<remarks />
</Docs>
</Member>
@ -120,4 +120,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -11,10 +11,10 @@
<Docs>
<summary><see cref="T:Gtk.Widget" /> used to display an image. </summary>
<remarks>
<see cref="T:Gtk.Image"/> can be used as a container for a <see cref="Gdk.Pixbuf" />
or a <see cref="Gdk.PixbufAnimation" /> to get custom interfaces.
<see cref="Gtk.Image" /> cannot launch events, it is neccessary to
include it inside a <see cref="Gtk.EventBox" /> for that purpose.
<see cref="T:Gtk.Image"/> can be used as a container for a <see cref="T:Gdk.Pixbuf" />
or a <see cref="T:Gdk.PixbufAnimation" /> to get custom interfaces.
<see cref="T:Gtk.Image" /> cannot launch events, it is necessary to
include it inside a <see cref="T:Gtk.EventBox" /> for that purpose.
</remarks>
</Docs>
<Base>
@ -53,7 +53,7 @@
<remarks>
Creates a <see cref="T:Gtk.Image"/> displaying an <see cref="T:Gtk.IconSet"/>.
Sample stock sizes are <see cref="F:Gtk.IconSize.Menu"/>, <see cref="F:Gtk.IconSize.SmallToolbar"/>.
Instead of using this function, usually it's better to create a <see cref="T:Gtk.IconFactory"/>, put your <see cref="T:Gtk.IconSet"/> in the <see cref="T:Gtk.IconFactory"/>,
Instead of using this function, usually it is better to create a <see cref="T:Gtk.IconFactory"/>, put your <see cref="T:Gtk.IconSet"/> in the <see cref="T:Gtk.IconFactory"/>,
add the <see cref="T:Gtk.IconFactory"/> to the list of default factories with <see cref="M:Gtk.IconFactory.AddDefault()"/>, and then use <see cref="M:Gtk.Image.SetFromStock(System.String,Gtk.IconSize)"/>.
This will allow themes to override the icon you ship with your application.
</remarks>
@ -97,8 +97,8 @@
Creates a <see cref="T:Gtk.Image"/> displaying a stock icon.
Sample stock icon names are <see cref="P:Gtk.Stock.Open"/>, <see cref="P:Gtk.Stock.Ok"/>.
Sample stock sizes are <see cref="F:Gtk.IconSize.Menu"/>, <see cref="F:Gtk.IconSize.SmallToolbar"/>.
If the stock icon name isn't known, a "broken image" icon will be displayed instead.
You can register your own stock icon names, see <see cref="M:Gtk.IconFactory.AddDefault()"/> and <see cref="M:Gtk.IconFactory.Add()"/>.
If the stock icon name is not known, a "broken image" icon will be displayed instead.
You can register your own stock icon names, see <see cref="M:Gtk.IconFactory.AddDefault()"/> and <see cref="M:Gtk.IconFactory.Add(System.String,Gtk.IconSet)"/>.
</remarks>
</Docs>
</Member>
@ -247,7 +247,7 @@
passed to it.</summary>
<param name="pixbuf"><see cref="T:Gdk.Pixbuf" /> to be
displayed by the Image.</param>
<returns>To be added: an object of type 'Gtk.Image'An instance of type <see cref="T:Gtk.Image" />.</returns>
<returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
<remarks />
</Docs>
</Member>
@ -281,12 +281,12 @@
</Parameters>
<Docs>
<summary>This constructor is used to create an instance of
<see cref="T:Gtk.Image" /> containing the <see cref="Gtk.Stock" />
<see cref="T:Gtk.Image" /> containing the <see cref="T:Gtk.Stock" />
represented by the <see langword="string" /> passed to it and with the
size represented by the <see cref="Gtk.IconSize" /> passed.</summary>
size represented by the <see cref="T:Gtk.IconSize" /> passed.</summary>
<param name="stock_id"><see langword="string" /> identifier
for the <see cref="Gtk.Stock" />.</param>
<param name="size"><see cref="Gtk.IconSize" /> used by the Image.</param>
for the <see cref="T:Gtk.Stock" />.</param>
<param name="size"><see cref="T:Gtk.IconSize" /> used by the Image.</param>
<returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
<remarks />
</Docs>

View File

@ -10,7 +10,7 @@
<summary>A button that can be toggled on and off.</summary>
<remarks>
<para>A <see cref="T:Gtk.ToggleButton" /> is a <see cref="T:Gtk.Button" /> which will remain 'pressed-in' when clicked.
Clicking again will cause the toggle button to return to it's normal state. This is useful if you need to maintain the state of a button.</para>
Clicking again will cause the toggle button to return to its normal state. This is useful if you need to maintain the state of a button.</para>
<example>
<code lang="C#" source="ToggleButton.cs">
using Gtk;
@ -211,9 +211,9 @@ btn.Add(label);
<remarks>
<para>The Mode of the <see cref="T:Gtk.ToggleButton" /></para>
<para>Sets whether the button is displayed as a separate indicator and label.
You can call this function on a <see cref="Gtk.CheckButton" /> or a <see cref="Gtk.RadioButton" /> with <see cref="P:Gtk.ToggleButton.DrawIndicator" /> = <see langword="false" /> to make the button look like a normal button
You can call this function on a <see cref="T:Gtk.CheckButton" /> or a <see cref="T:Gtk.RadioButton" /> with <see cref="P:Gtk.ToggleButton.DrawIndicator" /> = <see langword="false" /> to make the button look like a normal button
</para>
<para>This function only effects instances of classes like <see cref="Gtk.CheckButton" /> and <see cref="Gtk.RadioButton" />
<para>This function only effects instances of classes like <see cref="T:Gtk.CheckButton" /> and <see cref="T:Gtk.RadioButton" />
that derive from <see cref="T:Gtk.ToggleButton" />, not instances of <see cref="T:Gtk.ToggleButton" /> itself.
</para>
</remarks>
@ -230,14 +230,14 @@ btn.Add(label);
</Parameters>
<Docs>
<summary>Determines if the <see cref="T:Gtk.ToggleButton" /> has an intermediate state.</summary>
<param name="value">an object of type 'bool'</param>
<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>
<para>
If the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a toggle button,
If the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a <see cref="T:Gtk.ToggleButton"/>,
and the current values in that range are inconsistent, you may want to display the toggle in an "in between" state.
This function turns on "in between" display. Normally you would turn off the inconsistent state again if the user toggles the toggle button.
This has to be done manually, <see cref="P:Gtk.ToggleButton.Inconsistent" /> only affects visual appearance, it doesn't affect the semantics of the button.
This function turns on "in between" display. Normally you would turn off the inconsistent state again if the user toggles the <see cref="T:Gtk.ToggleButton"/>.
This has to be done manually, <see cref="P:Gtk.ToggleButton.Inconsistent" /> only affects visual appearance, it does not affect the semantics of the <see cref="T:Gtk.Button"/>.
</para>
</remarks>
</Docs>
@ -253,11 +253,11 @@ btn.Add(label);
</Parameters>
<Docs>
<summary>Get or set the <see cref="T:Gtk.ToggleButton" /> active</summary>
<param name="value">an object of type 'bool'</param>
<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>
<para>Get or set the <see cref="T:Gtk.ToggleButton" /> active.</para>
<para>Get: Queries a <see cref="T:Gtk.ToggleButton" /> and returns it's current state.
<para>Get: Queries a <see cref="T:Gtk.ToggleButton" /> and returns its current state.
Returns <see langword="true" /> if the toggle button is pressed in and <see langword="false" /> if it is raised.
</para>
<example>
@ -308,7 +308,7 @@ btn.Active = true;
<Parameters />
<Docs>
<summary>Triggered when the <see cref="T:Gtk.ToggleButton" /> is clicked.</summary>
<remarks>Should be connected if you wish to perform an action whenever the <see cref="T:Gtk.ToggleButton" />'s state is changed.
<remarks>Should be connected if you wish to perform an action whenever the <see cref="T:Gtk.ToggleButton" /> state changes.
<example>
<code lang="C#">
ToggleButton btn = new ToggleButton("ToggleButton");