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

Next batch of commits

Browse source 
svn path=/trunk/gtk-sharp/; revision=22035
This commit is contained in:
Miguel de Icaza 2004-01-13 21:25:07 +00:00
parent c0e4552e54
commit 6507489ef9
12 changed files with 307 additions and 240 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

135
doc/en/Gdk/Display.xml
View file

@ -10,8 +10,23 @@
</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>
<para>Controls the keyboard/mouse pointer grabs and a set of GdkScreens</para>
</summary>
<remarks>
<para>
<see cref="T:Gdk.Display" /> objects purpose are two fold:</para>
<list type="bullet">
<item>
<term>To grab/ungrab keyboard focus and mouse pointer</term>
</item>
<item>
<term>To manage and provide information about the <see cref="T:Gdk.Screen" />(s) available for this <see cref="T:Gdk.Display" /></term>
</item>
</list>
<para>
<see cref="T:Gdk.Display" /> objects are the GDK representation of the X Display which can be described as a workstation consisting of a keyboard a pointing device (such as a mouse) and one or more screens. It is used to open and keep track of various <see cref="T:Gdk.Screen" /> objects currently instanciated by the application. It is also used to grab and release the keyboard and the mouse pointer.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
@ -49,9 +64,9 @@
<Parameter Name="display_name" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="display_name">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gdk.Display" /></returns>
<summary>Opens a display.</summary>
<param name="display_name">a <see cref="T:System.String" /> - the name of the display to open</param>
<returns>a <see cref="T:Gdk.Display" />, or null if the display could not be opened.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -65,8 +80,8 @@
<Parameter Name="evnt" Type="Gdk.Event" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="evnt">a <see cref="T:Gdk.Event" /></param>
<summary>Appends the given event onto the front of the event queue for display.</summary>
<param name="evnt">a <see cref="T:Gdk.Event" /> to be appended onto the front of the event queue.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -81,9 +96,9 @@
<Parameter Name="func" Type="Gdk.FilterFunc" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="message_type">a <see cref="T:Gdk.Atom" /></param>
<param name="func">a <see cref="T:Gdk.FilterFunc" /></param>
<summary>Adds a filter to be called when X ClientMessage events are received.</summary>
<param name="message_type">a <see cref="T:Gdk.Atom" /> representing the type of ClientMessage events to receive.</param>
<param name="func">a <see cref="T:Gdk.FilterFunc" /> to call to process the event.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -95,8 +110,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<summary>Test if the pointer is grabbed.</summary>
<returns>a <see cref="T:System.Boolean" /> that is true if an active X pointer grab is in effect.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -108,7 +123,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Emits a short beep.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -120,8 +135,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Event" /></returns>
<summary>Gets a copy of the first <see cref="T:Gdk.Event" /> in the display's event queue, without removing the event from the queue. (Note that this function will not get more events from the windowing system. It only checks the events that have already been moved to the GDK event queue.)</summary>
<returns>a copy of the first <see cref="T:Gdk.Event" /> on the event queue, or null if no events are in the queue.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -133,7 +148,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Closes the connection windowing system for the given display, and cleans up associated resources.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -147,8 +162,8 @@
<Parameter Name="screen_num" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="screen_num">a <see cref="T:System.Int32" /></param>
<summary>Returns a screen object for one of the screens of the display.</summary>
<param name="screen_num">a <see cref="T:System.Int32" /> representing the screen number</param>
<returns>a <see cref="T:Gdk.Screen" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -163,15 +178,23 @@
<Parameter Name="new_hooks" Type="Gdk.DisplayPointerHooks" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
</summary>
<param name="new_hooks">a <see cref="T:Gdk.DisplayPointerHooks" /></param>
<returns>a <see cref="T:Gdk.DisplayPointerHooks" /></returns>
<remarks>To be added</remarks>
<returns> the previous <see cref="T:Gdk.DisplayPointerHooks" /> table</returns>
<remarks>
<para>
This function allows for hooking into the operation of
getting the current location of the pointer on a
particular display. This is only useful for such
low-level tools as an event recorder. Applications
should never have any reason to use this facility.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="KeyboardUngrab">
<MemberSignature Language="C#" Value="public void KeyboardUngrab (uint time_);" />
<MemberType>Method</MemberType>
<MemberSignature Language="C#" Value="public void KeyboardUngrab (uint time_);" /> <MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
@ -179,8 +202,8 @@
<Parameter Name="time_" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="time_">a <see cref="T:System.UInt32" /></param>
<summary>Release any keyboard grab.</summary>
<param name="time_">a <see cref="T:System.UInt32" /> representing a a timestap.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -192,8 +215,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:GLib.List" /></returns>
<summary>Returns the list of available input devices attached to the display.</summary>
<returns>a <see cref="T:GLib.List" /> of <see cref="T:Gdk.Device" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -207,8 +230,8 @@
<Parameter Name="time_" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="time_">a <see cref="T:System.UInt32" /></param>
<summary>Release any pointer grab.</summary>
<param name="time_">a <see cref="T:System.UInt32" /> representing a a timestap.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -268,8 +291,8 @@
<ReturnType>Gdk.Display</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Display" /></returns>
<summary>Get the default <see cref="T:Gdk.Screen" /> for the display.</summary>
<returns> the default <see cref="T:Gdk.Screen" /> object for display.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -280,9 +303,10 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<summary>The name of the display</summary>
<returns>A <see cref="T:System.String" /> representing the
display name.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DoubleClickTime">
@ -294,10 +318,15 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets the double-click timeout.</summary>
<param name="value">a <see cref="T:System.UInt32" /></param>
<returns>a <see cref="T:System.UInt32" /></returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:Gdk.Display" />, or null if there is no default display.</returns>
<remarks>
<para>Sets the double click time (two clicks within this
time interval count as a double click). Applications
should NOT set this, it is a global user-configured
setting.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="DefaultScreen">
@ -307,8 +336,8 @@
<ReturnType>Gdk.Screen</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Screen" /></returns>
<summary>The default screen..</summary>
<returns>The screen represending the DefaultScreen.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -319,7 +348,9 @@
<ReturnType>Gdk.Device</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>
To be added
</summary>
<returns>a <see cref="T:Gdk.Device" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -331,8 +362,8 @@
<ReturnType>Gdk.Event</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Event" /></returns>
<summary>To be added.</summary>
<returns></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -356,7 +387,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Gets the next <see cref="T:Gdk.Event" /> to be processed for display, fetching events from the windowing system if necessary.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -373,12 +404,13 @@
<Parameter Name="mask" Type="Gdk.ModifierType&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Gets the current location of the pointer and the
current modifier mask for a given display.</summary>
<param name="screen">a <see cref="T:Gdk.Screen" /></param>
<param name="x">a <see cref="T:System.Int32&amp;" /></param>
<param name="y">a <see cref="T:System.Int32&amp;" /></param>
<param name="mask">a <see cref="T:Gdk.ModifierType&amp;" /></param>
<remarks>To be added</remarks>
<remarks>None</remarks>
</Docs>
</Member>
<Member MemberName="GetWindowAtPointer">
@ -392,11 +424,14 @@
<Parameter Name="win_y" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obtains the window underneath the mouse pointer.</summary>
<param name="win_x">a <see cref="T:System.Int32&amp;" /></param>
<param name="win_y">a <see cref="T:System.Int32&amp;" /></param>
<returns>a <see cref="T:Gdk.Window" /></returns>
<remarks>To be added</remarks>
<remarks>Obtains the window underneath the mouse pointer,
returning the location of that window in win_x, win_y for
screen. Returns NULL if the window under the mouse pointer is
not known to GDK (for example, belongs to another application).</remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -407,7 +442,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Gets the current location of the pointer and the current modifier mask for a given display.</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -422,8 +457,8 @@
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<summary>To be added.</summary>
<param name="win_x">a <see cref="T:System.Int32&amp;" /> - return location for origin of the window under the pointer</param>
<remarks>To be added</remarks>
</Docs>
</Member>

