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

Minor docs and fixes. Got half of the properties of Widget.

Browse source 
svn path=/trunk/gtk-sharp/; revision=13516
This commit is contained in:
Hector E. Gomez Morales 2003-04-11 11:44:38 +00:00
parent 1840bd7ef1
commit 1b1c171b21
6 changed files with 202 additions and 116 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/ChangeLog
View file

@ -1,3 +1,12 @@
2003-04-11 Hector E. Gomez Morales <hgomez_36@flashmail.com>
* en/Gtk/GammeCurve.xml
* en/Gtk/MenuBar.xml
* en/Gtk/MenuItem.xml
* en/Gtk/Widget.xml
* en/Gtk/WidgetFlags.xml: Got half of the properties of Widget only
left the boolean ones. Minor docs and typos.
2003-04-04 Duncan Mak <duncan@ximian.com> 2003-04-04 Duncan Mak <duncan@ximian.com>
* en/Gtk/Label.xml: Add first draft of Label docs. * en/Gtk/Label.xml: Add first draft of Label docs.

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

@ -1,5 +1,5 @@
<Type Name="GammaCurve" FullName="Gtk.GammaCurve"> <Type Name="GammaCurve" FullName="Gtk.GammaCurve">
<TypeSignature Language="C#" Value="public class GammaCurve : Gtk.VBox, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Hector Gmoez M" /> <TypeSignature Language="C#" Value="public class GammaCurve : Gtk.VBox, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Hector Gomez M" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>

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

@ -1,5 +1,5 @@
<Type Name="MenuBar" FullName="Gtk.MenuBar"> <Type Name="MenuBar" FullName="Gtk.MenuBar">
<TypeSignature Language="C#" Value="public class MenuBar : Gtk.MenuShell, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" /> <TypeSignature Language="C#" Value="public class MenuBar : Gtk.MenuShell, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Hector Gomez M" />
<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,12 @@
</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>The MenuBar is a subclass of MenuShell which contains one to many MenuItem.</summary>
<remarks>To be added</remarks> <remarks>
<para>
The result is a standard menu bar which can hold many menu items. <see cref="T:Gtk.MenuBar" /> allows for a shadow type to be set for aesthetic purposes.
</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.MenuShell</BaseTypeName> <BaseTypeName>Gtk.MenuShell</BaseTypeName>
@ -63,9 +67,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>A constructor.</summary>
<returns>To be added: an object of type 'Gtk.MenuBar'</returns> <returns>An instance of <see cref="T:Gtk.MenuBar" />.</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">

82
doc/en/Gtk/MenuItem.xml
View file

