ryujinx/GtkSharp
1
0
Fork 0
mirror of https://github.com/Ryujinx/GtkSharp.git synced 2025-02-02 15:41:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

2004-05-28 Mike Kestner <mkestner@ximian.com>

Browse source 
* en/* : put back all the real docs the updater tossed.

svn path=/trunk/gtk-sharp/; revision=28367
This commit is contained in:
Mike Kestner 2004-05-28 17:31:16 +00:00
parent 73632b2747
commit 785ddede52
11 changed files with 89 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/ChangeLog
View file

@ -1,3 +1,7 @@
2004-05-28 Mike Kestner <mkestner@ximian.com>
* en/* : put back all the real docs the updater tossed.
2004-05-28 Mike Kestner <mkestner@ximian.com>
* en/* : run updater. fix a few *Sharp copy/pastisms.

18
doc/en/Gnome/Canvas.xml
View file

@ -988,10 +988,22 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Gets or Sets the number of pixels that correspond to one canvas unit.</summary>
<returns>a <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
<remarks>
<para>
The anchor point for zooming, i.e. the point that stays
fixed and all others zoom inwards or outwards from it,
depends on whether the canvas is set to center the
scrolling region or not. You can control this using the
<see cref="P:Gnome.CanvasCenterScrollRegion" /> function. If the
canvas is set to center the scroll region, then the center
of the canvas window is used as the anchor point for
zooming. Otherwise, the upper-left corner of the canvas
window is used as the anchor point.
</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

6
doc/en/Gnome/Druid.xml
View file

@ -313,12 +313,12 @@
<Parameter Name="close_on_cancel" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Creates a new toplevel window with the title of <paramref name="title" /> (which can be <see langword="null" />) and a parent of <paramref name="parent" /> (which also can be <see langword="null" />).</summary>
<param name="title">a <see cref="T:System.String" /></param>
<param name="parent">a <see cref="T:Gtk.Window" /></param>
<param name="close_on_cancel">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks>
<remarks>The druid will be placed inside this window. The window and the druid will both be shown. When the druid gets destroyed, so will the window that is created here.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -394,4 +394,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

16
doc/en/Gtk/Adjustment.xml
View file

@ -330,9 +330,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Retrieve the lower bound of this Adjustment.</summary>
<returns>a <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
<remarks>The minimum possible value that is currently allowed.</remarks>
</Docs>
</Member>
<Member MemberName="Upper">
@ -343,9 +343,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Retrieve the upper bound of this Adjustment.</summary>
<returns>a <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
<remarks>The maximum possible value that is currently allowed.</remarks>
</Docs>
</Member>
<Member MemberName="StepIncrement">
@ -356,10 +356,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The increment to use to make minor changes to the value.</summary>
<returns>a <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
<remarks>
<para>In a <see cref="T:Gtk.Scrollbar" /> this increment is used when the mouse is clicked on the arrows at the top and bottom of the <see cref="T:Gtk.Scrollbar" />, to scroll by a small amount.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

6
doc/en/Gtk/Calendar.xml
View file

@ -580,10 +580,10 @@ void HandleDaySelected (object obj, EventArgs args)
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>a DateTime that contains the current day for the Calendar widget</summary>
<returns>a <see cref="T:System.DateTime" /></returns>
<remarks>To be added</remarks>
<remarks>Setting the date fires Calendar changes events (Day, Month/Year)</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

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

@ -449,9 +449,9 @@ namespace GtkDialogSample
<ReturnType>Gtk.ResponseType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>Sets the default response_id.</summary>
<returns>a <see cref="T:Gtk.ResponseType" /></returns>
<remarks>To be added</remarks>
<remarks>Sets the default response_id.</remarks>
</Docs>
</Member>
<Member MemberName="OnResponse">
@ -480,11 +480,11 @@ namespace GtkDialogSample
<Parameter Name="setting" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>A convenient way to sensitize/desensitize dialog buttons.</summary>
<param name="response_id">a <see cref="T:System.Int32" /></param>
<param name="setting">a <see cref="T:System.Boolean" /></param>
<remarks>To be added</remarks>
<remarks>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.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

6
doc/en/Gtk/ListStore.xml
View file

@ -1408,10 +1408,10 @@ The above example creates a new three columns list store. The types of the colum
<Parameter Name="iter" Type="Gtk.TreeIter&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Removes a row from the store.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>After being removed, iter is set to be the next valid row, or invalidated if it pointed to the last row in the store.</remarks>
</Docs>
</Member>
<Member MemberName="GetValue">
@ -1434,4 +1434,4 @@ The above example creates a new three columns list store. The types of the colum
</Docs>
</Member>
</Members>
</Type>
</Type>

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

@ -1190,7 +1190,7 @@ store = new TreeStore (typeof (int), typeof (string));
<Parameter Name="column" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Gets a value at <paramref name="iter" /> and <paramref name="column" />.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<param name="column">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Object" /></returns>
@ -1637,4 +1637,4 @@ store = new TreeStore (typeof (int), typeof (string));
</Docs>
</Member>
</Members>
</Type>
</Type>

8
doc/en/Gtk/TreeView.xml
View file

@ -1032,12 +1032,12 @@ public class TreeViewDemo {
<Parameter Name="path" Type="Gtk.TreePath&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Finds the path at the point (x, y), relative to widget coordinates.</summary>
<param name="x">an object of type <see cref="T:System.Int32" /></param>
<param name="y">an object of type <see cref="T:System.Int32" /></param>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>It is primarily for things like popup menus. If <paramref name="path" /> is non-<see langword="null" />, then it will be filled with the <see cref="T:Gtk.TreePath" /> at that point. If <paramref name="column" /> is non-<see langword="null" />, then it will be filled with the <paramref name="column" /> at that point. This function is only meaningful if TreeView is realized.</remarks>
</Docs>
</Member>
<Member MemberName="WidgetToTreeCoords">
@ -1938,7 +1938,7 @@ tree_view.AppendColumn ("title", text, "text", 0);
<Parameter Name="cell_y" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Finds the path at the point (x, y), relative to widget coordinates.</summary>
<param name="x">a <see cref="T:System.Int32" /></param>
<param name="y">a <see cref="T:System.Int32" /></param>
<param name="path">a <see cref="T:Gtk.TreePath" /></param>
@ -1972,4 +1972,4 @@ tree_view.AppendColumn ("title", text, "text", 0);
</Docs>
</Member>
</Members>
</Type>
</Type>

19
doc/en/Gtk/Widget.xml
View file

@ -4641,9 +4641,22 @@ handle focus grabs.</returns>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Obtains or sets the event mask for the <paramref name="widget" /> (a bitfield containing flags from <see cref="T:Gdk.EventMask" />).</summary>
<returns>a <see cref="T:Gdk.EventMask" /></returns>
<remarks>To be added</remarks>
<remarks>
<para>
The event mask determines which events a <paramref name="widget" /> will receive. Keep in mind that different widgets have different default event masks, and by changing the event mask you may disrupt a <paramref name="widget" />'s fuctionalit, so be careful.
</para>
<para>
This property must be called while a <paramref name="widget" /> is unrealized. Consider <see cref="M:Gtk.Widget.AddEvents" /> for widgets that are already realized, or if you want to preserve the existing event mask.
</para>
<para>
This property can't be used with <see cref="F:Gtk.WidgetFlags.NoWindow" /> widgets; to get events on those events, place them inside a <see cref="T:Gtk.EventBox" /> and receive events on the event box.
</para>
<para>
These are the events that the <paramref name="widget" /> will receive.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="OnSizeRequested">
@ -4662,4 +4675,4 @@ handle focus grabs.</returns>
</Docs>
</Member>
</Members>
</Type>
</Type>

28
doc/en/Gtk/Window.xml
View file

@ -1687,10 +1687,32 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Sets or obtains the default size of <paramref name="window" />.</summary>
<returns>a <see cref="T:Gdk.Size" /></returns>
<remarks>To be added</remarks>
<remarks>
<para>
A value of -1 for the size indicates that a default size has not been explicitly set for that dimension, so the "natural" size of the <paramref name="window" /> will be used.
</para>
<para>
If the <paramref name="window" />'s "natural" size (its size request) is larger than the default, the default will be ignored. More generally, if the default size does not obey the geometry hints for the <paramref name="window" /> (<see cref="M:Gtk.Window.SetGeometryHints" /> can be used to set these explicitly), the default size will be clamped to the nearest permitted size.
</para>
<para>
Unlike <see cref="M:Gtk.Widget.SizeRequest" />, which sets a size request for a <paramref name="widget" /> and thus would keep users from shrinking the <paramref name="window" />, this method only sets the initial size, just as if the user had resized the <paramref name="window" /> themselves. Users can still shrink the <paramref name="window" /> again as they normally would. Setting a default size of -1 means to use the "natural" default size (the size request of the <paramref name="window" />).
</para>
<para>
For more control over a <paramref name="window" />'s initial size and how resizing works, read <see cref="M:Gtk.Window.SetGeometryHints" />.
</para>
<para>
For some uses, <see cref="M:Gtk.Window.Resize" /> is a more appropriate method. <see cref="M:Gtk.Window.Resize" /> changes the current size of the <paramref name="window" />, rather than the size to be used on initial display. <see cref="M:Gtk.Window.Resize" /> always affects the <paramref name="window" /> itself, not the geometry widget.
</para>
<para>
The default size of a <paramref name="window" /> only affects the first time a <paramref name="window" /> is shown; if a <paramref name="window" /> is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size.
</para>
<para>
Windows can't actually be 0x0 in size, they must be at least 1x1, but passing 0 is OK, resulting in a 1x1 default size.
</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>