14
doc/en/Gdk/InterpType.xml
View file

@ -10,8 +10,10 @@
</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>Interpolation mode for scaling operations.</summary>
<remarks>Bilinear is the best balance in most cases.
Nearest provides faster (and low quality) scaling, while Hyper is slow but high-quality.
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -37,7 +39,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Nearest neighbor sampling; this is the fastest and lowest quality mode. Quality is normally unacceptable when scaling down, but may be OK when scaling up.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -49,7 +51,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>This is an accurate simulation of the PostScript image operator without any interpolation enabled. Each pixel is rendered as a tiny parallelogram of solid color, the edges of which are implemented with antialiasing. It resembles nearest neighbor for enlargement, and bilinear for reduction.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -61,7 +63,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Best quality/speed balance; use this mode by default. Bilinear interpolation. For enlargement, it is equivalent to point-sampling the ideal bilinear-interpolated image. For reduction, it is equivalent to laying down small tiles and integrating over the coverage area.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -73,7 +75,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>This is the slowest and highest quality reconstruction function. It is derived from the hyperbolic filters in Wolberg's "Digital Image Warping", and is formally defined as the hyperbolic-filter sampling the ideal hyperbolic-filter interpolated image (the filter is designed to be idempotent for 1:1 pixel mapping).</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

2
doc/en/Gdk/Screen.xml
View file

@ -10,7 +10,7 @@
</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>
<summary>Object representing a physical screen.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>

9
doc/en/Gdk/Window.xml
View file

@ -10,8 +10,13 @@
</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>
<para>Onscreen display area in the target window system.</para>
</summary>
<remarks>
<para>A <see cref="T:Gdk.Window" /> is a rectangular region on the screen. It's a low-level object, used to implement high-level objects such as <see cref="T:Gtk.Widget" /> and <see cref="T:Gtk.Window" /> on the GTK+ level.</para>
<para>A <see cref="T:Gtk.Widget" /> is a toplevel window, the thing a user might think of as a "window" with a titlebar and so on; a <see cref="T:Gtk.Widget" /> may contain many <see cref="T:Gdk.Window" />s. For example, each <see cref="T:Gtk.Button" /> has a <see cref="T:Gdk.Window" /> associated with it.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gdk.Drawable</BaseTypeName>

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