@ -1,5 +1,5 @@
<Type Name="MenuItem" FullName="Gtk.MenuItem"> <Type Name="MenuItem" FullName="Gtk.MenuItem">
<TypeSignature Language="C#" Value="public class MenuItem : Gtk.Item, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" /> <TypeSignature Language="C#" Value="public class MenuItem : Gtk.Item, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Hector Gomez M" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,9 +7,9 @@
</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>A widget used for items in menus</summary> <summary>A widget used for items in menus.</summary>
<remarks> <remarks>
<para>The MenuItem and derived widgets are the only valid children for menus. Their function is to correctly handle highlighting, alignment, events and submenus.</para> <para>The <see cref="T:Gtk.MenuItem" /> and derived widgets are the only valid children for menus. Their function is to correctly handle highlighting, alignment, events and submenus.</para>
</remarks> </remarks>
</Docs> </Docs>
<Base> <Base>
@ -41,9 +41,9 @@
<Parameter Name="label" Type="System.String" /> <Parameter Name="label" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Creates a new MenuItem with a <see cref="T:Gtk.Label" />.</summary> <summary>Creates a new <see cref="T:Gtk.MenuItem" /> whose child is <see cref="T:Gtk.Label" />.</summary>
<param name="label">The text to appear on this menu item.</param> <param name="label">The text to appear on this menu item.</param>
<returns>A new MenuItem</returns> <returns>A new <see cref="T:Gtk.MenuItem" />.</returns>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -55,7 +55,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Removes the MenuItem's submenu, if it has one.</summary> <summary>Removes the <see cref="T:Gtk.MenuItem" />'s submenu, if it has one.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -93,9 +93,9 @@
<Parameter Name="allocation" Type="System.Int32" /> <Parameter Name="allocation" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Emits the <see cref="F:Gtk.MenuItem.ToggleSizeAllocated" /> event on the given item.</summary>
<param name="allocation">To be added: an object of type 'int'</param> <param name="allocation">The allocation to use as signal data.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ToggleSizeRequest"> <Member MemberName="ToggleSizeRequest">
@ -108,9 +108,9 @@
<Parameter Name="requisition" Type="System.Int32" /> <Parameter Name="requisition" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Emits the <see cref="F:Gtk.MenuItem.ToggleSizeRequested" /> event on the given item.</summary>
<param name="requisition">To be added: an object of type 'int'</param> <param name="requisition">The requisition to use as signal data.</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Activate"> <Member MemberName="Activate">
@ -121,8 +121,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Emits the <see cref="F:Gtk.MenuItem.Activated" /> event on the given item.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
@ -159,9 +159,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>A constructor.</summary>
<returns>To be added: an object of type 'Gtk.MenuItem'</returns> <returns>An instance of <see cref="T:Gtk.MenuItem" />.</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -200,26 +200,31 @@
<Parameter Name="value" Type="Gtk.Widget" /> <Parameter Name="value" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets or obtains the widget submenu.</summary>
<param name="value">To be added: an object of type 'Gtk.Widget'</param> <param name="value">The submenu.</param>
<returns>To be added: an object of type 'Gtk.Widget'</returns> <returns>A submenu for this menu item, or <see cref="langword:null" /> if none.</returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AccelPath"> <Member MemberName="AccelPath">
<MemberSignature Language="C#" Value="public string AccelPath { set; };" /> <MemberSignature Language="C#" Value="public string AccelPath { set; };" />
<MemberType>Property</MemberType> <MemberType>Property</MemberType>
<ReturnValue> <ReturnValue>
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters>
<Parameter Name="value" Type="System.String" /> <Parameter Name="value" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the accelerator path.</summary>
<param name="value">To be added: an object of type 'string'</param> <param name="value">An accelerator path, corresponding to this menu item's functionality, or <see cref="langword:null" /> to unset the current path.</param>
<returns>To be added: an object of type 'string'</returns> <returns>The accelerator path of the menu item.</returns>
<remarks>To be added</remarks> <remarks>
<para>
Sets the accelerator path, through which runtime changes of the menu item's accelerator caused by the user can be identified and saved to persistant storage.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RightJustified"> <Member MemberName="RightJustified">
@ -228,14 +233,15 @@
<ReturnValue> <ReturnValue>
<ReturnType>System.Boolean</ReturnType> <ReturnType>System.Boolean</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters> <Parameters> <summary></summary>
<remarks />
<Parameter Name="value" Type="System.Boolean" /> <Parameter Name="value" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets or obtains whether the menu item appears justified at the right side of a menu bar.</summary>
<param name="value">To be added: an object of type 'bool'</param> <param name="value">If <see cref="langword:true" /> the menu item will appear at the far right if added to a menu bar.</param>
<returns>To be added: an object of type 'bool'</returns> <returns>Returns <see cref="langword:true" /> if the menu item will appear at the far right if added to a menu bar.</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Activated"> <Member MemberName="Activated">
@ -244,8 +250,8 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Emitted when the item is activated.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ActivateItem"> <Member MemberName="ActivateItem">
@ -254,8 +260,8 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Emitted when the item is activated, but also if the menu item has a submenu. For normal applications, the relevant event is <see cref="F:Gtk.MenuItem.Activated" />.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ToggleSizeAllocated"> <Member MemberName="ToggleSizeAllocated">
@ -264,8 +270,8 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Emitted when size is allocated.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ToggleSizeRequested"> <Member MemberName="ToggleSizeRequested">
@ -274,8 +280,8 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Emitted when size is requested.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">

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