@ -11,8 +11,7 @@
<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>Widget for sequentially stepping through some pages.</summary>
<remarks>
</remarks>
<remarks>The widget which ultimately holds all of the druid's pages and information. This is the widget which the application developer then places inside an outer widget, such as a dialog box for ultimate display.</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Container</BaseTypeName>
@ -40,9 +39,11 @@
<Parameter Name="page" Type="Gnome.DruidPage" />
</Parameters>
<Docs>
<summary>This will prepend a <see cref="T:Gnome.DruidPage" /> into the internal list of pages of the druid.</summary>
<param name="page">an object of type <see cref="T:Gnome.DruidPage" /></param>
<remarks>Since GnomeDruid is just a container, you will need to also call <see cref="M:Gtk.Widget.Show()" /> on the page, otherwise the page will not be shown.</remarks>
<summary>
<para>This will prepend a <see cref="T:Gnome.DruidPage" /> into the internal list of pages that the druid has.</para>
</summary>
<param name="page"> The page to be inserted.</param>
<remarks>Since <see cref="T:Gnome.Druid" /> is just a container, you will need to also call Show() on the page, otherwise the page will not be shown.</remarks>
</Docs>
</Member>
<Member MemberName="InsertPage">
@ -56,10 +57,13 @@
<Parameter Name="page" Type="Gnome.DruidPage" />
</Parameters>
<Docs>
<summary>This will insert <paramref name="page" /> after <paramref name="back_page" /> into the list of internal pages of the druid.</summary>
<param name="back_page">an object of type <see cref="T:Gnome.DruidPage" /></param>
<param name="page">an object of type <see cref="T:Gnome.DruidPage" /></param>
<remarks>If <paramref name="back_page" /> is not present in the list or <see langword="null" />, <paramref name="page" /> will be prepended to the list. Since <see cref="T:Gnome.Druid" /> is just a container, you will need to also call <see cref="M:Gtk.Widget.Show()" /> on the page, otherwise the page will not be shown.</remarks>
<summary>This will insert a page after back_page into the list of internal pages that the druid has.</summary>
<param name="back_page"> The <see cref="T:Gnome.DruidPage" /> prior to the page to be inserted.</param>
<param name="page">The <see cref="T:Gnome.DruidPage" /> to insert.</param>
<remarks>
<para>If back_page is not present in the list or null, page will be prepended to the list.</para>
<para>Since <see cref="T:Gnome.Druid" /> is just a container, you will need to also call Show() on the page, otherwise the page will not be shown.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetButtonsSensitive">
@ -75,12 +79,12 @@
<Parameter Name="help_sensitive" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>Sets the sensitivity of of the control-buttons for the <see cref="T:Gnome.Druid" />.</summary>
<param name="back_sensitive">an object of type <see cref="T:System.Boolean" /></param>
<param name="next_sensitive">an object of type <see cref="T:System.Boolean" /></param>
<param name="cancel_sensitive">an object of type <see cref="T:System.Boolean" /></param>
<param name="help_sensitive">an object of type <see cref="T:System.Boolean" /></param>
<remarks>If the variables are <see langword="true" />, then they will be clickable. This function is used primarily by the actual <see cref="T:Gnome.DruidPage" /> widgets.</remarks>
<summary>Sets the sensitivity of druid's control-buttons.</summary>
<param name="back_sensitive">true if the back button is sensitive.</param>
<param name="next_sensitive">true if the next button is sensitive.</param>
<param name="cancel_sensitive">true if the cancel button is sensitive.</param>
<param name="help_sensitive">true if the help button is sensitive.</param>
<remarks>If the variables are true, then the buttons will be clickable. This function is used primarily by the actual GnomeDruidPage widgets.</remarks>
</Docs>
</Member>
<Member MemberName="AppendPage">
@ -93,9 +97,11 @@
<Parameter Name="page" Type="Gnome.DruidPage" />
</Parameters>
<Docs>
<summary>This will append <paramref name="page" /> onto the end of the internal list of the druid.</summary>
<param name="page">an object of type <see cref="T:Gnome.DruidPage" /></param>
<remarks>Since GnomeDruid is just a container, you will need to also call <see cref="M:Gtk.Widget.Show()" /> on the page, otherwise the page will not be shown.</remarks>
<summary>This will append a <see cref="T:Gnome.DruidPage" /> onto the end of the internal list.</summary>
<param name="page"> The <see cref="T:Gnome.DruidPage" /> to be appended.</param>
<remarks>
<para>Since <see cref="T:Gnome.Druid" /> is just a container, you will need to also call Show() on the page, otherwise the page will not be shown.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ConstructWithWindow">
@ -153,10 +159,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>Default constructor</summary>
<returns>an object of type <see cref="T:Gnome.Druid" /></returns>
<remarks>
</remarks>
<summary>Creates a new GnomeDruid widget.</summary>
<returns>a new <see cref="T:Gnome.Druid" /> Widget.</returns>
<remarks>You need to add this druid to a dialog yourself, it is not a dialog.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -170,13 +175,17 @@
<Parameter Name="window" Type="Gtk.Widget" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gnome.Druid" /> instance.</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="close_on_cancel">an object of type <see cref="T:System.Boolean" /></param>
<param name="window">an object of type <see cref="T:Gtk.Widget" /></param>
<returns>an object of type <see cref="T:Gnome.Druid" /></returns>
<summary>
<para>Creates a new <see cref="T:Gnome.Druid" /> widget inside a new toplevel window.</para>
</summary>
<param name="title"> A title of the window.</param>
<param name="parent"> The parent of this window (TransientFor).</param>
<param name="close_on_cancel">Indicates if the window should be closed when cancel is pressed.</param>
<param name="window"> Optional return of the <see cref="T:Gtk.Window" /> created.</param>
<returns>a new <see cref="T:Gnome.Druid" /> Widget.</returns>
<remarks>
<para>Creates a new <see cref="T:Gnome.Druid" /> widget and a new toplevel window with the given title (which can be null) and a parent (which also can be null). The window and the druid will both be shown.</para>
<para>When the druid gets destroyed, so will the window that is created here.</para>
</remarks>
</Docs>
</Member>
@ -205,10 +214,15 @@
<Parameters>
</Parameters>
<Docs>
<summary>Used to specify if the druid is currently showing the last page of the sequence (and hence should display "Finish", rather than "Next").</summary>
<param name="value">an object of type <see cref="T:System.Boolean" /></param>
<summary>
<para>This will make the given <see cref="T:Gnome.DruidPage" /> the currently showing page in the druid.</para>
</summary>
<param name="value">
<para>The <see cref="T:Gnome.DruidPage" /> to be brought to the foreground.</para>
</param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>
<para>The page must already be in the druid.</para>
</remarks>
</Docs>
</Member>
@ -221,11 +235,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>Sets the "Help" button on the druid to be visible in the lower left corner of the widget, if <see langword="true" />.</summary>
<param name="value">an object of type <see cref="T:System.Boolean" /></param>
<summary>Used to specify if the druid is currently showing the last page of the sequence.</summary>
<param name="value"> If true, then the "Next" button is changed to be "Finish".</param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>
</remarks>
<remarks>If set to true, the druid will display "Finish", rather than "Next".</remarks>
</Docs>
</Member>
<Member MemberName="Help">
@ -236,9 +249,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Emitted when the "Help" button of the druid is clicked.</summary>
<remarks>
</remarks>
<summary>Used to specify if the "Help" button on the druid is visible.</summary>
<remarks>If set to true, the "Help" button is shown in the lower left corner of the widget.</remarks>
</Docs>
</Member>
<Member MemberName="Cancel">

2
doc/en/Gnome/DruidPage.xml
View file

@ -126,7 +126,7 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>Default constructor</summary>
<summary>Creates a new <see cref="T:Gnome.DruidPage" />.</summary>
<returns>an object of type <see cref="T:Gnome.DruidPage" /></returns>
<remarks>
</remarks>

83
doc/en/Gnome/DruidPageEdge.xml
View file

@ -10,14 +10,10 @@
</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>A widget used to implement first and last pages in the sequence of the <see cref="T:Gnome.Druid" />.</summary>
<summary>A widget used to implement first and last pages in a druid's sequence.</summary>
<remarks>
<para>
A druid can be thought of as having a page that starts the sequence, one or more pages that end the sequences (there can be multiple end pages if the flow of pages diverges at some point) and some pages that are in between the start and end pages.
</para>
<para>
The <see cref="T:Gnome.DruidPageEdge" /> widget is for the first and last pages in the sequence of pages in the <see cref="T:Gnome.Druid" />. Pages in the "middle" of a sequence should use <see cref="T:Gnome.DruidPageStandard" />.
</para>
<para>A druid can be thought of as having a page that starts the sequence, one or more pages that end the sequences (there can be multiple end pages if the flow of pages diverges at some point) and some pages that are in between the start and end pages.</para>
<para>The <see cref="T:Gnome.DruidPageEdge" /> widget is for the first and last pages in a druid's sequence of pages. Pages in the "middle" of a sequence should use <see cref="T:Gnome.DruidPageStandard" />.</para>
</remarks>
</Docs>
<Base>
@ -117,8 +113,8 @@
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gnome.DruidPageEdge" /> widget.</summary>
<param name="position">an object of type <see cref="T:Gnome.EdgePosition" /></param>
<returns>an object of type <see cref="T:Gnome.DruidPageEdge" /></returns>
<param name="position">Position in druid.</param>
<returns>a new <see cref="T:Gnome.DruidPageEdge" />.</returns>
<remarks>
</remarks>
</Docs>
@ -137,17 +133,16 @@
<Parameter Name="top_watermark" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gnome.DruidPageEdge" /> widget.</summary>
<param name="position">an object of type <see cref="T:Gnome.EdgePosition" /></param>
<param name="antialiased">an object of type <see cref="T:System.Boolean" /></param>
<param name="title">an object of type <see cref="T:System.String" /></param>
<param name="text">an object of type <see cref="T:System.String" /></param>
<param name="logo">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<param name="watermark">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<param name="top_watermark">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<returns>an object of type <see cref="T:Gnome.DruidPageEdge" /></returns>
<remarks>
</remarks>
<summary>Creates a new <see cref="T:Gnome.DruidPageEdge" /> widget with the values given.</summary>
<param name="position">Position in druid.</param>
<param name="antialiased">Use an antialiased canvas.</param>
<param name="title">The title.</param>
<param name="text">The introduction text.</param>
<param name="logo">The logo in the upper right corner.</param>
<param name="watermark">The watermark on the left.</param>
<param name="top_watermark">The top watermark.</param>
<returns>a new <see cref="T:Gnome.DruidPageEdge" />.</returns>
<remarks>It is acceptable for any of the reference values to be null.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -156,8 +151,8 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<returns>an object of type <see cref="T:Gnome.DruidPageEdge" /></returns>
<summary>Creates a new <see cref="T:Gnome.DruidPageEdge" /> widget.</summary>
<returns>a new <see cref="T:Gnome.DruidPageEdge" />.</returns>
<remarks>This is an internal constructor, and should not be used by user code.</remarks>
</Docs>
</Member>
@ -186,8 +181,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>The title text of the page.</summary>
<param name="value">an object of type <see cref="T:System.String" /></param>
<summary>This will set the background color.</summary>
<param name="value"> The new background color.</param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks>
</remarks>
@ -202,8 +197,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>The color of the background in the main text area of the page.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<summary>Sets the contents of the page's title text.</summary>
<param name="value">The title text.</param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks>
</remarks>
@ -218,8 +213,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>The color of the text in the body of the druid page.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<summary>Sets the color of the background in the main text area of the page.</summary>
<param name="value">The new textbox color.</param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks>
</remarks>
@ -234,8 +229,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>The color behind the logo of the druid page.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<summary>Sets the color of the text in the body of the druid page.</summary>
<param name="value"> The new text color.</param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks>
</remarks>
@ -250,7 +245,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>Sets a <see cref="T:Gdk.Pixbuf" /> as the watermark on the left strip on the druid.</summary>
<summary>Set the color behind the druid page's logo.</summary>
<param name="value">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<returns>an object of type <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>If <see langword="null" />, it is reset to the normal color.</remarks>
@ -265,10 +260,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>Sets a <see cref="T:Gdk.Pixbuf" /> as the watermark on the top strip on the druid.</summary>
<param name="value">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<summary>Sets a <see cref="T:Gdk.Pixbuf" /> as the watermark on the left strip on the druid.</summary>
<param name="value">The <see cref="T:Gdk.Pixbuf" /> to use as a watermark.</param>
<returns>an object of type <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>If <see langword="null" />, it is reset to the normal color.</remarks>
<remarks>If watermark is set to null, it is reset to the normal color.</remarks>
</Docs>
</Member>
<Member MemberName="TitleColor">
@ -280,11 +275,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>The color of the title text on the current page.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<summary>Sets a <see cref="T:Gdk.Pixbuf" /> as the watermark on top of the top strip on the druid.</summary>
<param name="value">The <see cref="T:Gdk.Pixbuf" /> to use as a top watermark</param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks>
</remarks>
<remarks>If the top watermark is set to null, it is reset to the normal color.</remarks>
</Docs>
</Member>
<Member MemberName="Logo">
@ -296,8 +290,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>Sets a <see cref="T:Gdk.Pixbuf" /> as the logo in the top right corner.</summary>
<param name="value">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<summary>Sets the color of the title text on the current page.</summary>
<param name="value"> The color of the title text.</param>
<returns>an object of type <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>If <see langword="null" />, then no logo will be displayed.</remarks>
</Docs>
@ -311,11 +305,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>The contents of the text portion of the druid page.</summary>
<param name="value">an object of type <see cref="T:System.String" /></param>
<summary>Sets a <see cref="T:Gdk.Pixbuf" /> as the logo in the top right corner.</summary>
<param name="value">The <see cref="T:Gdk.Pixbuf" /> to use as a logo.</param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks>
</remarks>
<remarks>If set to null, then no logo will be displayed.</remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -326,7 +319,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Sets the contents of the text portion of the druid page.</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks>
</Docs>