@ -1346,7 +1346,7 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>A coonstructor.</summary> <summary>A constructor.</summary>
<returns>An instance of <see cref="T:Gtk.Widget" />.</returns> <returns>An instance of <see cref="T:Gtk.Widget" />.</returns>
<remarks /> <remarks />
</Docs> </Docs>
@ -1358,9 +1358,13 @@
<ReturnType>Gdk.Visual</ReturnType> <ReturnType>Gdk.Visual</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the visual of the default colormap.</summary>
<returns>To be added: an object of type 'Gdk.Visual'</returns> <returns>Returns a visual of the default colormap.</returns>
<remarks>To be added</remarks> <remarks>
<para>
Not really useful; used to be useful before <see cref="M:Gdk.Colormap.GetVisual" /> existed.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DefaultStyle"> <Member MemberName="DefaultStyle">
@ -1370,9 +1374,13 @@
<ReturnType>Gtk.Style</ReturnType> <ReturnType>Gtk.Style</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the default style used by all widgets initially.</summary>
<returns>To be added: an object of type 'Gtk.Style'</returns> <returns>Returns the default style. This <see cref="T:Gtk.Style" /> object is owned by GTK+ and should not be modified or freed.</returns>
<remarks>To be added</remarks> <remarks>
<para>
Returns the default style used by all widgets initially.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DefaultColormap"> <Member MemberName="DefaultColormap">
@ -1385,10 +1393,14 @@
<Parameter Name="value" Type="Gdk.Colormap" /> <Parameter Name="value" Type="Gdk.Colormap" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets or obtains the default colormap to use when creating widgets.</summary>
<param name="value">To be added: an object of type 'Gdk.Colormap'</param> <param name="value">A colormap (see <see cref="T:Gdk.Colormap" />).</param>
<returns>To be added: an object of type 'Gdk.Colormap'</returns> <returns>A <see cref="T:Gdk.Colormap" />.</returns>
<remarks>To be added</remarks> <remarks>
<para>
<see cref="M:Gtk.Widget.PushColormap" /> is a better function to use if you only want to affect a few widgets, rather than all widgets.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DefaultDirection"> <Member MemberName="DefaultDirection">
@ -1401,10 +1413,14 @@
<Parameter Name="value" Type="Gtk.TextDirection" /> <Parameter Name="value" Type="Gtk.TextDirection" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets or obtains the default reading direction for widgets.</summary>
<param name="value">To be added: an object of type 'Gtk.TextDirection'</param> <param name="value">A <see cref="P:Gtk.Widget.TextDirection" />.</param>
<returns>To be added: an object of type 'Gtk.TextDirection'</returns> <returns>A <see cref="P:Gtk.Widget.TextDirection" />.</returns>
<remarks>To be added</remarks> <remarks>
<para>
Where the direction has not been explicitly set by <see cref="P:Gtk.Widget.Direction" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -1450,9 +1466,9 @@
<ReturnType>Atk.Object</ReturnType> <ReturnType>Atk.Object</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the default reading direction for widgets.</summary>
<returns>To be added: an object of type 'Atk.Object'</returns> <returns>A <see cref="T:Atk.Object" />.</returns>
<remarks>To be added</remarks> <remarks>Obtains the default reading direction for widgets.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Direction"> <Member MemberName="Direction">
@ -1465,10 +1481,14 @@
<Parameter Name="value" Type="Gtk.TextDirection" /> <Parameter Name="value" Type="Gtk.TextDirection" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets or obtains the reading direction on a particular <paramref name="widget" />.</summary>
<param name="value">To be added: an object of type 'Gtk.TextDirection'</param> <param name="value">A <see cref="T:Gtk.TextDirection" />.</param>
<returns>To be added: an object of type 'Gtk.TextDirection'</returns> <returns>The reading direction for the widget.</returns>
<remarks>To be added</remarks> <remarks>
<para>
This direction controls the primary direction for widgets containing text, and also the direction in which the children of a container are packed. The ability to set the direction is present in order so that correct localization into languages with right-to-left reading directions can be done. Generally, applications will let the default reading direction present, except for containers where the containers are arranged in an order that is explicitely visual rather than logical (such as buttons for text justification). If the direction is set none, then the value set by <see cref="P:Gtk.Widget.DefaultDirection" /> will be used.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Colormap"> <Member MemberName="Colormap">
@ -1481,10 +1501,14 @@
<Parameter Name="value" Type="Gdk.Colormap" /> <Parameter Name="value" Type="Gdk.Colormap" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets or obtains the colormap that will be used to render <paramref name="widget" />.</summary>
<param name="value">To be added: an object of type 'Gdk.Colormap'</param> <param name="value">A colormap (see <see cref="T:Gdk.Colormap" />).</param>
<returns>To be added: an object of type 'Gdk.Colormap'</returns> <returns>A <see cref="T:Gdk.Colormap" />.</returns>
<remarks>To be added</remarks> <remarks>
<para>
Widget must not have been previously realized.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ChildVisible"> <Member MemberName="ChildVisible">
@ -1497,10 +1521,17 @@
<Parameter Name="value" Type="System.Boolean" /> <Parameter Name="value" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets or obtains whether <paramref name="widget" /> should be mapped along with its when its parent is mapped and <paramref name="widget" /> has been shown with <see cref="M:Gtk.Widget.Show" />.</summary>
<param name="value">To be added: an object of type 'bool'</param> <param name="value">If <see cref="langword:true" />, <paramref name="widget" /> should be mapped along with its parent.</param>
<returns>To be added: an object of type 'bool'</returns> <returns>Returns <see cref="langword:true" /> if the widget is mapped with the parent.</returns>
<remarks>To be added</remarks> <remarks>
<para>
The child visibility can be set for widget before it is added to a container with <see cref="P:Gtk.Widget.Parent" />, to avoid mapping children unnecessary before immediately unmapping them. However it will be reset to its default state of <see cref="langword:true" /> when the widget is removed from a container.
</para>
<para>
Note that changing the child visibility of a widget does not queue a resize on the widget. Most of the time, the size of a widget is computed from all visible children, whether or not they are mapped. If this is not the case, the container can queue a resize itself. This function is only useful for container implementations and never should be called by an application.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CompositeName"> <Member MemberName="CompositeName">
@ -1513,10 +1544,14 @@
<Parameter Name="value" Type="System.String" /> <Parameter Name="value" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets or obtains a <paramref name="widget" /> composite name.</summary>
<param name="value">To be added: an object of type 'string'</param> <param name="value">The name to set.</param>
<returns>To be added: an object of type 'string'</returns> <returns>The composite name of <paramref name="widget" />, or <see cref="langword:null" /> if <paramref name="widget" /> is not a composite child. The string should not be freed when it is no longer needed.</returns>
<remarks>To be added</remarks> <remarks>
<para>
The widget must be a composite child of its parent; see <see cref="M:Gtk.Widget.PushCompositeChild" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Toplevel"> <Member MemberName="Toplevel">
@ -1526,9 +1561,13 @@
<ReturnType>Gtk.Widget</ReturnType> <ReturnType>Gtk.Widget</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the topmost widget in the container hierarchy <paramref name="widget" /> is a part of.</summary>
<returns>To be added: an object of type 'Gtk.Widget'</returns> <returns>The topmost ancestor of <paramref name="widget" />, or <paramref name="widget" /> itself if there's no ancestor.</returns>
<remarks>To be added</remarks> <remarks>
<para>
Note the difference in behavior against <see cref="P:Gtk.Widget.GetAncestor" />, would return <see cref="langword:null" /> if <paramref name="widget" /> wasn't inside a toplevel window, and if the window was inside a GtkWindow-derived widget which was in turn inside the toplevel <see cref="T:Gtk.Window" />. While the second case may seem unlikely, it actually happens when a <see cref="T:Gtk.Plug" /> is embedded inside a <see cref="T:Gtk.Socket" /> within the same application. To reliably find the toplevel <see cref="T:Gtk.Window" />, use <see cref="P:Gtk.Widget.TopLevel" /> and check if the <see cref="F:Gtk.WidgetFlags.TopLevel" /> flag is set on the result.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RedrawOnAllocate"> <Member MemberName="RedrawOnAllocate">
@ -1542,8 +1581,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Sets whether a <paramref name="widget" /> size allocation changes, the entire <paramref name="widget" /> is queued for drawing.</summary> <summary>Sets whether a <paramref name="widget" /> size allocation changes, the entire <paramref name="widget" /> is queued for drawing.</summary>
<param name="value"> <param name="value"><see cref="langword:true" /> the entire widget will be redrawn when it is allocated to a new size. <see cref="langword:false" /> only the new portion of the widget will be redrawn.</param>
<see cref="langword:true" /> the entire widget will be redrawn when it is allocated to a new size. <see cref="langword:false" /> only the new portion of the widget will be redrawn.</param>
<returns>Returns <see cref="langword:true" /> because it is on by Default, but returns <see cref="langword:false" /> if you turn it off.</returns> <returns>Returns <see cref="langword:true" /> because it is on by Default, but returns <see cref="langword:false" /> if you turn it off.</returns>
<remarks> <remarks>
<para> <para>
@ -1566,8 +1604,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Use this function to turn off the double buffering.</summary> <summary>Use this function to turn off the double buffering.</summary>
<param name="value"> <param name="value"><see cref="langword:true" /> is on by Default, <see cref="langword:false" /> if you want to turn off double buffering no use call for true because it is default.</param>
<see cref="langword:true" /> is on by Default, <see cref="langword:false" /> if you want to turn off double buffering no use call for true because it is default</param>
<returns>Returns <see cref="langword:true" /> because double buffering is on by Default, but returns <see cref="langword:false" /> if you turn it off.</returns> <returns>Returns <see cref="langword:true" /> because double buffering is on by Default, but returns <see cref="langword:false" /> if you turn it off.</returns>
<remarks> <remarks>
<para> <para>
@ -1586,9 +1623,13 @@
<ReturnType>Gtk.Settings</ReturnType> <ReturnType>Gtk.Settings</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the settings object holding the settings (global property settings, RC file information, etc) used for this <paramref name="widget" />.</summary>
<returns>To be added: an object of type 'Gtk.Settings'</returns> <returns>The relevant <see cref="T:Gtk.Settings" /> object.</returns>
<remarks>To be added</remarks> <remarks>
<para>
Note that this function can only be called when the <see cref="T:Gtk.Widget" /> is attached to a toplevel, since the settings object is specific to a particular <see cref="T:Gdk.Screen" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ParentWindow"> <Member MemberName="ParentWindow">
@ -1601,10 +1642,14 @@
<Parameter Name="value" Type="Gdk.Window" /> <Parameter Name="value" Type="Gdk.Window" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets or obtains <paramref name="widget" />'s parent window.</summary>
<param name="value">To be added: an object of type 'Gdk.Window'</param> <param name="value">The new parent window.</param>
<returns>To be added: an object of type 'Gdk.Window'</returns> <returns>The parent window of <paramref name="widget" />.</returns>
<remarks>To be added</remarks> <remarks>
<para>
Sets or obtains <paramref name="widget" />'s parent window.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PangoContext"> <Member MemberName="PangoContext">
@ -1614,9 +1659,16 @@
<ReturnType>Pango.Context</ReturnType> <ReturnType>Pango.Context</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains a <see cref="T:Pango.Context" /> with the appropriate colormap, font description and base direction for <paramref name="widget" />.</summary>
<returns>To be added: an object of type 'Pango.Context'</returns> <returns></returns>
<remarks>To be added</remarks> <remarks>
<para>
Unlike the context returned by <see cref="M:Gtk.Widget.CreatePangoContext" />, this context is owned by the <paramref name="widget" /> (it can be used until the screen for the widget changes or the widget is removed from its toplevel), and will be updated to match any changes to the <paramref name="widget" />'s attributes.
</para>
<para>
If you create and keep a <see cref="T:Pango.Layout" /> using this context, you must deal with changes to the context by calling <see cref="T:Pango.Layout.ContextChanged" /> on the layout in response to the <see cref="F:Gtk.Widget.StyleSet" /> and <see cref="F:Gtk.Widget.DirectionChanged" /> signals for the <paramref name="widget" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="State"> <Member MemberName="State">
@ -1629,10 +1681,14 @@
<Parameter Name="value" Type="Gtk.StateType" /> <Parameter Name="value" Type="Gtk.StateType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the state of a <paramref name="widget" /> (insensitive, prelighted, etc.).</summary>
<param name="value">To be added: an object of type 'Gtk.StateType'</param> <param name="value">New state for <paramref name="widget" />.</param>
<returns>To be added: an object of type 'Gtk.StateType'</returns> <returns>The <see cref="T:Gtk.StateType" /> of the <paramref name="widget" />.</returns>
<remarks>To be added</remarks> <remarks>
<para>
Usually you should set the state using wrapper functions such as <see cref="P:Gtk.Widget.Sensitive" />. This function is for use in widget implementations.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Visual"> <Member MemberName="Visual">
@ -1642,9 +1698,13 @@
<ReturnType>Gdk.Visual</ReturnType> <ReturnType>Gdk.Visual</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the visual that will be used to render <paramref name="widget" />.</summary>
<returns>To be added: an object of type 'Gdk.Visual'</returns> <returns>The visual for <paramref name="widget" />.</returns>
<remarks>To be added</remarks> <remarks>
<para>
Obtains the visual that will be used to render <paramref name="widget" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ModifierStyle"> <Member MemberName="ModifierStyle">
@ -1654,9 +1714,16 @@
<ReturnType>Gtk.RcStyle</ReturnType> <ReturnType>Gtk.RcStyle</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obtains the current modifier style for the widget.(As set by <see cref="M:Gtk.Widget.ModifyStyle" />)</summary>
<returns>To be added: an object of type 'Gtk.RcStyle'</returns> <returns>The modifier style for the widget. This rc style is owned by the widget.</returns>
<remarks>To be added</remarks> <remarks>
<para>
If no style has previously set, a new <see cref="T:Gtk.RcStyle" /> will be created with all values unset, and set as the modifier style for the widget. If you make changes to this rc style, you must call <see cref="M:Gtk.Widget.ModifyStyle" />, passing in the returned rc style, to make sure that your changes take effect.
</para>
<para>
Caution: passing the style back to <see cref="M:Gtk.Widget.ModifyStyle" /> will normally end up destroying it, because <see cref="M:Gtk.Widget.ModifyStyle" /> copies the passed-in style and sets the copy as the new modifier style, thus dropping any reference to the old modifier style. Add a reference to the modifier style if you want to keep it alive.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Visible"> <Member MemberName="Visible">

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

@ -1,5 +1,5 @@
<Type Name="WidgetFlags" FullName="Gtk.WidgetFlags"> <Type Name="WidgetFlags" FullName="Gtk.WidgetFlags">
<TypeSignature Language="C#" Value="public sealed struct WidgetFlags;" Maintainer="hector Gomez M" /> <TypeSignature Language="C#" Value="public sealed struct WidgetFlags;" Maintainer="Hector Gomez M" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>