70
doc/en/Gnome/DruidPageStandard.xml
View file

@ -10,15 +10,10 @@
</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>A widget used to implement the middle pages in a <see cref="T:Gnome.Druid" /> sequence.
</summary>
<summary>A widget used to implement the middle pages in a druid's sequence.</summary>
<remarks>
<para>
This widget provides similar functionality to that in GnomeDruidPageEdge. It is used for pages that are not the initial or terminal pages of a druid.
</para>
<para>
The main difference between an edge and a standard druid page (in a display sense) is that standard pages do not have a left-side watermark and the body of the contents section is a bit more arbitrary (it is a <see cref="T:Gtk.VBox" />), rather than just displaying text (which is the common case for edge pages).
</para>
<para>This widget provides similar functionality to that in <see cref="T:Gnome.DruidPageEdge" />. It is used for pages that are not the initial or terminal pages of a druid.</para>
<para>The main difference between an edge and a standard druid page (in a display sense) is that standard pages do not have a left-side watermark and the body of the contents section is a bit more arbitrary (it is a <see cref="T:GTK.VBox" /> widget), rather than just displaying text (which is the common case for edge pages).</para>
</remarks>
</Docs>
<Base>
@ -49,17 +44,13 @@
<Parameter Name="additional_info" Type="System.String" />
</Parameters>
<Docs>
<summary>Convenience function to add a <see cref="T:Gtk.Widget" /> to the <see cref="T:Gnome.DruidPageStandard" /> vbox.</summary>
<param name="question">an object of type <see cref="T:System.String" /></param>
<param name="item">an object of type <see cref="T:Gtk.Widget" /></param>
<param name="additional_info">an object of type <see cref="T:System.String" /></param>
<summary>Add a <see cref="T:Gtk.Widget" /> to a <see cref="T:Gnome.DruidPageStandard" />'s VBox.</summary>
<param name="question"> The text to place above the item.</param>
<param name="item">The <see cref="T:Gtk.Widget" /> to be included.</param>
<param name="additional_info"> The text to be placed below the item in a smaller font.</param>
<remarks>
<para>
This function creates a new contents section that has the <paramref name="question" /> text followed by the <paramref name="item" /> widget and then the <paramref name="addition_info" /> text, all stacked vertically from top to bottom.
</para>
<para>
The <paramref name="item" /> widget could be something like a set of radio checkbuttons requesting a choice from the user.
</para>
<para>Convenience function to add a <see cref="T:Gtk.Widget" /> to a <see cref="T:Gnome.DruidPageStandard" />'s VBox. This function creates a new contents section that has the question text followed by the item widget and then the addition_info text, all stacked vertically from top to bottom.</para>
<para>The item widget could be something like a set of radio checkbuttons requesting a choice from the user.</para>
</remarks>
</Docs>
</Member>
@ -97,8 +88,8 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>Default constructor</summary>
<returns>an object of type <see cref="T:Gnome.DruidPageStandard" /></returns>
<summary>Construct a new <see cref="T:Gnome.DruidPageStandard" />.</summary>
<returns>a new <see cref="T:Gnome.DruidPageStandard" />.</returns>
<remarks>
</remarks>
</Docs>
@ -113,11 +104,11 @@
<Parameter Name="top_watermark" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gnome.DruidPageStandard" /> instance.</summary>
<param name="title">an object of type <see cref="T:System.String" /></param>
<param name="logo">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<param name="top_watermark">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<returns>an object of type <see cref="T:Gnome.DruidPageStandard" /></returns>
<summary>Constructs a new <see cref="T:Gnome.DruidPageStandard" /> and allows the caller to fill in some of the values at the same time.</summary>
<param name="title"> The title of the druid page.</param>
<param name="logo"> The logo to put on the druid page.</param>
<param name="top_watermark"> The watermark to put at the top of the druid page.</param>
<returns>a new <see cref="T:Gnome.DruidPageStandard" />.</returns>
<remarks>
</remarks>
</Docs>
@ -147,8 +138,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>The title text to the specified color.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<summary>Sets the color of the main contents section's background.</summary>
<param name="value"> The new color for the main body's background.</param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks>
</remarks>
@ -209,11 +200,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>The title text to the specified color.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<summary>Sets a <see cref="T:Gdk.Pixbuf" /> as the logo in the top right corner.</summary>
<param name="value"> The <see cref="T:Gdk.Pixbuf" /> to use as a logo.</param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks>
</remarks>
<remarks>If set to null, then no logo will be displayed.</remarks>
</Docs>
</Member>
<Member MemberName="LogoBackground">
@ -225,8 +215,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>The background color of the logo</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<summary>Sets the title text to the specified color.</summary>
<param name="value"> The new color of the title text.</param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks>
</remarks>
@ -241,8 +231,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>The background color of the top section of the druid page.</summary>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<summary>Set the color behind the druid page's logo.</summary>
<param name="value"> The new color for the logo background.</param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks>
</remarks>
@ -257,8 +247,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>The title of the druid page.</summary>
<param name="value">an object of type <see cref="T:System.String" /></param>
<summary>Sets the background color of the top section of the druid page.</summary>
<param name="value"> The new background color.</param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks>
</remarks>
@ -304,10 +294,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">an object of type <see cref="T:System.Boolean" /></param>
<summary>Sets a <see cref="T:Gdk.Pixbuf" /> as the watermark on top of the top strip on the druid.</summary>
<param name="value"> The <see cref="T:Gdk.Pixbuf" /> to use as a top watermark.</param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>If set to null, the top watermark is reset to the normal color.</remarks>
</Docs>
</Member>
<Member MemberName="BackgroundSet">

17
doc/en/Gtk/RadioButton.xml
View file

@ -124,7 +124,22 @@
<param name="group">a <see cref="T:Gtk.RadioButton" /></param>
<param name="label">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.RadioButton" /></returns>
<remarks>To be added</remarks>
<remarks>Creates a RadioButton with the specified label and adds the newly created RadioButton to the same group as the RadioButton specified as the group parameter.
<example>
<code lang="C#">
// Example of creating two radio buttons in the same greoup
RadioButton radioButton1;
RadioButton radioButton2;
// create first radio button allowing it to create it's own RadioButton Group
radioButton1 = new RadioButton("Single Radio Button in it's own group");
// create second radio button. supply first radio button so that this one can be added
// to the first radio button's group
radioButton2 = new RadioButton(radioButton1, "Second radio button in the same group as radioButton1");
</code>
</example></remarks>
</Docs>
</Member>
<Member MemberName="GType">

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

@ -497,7 +497,7 @@ public class TreeViewDemo {
</Parameters>
<Docs>
<summary>Sets the compare function for the interactive search capabilities.</summary>
<param name="search_equal_func"> an object of type <see cref="T:Gtk.TreeViewSearchEqualFunc" /></param>
<param name="path">The <see cref="T:Gtk.TreePath" /> wich represents the node</param>
<param name="search_user_data">an object of type <see cref="T:System.IntPtr" /></param>
<param name="search_destroy">an object of type <see cref="T:Gtk.DestroyNotify" /></param>
<remarks>

122
doc/en/Pango/Layout.xml
View file

@ -10,8 +10,12 @@
</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>High-level driver for formatting entire paragraphs of text at once.</summary>
<remarks>
<para>While complete access to the layout capabilities of Pango is provided using the detailed interfaces for itemization and shaping, using that functionality directly involves writing a fairly large amount of code. The objects and functions in <see cref="T:Pango.Layout" /> provide a high-level driver for formatting entire paragraphs of text at once.</para>
<para>The <see cref="T:Pango.Layout" /> represents and entire paragraph of text. It is initialized with a <see cref="T:Pango.Context" />, UTF-8 string and set of attributes for that string. Once that is done, the set of formatted lines can be extracted from the object, the layout can be rendered, and conversion between logical character positions within the layout's text, and the physical position of the resulting glyphs can be made.</para>
<para>There are also a number of parameters to adjust the formatting of a <see cref="T:Pango.Layout" />. It is possible, as well, to ignore the 2-D setup, and simply treat the results of a <see cref="T:Pango.Layout" /> as a list of lines.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
@ -51,7 +55,7 @@
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Set the text of the layout.</summary>
<param name="text">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
</Docs>
@ -66,9 +70,9 @@
<Parameter Name="line" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="line">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'Pango.LayoutLine'</returns>
<summary>Retrieves a particular line.</summary>
<param name="line">the index of a line.</param>
<returns>the requested <see cref="T:Pango.LayoutLine" />, or null if the index is out of range.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -83,10 +87,10 @@
<Parameter Name="logical_rect" Type="Pango.Rectangle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="ink_rect">To be added: an object of type 'Pango.Rectangle'</param>
<param name="logical_rect">To be added: an object of type 'Pango.Rectangle'</param>
<remarks>To be added</remarks>
<summary>Compute the logical and ink extents of layout.</summary>
<param name="ink_rect">rectangle used to store the extents of the layout as drawn.</param>
<param name="logical_rect">rectangle used to store the logical extents of the layout.</param>
<remarks>Logical extents are usually what you want for positioning things. The extents are given in layout coordinates; layout coordinates begin at the top left corner of the layout.</remarks>
</Docs>
</Member>
<Member MemberName="GetSize">
@ -159,7 +163,7 @@
<Parameter Name="height" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Determine the logical width and height of a <see cref="T:Pango.Layout" /> in device units.</summary>
<param name="width">To be added: an object of type 'int&amp;'</param>
<param name="height">To be added: an object of type 'int&amp;'</param>
<remarks>To be added</remarks>
@ -201,9 +205,9 @@
<Parameter Name="context" Type="Pango.Context" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="context">To be added: an object of type 'Pango.Context'</param>
<returns>To be added: an object of type 'Pango.Layout'</returns>
<summary>Create a new PangoLayout object with attributes initialized to default values for a particular <see cref="T:Pango.Context" />.</summary>
<param name="context">a <see cref="T:Pango.Context" />.</param>
<returns>a new <see cref="T:Pango.Layout" />.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -237,8 +241,8 @@
<ReturnType>GLib.SList</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'GLib.SList'</returns>
<summary>The count of lines for the layout.</summary>
<returns>The count of lines for the layout.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -251,7 +255,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Return the lines of the layout as a list.</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>
@ -266,10 +270,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.Alignment'</param>
<summary>The amount by which the first line should be shorter than the rest of the lines.</summary>
<param name="value">the amount by which to indent.</param>
<returns>To be added: an object of type 'Pango.Alignment'</returns>
<remarks>To be added</remarks>
<remarks>The value be negative, in which case the subsequent lines will be shorter than the first line. (However, in either case, the entire width of the layout will be given by the value.</remarks>
</Docs>
</Member>
<Member MemberName="Tabs">
@ -281,10 +285,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.TabArray'</param>
<returns>To be added: an object of type 'Pango.TabArray'</returns>
<remarks>To be added</remarks>
<summary>The alignment for the layout.</summary>
<param name="value">The new alignment.</param>
<returns>The current alignment.</returns>
<remarks>Specifies how partial lines are positioned within the horizontal space available.</remarks>
</Docs>
</Member>
<Member MemberName="SingleParagraphMode">
@ -296,10 +300,13 @@
<Parameters>
</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>The tabs to use for the layout.</summary>
<param name="value">the tabs to use for the layout.</param>
<returns>the current <see cref="T:Pango.TabArray" /> used by this layout. If no <see cref="T:Pango.TabArray" /> has been set, then the default tabs are in use and null is returned.</returns>
<remarks>
<para>By default, tabs are every 8 spaces.</para>
<para>Setting new tabs overrides the default tabs. If Tabs is set to null, the default tabs are reinstated.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Context">
@ -309,9 +316,12 @@
<ReturnType>Pango.Context</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>Whether or not to treat newlines and similar characters as paragraph separators.</summary>
<returns>To be added: an object of type 'Pango.Context'</returns>
<remarks>To be added</remarks>
<remarks>
<para>If set to true, do not treat newlines and similar characters as paragraph separators; instead, keep all text in a single paragraph, and display a glyph for paragraph separator characters.</para>
<para>Used when you want to allow editing of newlines on a single text line.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Iter">
@ -321,7 +331,7 @@
<ReturnType>Pango.LayoutIter</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>the <see cref="T:Pango.Context" /> used for this layout.</summary>
<returns>To be added: an object of type 'Pango.LayoutIter'</returns>
<remarks>To be added</remarks>
</Docs>
@ -335,9 +345,9 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>An iterator to iterate over the visual extents of the layout.</summary>
<param name="value">To be added: an object of type 'Pango.AttrList'</param>
<returns>To be added: an object of type 'Pango.AttrList'</returns>
<returns>a new <see cref="T:Pango.LayoutIter" />.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -365,8 +375,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<summary>The amount of spacing between the lines of the layout.</summary>
<param name="value">the amount of spacing.</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
@ -380,10 +390,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<summary>Sets whether or not each complete line should be stretched to fill the entire width of the layout.</summary>
<param name="value">whether the lines in the layout should be justified.</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<remarks>This stretching is typically done by adding whitespace, but for some scripts (such as Arabic), the justification is done by extending the characters.</remarks>
</Docs>
</Member>
<Member MemberName="Text">
@ -393,7 +403,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>Sets the width to which the lines of the Layout should be wrapped.</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
@ -422,10 +432,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets the <see cref="T:Pango.WrapMode" />.</summary>
<param name="value">To be added: an object of type 'Pango.FontDescription'</param>
<returns>To be added: an object of type 'Pango.FontDescription'</returns>
<remarks>To be added</remarks>
<remarks>The wrap style only has an effect if a width is set on the layout. To turn off wrapping, set the width to -1.</remarks>
</Docs>
</Member>
<Member MemberName="SetMarkupWithAccel">
@ -440,11 +450,11 @@
<Parameter Name="accel_char" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="markup">To be added: an object of type 'string'</param>
<summary>Set the default <see cref="T:Pango.FontDescription" /> for the layout.</summary>
<param name="value">the new <see cref="Pango.FontDescription" />, or null to unset the current font description.</param>
<param name="accel_marker">To be added: an object of type 'string'</param>
<param name="accel_char">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
<remarks>If no <see cref="T:Pango.FontDescription" /> is set on the layout, the font description from the layout's context is used.</remarks>
</Docs>
</Member>
<Member MemberName="Size">
@ -550,13 +560,17 @@
<Parameter Name="trailing" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="x">a <see cref="T:System.Int32" /></param>
<param name="y">a <see cref="T:System.Int32" /></param>
<param name="index_">a <see cref="T:System.Int32&amp;" /></param>
<param name="trailing">a <see cref="T:System.Int32&amp;" /></param>
<summary>Computes a new cursor position from an old position and a count of positions to move visually.</summary>
<param name="strong">whether the moving cursor is the strong cursor or the weak cursor. The strong cursor is the cursor corresponding to text insertion in the base direction for the layout.</param>
<param name="old_index">the byte index of the grapheme for the old index.</param>
<param name="old_trailing">if 0, the cursor was at the trailing edge of the grapheme indicated by old_index, if &gt; 0, the cursor was at the leading edge.</param>
<param name="direction">direction to move cursor. A negative value indicates motion to the left.</param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>
<para>If count is positive, then the new strong cursor position will be one position to the right of the old cursor position. If count is position then the new strong cursor position will be one position to the left of the old cursor position.</para>
<para>In the presence of bidirection text, the correspondence between logical and visual order will depend on the direction of the current run, and there may be jumps when the cursor is moved off of the end of a run.</para>
<para>Motion here is in cursor positions, not in characters, so a single call to MoveCursorVisually() may move the cursor over multiple characters when multiple characters combine to form a single grapheme.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -580,10 +594,10 @@
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Pango.Layout" /></returns>
<remarks>To be added</remarks>
<summary>Convert from X and Y position within a layout to the byte index to the character at that logical position.</summary>
<param name="x">the X offset from the left edge of the layout.</param>
<returns>true if the coordinates were inside text.</returns>
<remarks>If the position is not inside the layout, the closest position is chosen (the x/y position will be clamped inside the layout). If a closest position is chosen, then the function returns false; on an exact hit, it returns true.</remarks>
</Docs>
</Member>
</Members>

5
doc/en/Pango/LayoutLine.xml
View file

@ -10,8 +10,9 @@
</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>Represents one of the lines resulting from laying out a paragraph via <see cref="T:Pango.Layout" />.</summary>
<remarks>
<see cref="T:Pango.LayoutLine" />s are obtained by calling Pango.Layout.GetLine() and are only valid until the text, attributes, or settings of the parent <see cref="T:Pango.Layout" /> are modified.</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>