mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-09-08 07:53:17 +02:00
Minor docs and fixes. Got half of the properties of Widget.
svn path=/trunk/gtk-sharp/; revision=13516
This commit is contained in:
Hector E. Gomez Morales
parent
1840bd7ef1
commit
1b1c171b21
@ -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>
|
||||
|
||||
* en/Gtk/Label.xml: Add first draft of Label docs.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<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>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
@ -104,4 +104,4 @@
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
</Type>
|
||||
</Type>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<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>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
@ -7,8 +7,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>The MenuBar is a subclass of MenuShell which contains one to many MenuItem.</summary>
|
||||
<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>
|
||||
<Base>
|
||||
<BaseTypeName>Gtk.MenuShell</BaseTypeName>
|
||||
@ -63,9 +67,9 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.MenuBar'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>A constructor.</summary>
|
||||
<returns>An instance of <see cref="T:Gtk.MenuBar" />.</returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GType">
|
||||
@ -97,4 +101,4 @@
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
</Type>
|
||||
</Type>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<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>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
@ -7,9 +7,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>A widget used for items in menus</summary>
|
||||
<summary>A widget used for items in menus.</summary>
|
||||
<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>
|
||||
</Docs>
|
||||
<Base>
|
||||
@ -41,9 +41,9 @@
|
||||
<Parameter Name="label" Type="System.String" />
|
||||
</Parameters>
|
||||
<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>
|
||||
<returns>A new MenuItem</returns>
|
||||
<returns>A new <see cref="T:Gtk.MenuItem" />.</returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
@ -55,7 +55,7 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<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 />
|
||||
</Docs>
|
||||
</Member>
|
||||
@ -93,9 +93,9 @@
|
||||
<Parameter Name="allocation" Type="System.Int32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="allocation">To be added: an object of type 'int'</param>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Emits the <see cref="F:Gtk.MenuItem.ToggleSizeAllocated" /> event on the given item.</summary>
|
||||
<param name="allocation">The allocation to use as signal data.</param>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ToggleSizeRequest">
|
||||
@ -108,9 +108,9 @@
|
||||
<Parameter Name="requisition" Type="System.Int32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="requisition">To be added: an object of type 'int'</param>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Emits the <see cref="F:Gtk.MenuItem.ToggleSizeRequested" /> event on the given item.</summary>
|
||||
<param name="requisition">The requisition to use as signal data.</param>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Activate">
|
||||
@ -121,8 +121,8 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Emits the <see cref="F:Gtk.MenuItem.Activated" /> event on the given item.</summary>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Finalize">
|
||||
@ -159,9 +159,9 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.MenuItem'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>A constructor.</summary>
|
||||
<returns>An instance of <see cref="T:Gtk.MenuItem" />.</returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
@ -200,26 +200,31 @@
|
||||
<Parameter Name="value" Type="Gtk.Widget" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'Gtk.Widget'</param>
|
||||
<returns>To be added: an object of type 'Gtk.Widget'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Sets or obtains the widget submenu.</summary>
|
||||
<param name="value">The submenu.</param>
|
||||
<returns>A submenu for this menu item, or <see cref="langword:null" /> if none.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="AccelPath">
|
||||
<MemberSignature Language="C#" Value="public string AccelPath { set; };" />
|
||||
<MemberType>Property</MemberType>
|
||||
<ReturnValue>
|
||||
|
||||
<ReturnType>System.String</ReturnType>
|
||||
</ReturnValue>
|
||||
<Parameters>
|
||||
<Parameter Name="value" Type="System.String" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'string'</param>
|
||||
<returns>To be added: an object of type 'string'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Sets the accelerator path.</summary>
|
||||
<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>The accelerator path of the menu item.</returns>
|
||||
<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>
|
||||
</Member>
|
||||
<Member MemberName="RightJustified">
|
||||
@ -228,14 +233,15 @@
|
||||
<ReturnValue>
|
||||
<ReturnType>System.Boolean</ReturnType>
|
||||
</ReturnValue>
|
||||
<Parameters>
|
||||
<Parameters> <summary></summary>
|
||||
<remarks />
|
||||
<Parameter Name="value" Type="System.Boolean" />
|
||||
</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>Sets or obtains whether the menu item appears justified at the right side of a menu bar.</summary>
|
||||
<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>Returns <see cref="langword:true" /> if the menu item will appear at the far right if added to a menu bar.</returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Activated">
|
||||
@ -244,8 +250,8 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Emitted when the item is activated.</summary>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ActivateItem">
|
||||
@ -254,8 +260,8 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<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 />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ToggleSizeAllocated">
|
||||
@ -264,8 +270,8 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Emitted when size is allocated.</summary>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ToggleSizeRequested">
|
||||
@ -274,8 +280,8 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Emitted when size is requested.</summary>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
@ -295,4 +301,4 @@
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
</Type>
|
||||
</Type>
|
||||
|
||||
@ -1346,7 +1346,7 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>A coonstructor.</summary>
|
||||
<summary>A constructor.</summary>
|
||||
<returns>An instance of <see cref="T:Gtk.Widget" />.</returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
@ -1358,9 +1358,13 @@
|
||||
<ReturnType>Gdk.Visual</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gdk.Visual'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Obtains the visual of the default colormap.</summary>
|
||||
<returns>Returns a visual of the default colormap.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
Not really useful; used to be useful before <see cref="M:Gdk.Colormap.GetVisual" /> existed.
|
||||
</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="DefaultStyle">
|
||||
@ -1370,9 +1374,13 @@
|
||||
<ReturnType>Gtk.Style</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Style'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Obtains the default style used by all widgets initially.</summary>
|
||||
<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>
|
||||
<para>
|
||||
Returns the default style used by all widgets initially.
|
||||
</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="DefaultColormap">
|
||||
@ -1385,10 +1393,14 @@
|
||||
<Parameter Name="value" Type="Gdk.Colormap" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'Gdk.Colormap'</param>
|
||||
<returns>To be added: an object of type 'Gdk.Colormap'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Sets or obtains the default colormap to use when creating widgets.</summary>
|
||||
<param name="value">A colormap (see <see cref="T:Gdk.Colormap" />).</param>
|
||||
<returns>A <see cref="T:Gdk.Colormap" />.</returns>
|
||||
<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>
|
||||
</Member>
|
||||
<Member MemberName="DefaultDirection">
|
||||
@ -1401,10 +1413,14 @@
|
||||
<Parameter Name="value" Type="Gtk.TextDirection" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'Gtk.TextDirection'</param>
|
||||
<returns>To be added: an object of type 'Gtk.TextDirection'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Sets or obtains the default reading direction for widgets.</summary>
|
||||
<param name="value">A <see cref="P:Gtk.Widget.TextDirection" />.</param>
|
||||
<returns>A <see cref="P:Gtk.Widget.TextDirection" />.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
Where the direction has not been explicitly set by <see cref="P:Gtk.Widget.Direction" />.
|
||||
</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GType">
|
||||
@ -1450,9 +1466,9 @@
|
||||
<ReturnType>Atk.Object</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Atk.Object'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Obtains the default reading direction for widgets.</summary>
|
||||
<returns>A <see cref="T:Atk.Object" />.</returns>
|
||||
<remarks>Obtains the default reading direction for widgets.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Direction">
|
||||
@ -1465,10 +1481,14 @@
|
||||
<Parameter Name="value" Type="Gtk.TextDirection" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'Gtk.TextDirection'</param>
|
||||
<returns>To be added: an object of type 'Gtk.TextDirection'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Sets or obtains the reading direction on a particular <paramref name="widget" />.</summary>
|
||||
<param name="value">A <see cref="T:Gtk.TextDirection" />.</param>
|
||||
<returns>The reading direction for the widget.</returns>
|
||||
<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>
|
||||
</Member>
|
||||
<Member MemberName="Colormap">
|
||||
@ -1481,10 +1501,14 @@
|
||||
<Parameter Name="value" Type="Gdk.Colormap" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'Gdk.Colormap'</param>
|
||||
<returns>To be added: an object of type 'Gdk.Colormap'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Sets or obtains the colormap that will be used to render <paramref name="widget" />.</summary>
|
||||
<param name="value">A colormap (see <see cref="T:Gdk.Colormap" />).</param>
|
||||
<returns>A <see cref="T:Gdk.Colormap" />.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
Widget must not have been previously realized.
|
||||
</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ChildVisible">
|
||||
@ -1497,10 +1521,17 @@
|
||||
<Parameter Name="value" Type="System.Boolean" />
|
||||
</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>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">If <see cref="langword:true" />, <paramref name="widget" /> should be mapped along with its parent.</param>
|
||||
<returns>Returns <see cref="langword:true" /> if the widget is mapped with the parent.</returns>
|
||||
<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>
|
||||
</Member>
|
||||
<Member MemberName="CompositeName">
|
||||
@ -1513,10 +1544,14 @@
|
||||
<Parameter Name="value" Type="System.String" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'string'</param>
|
||||
<returns>To be added: an object of type 'string'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Sets or obtains a <paramref name="widget" /> composite name.</summary>
|
||||
<param name="value">The name to set.</param>
|
||||
<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>
|
||||
<para>
|
||||
The widget must be a composite child of its parent; see <see cref="M:Gtk.Widget.PushCompositeChild" />.
|
||||
</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Toplevel">
|
||||
@ -1526,9 +1561,13 @@
|
||||
<ReturnType>Gtk.Widget</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Widget'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Obtains the topmost widget in the container hierarchy <paramref name="widget" /> is a part of.</summary>
|
||||
<returns>The topmost ancestor of <paramref name="widget" />, or <paramref name="widget" /> itself if there's no ancestor.</returns>
|
||||
<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>
|
||||
</Member>
|
||||
<Member MemberName="RedrawOnAllocate">
|
||||
@ -1542,15 +1581,14 @@
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>Sets whether a <paramref name="widget" /> size allocation changes, the entire <paramref name="widget" /> is queued for drawing.</summary>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<para>
|
||||
By default, this setting is <see cref="langword:true" /> and the entire <paramref name="widget" /> is redrawn on every size change. If your widget leaves the upper left are unchanged when made bigger, turning this setting on will improve performance.
|
||||
By default, this setting is <see cref="langword:true" /> and the entire <paramref name="widget" /> is redrawn on every size change. If your widget leaves the upper left are unchanged when made bigger, turning this setting on will improve performance.
|
||||
</para>
|
||||
<para>
|
||||
Note that for <see cref="F:Gtk.WidgetFlags.NoWindow" /> widgets setting this flag to <see cref="langword:false" /> turns off all allocation on resizing: the widget will not even redraw if its position changes; this is to allow containers that don't draw anything to avoid excess invalidations. If you set this flag on a <see cref="F:Gtk.WidgetFlags.NoWindow" /> widget that does draw on <paramref name="widget" />->window, you are responsible for invalidating both the old and new allocation of the <paramref name="widget" /> when the widget is moved and responsible for invalidating regions newly when the <paramref name="widget" /> increases size.
|
||||
Note that for <see cref="F:Gtk.WidgetFlags.NoWindow" /> widgets setting this flag to <see cref="langword:false" /> turns off all allocation on resizing: the widget will not even redraw if its position changes; this is to allow containers that don't draw anything to avoid excess invalidations. If you set this flag on a <see cref="F:Gtk.WidgetFlags.NoWindow" /> widget that does draw on <paramref name="widget" />->window, you are responsible for invalidating both the old and new allocation of the <paramref name="widget" /> when the widget is moved and responsible for invalidating regions newly when the <paramref name="widget" /> increases size.
|
||||
</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
@ -1566,15 +1604,14 @@
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>Use this function to turn off the double buffering.</summary>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<para>
|
||||
Widgets are double buffered by default, you can use this function to turn off the buffering. "Double buffered" simply means that <see cref="M:Gdk.Window.BeginPaintRegion" /> and <see cref="M:Gdk.Window.EndPaint" /> are called automatically around <see cref="F:Gtk.Widget.ExposeEvent" /> events sent to the widget. <see cref="M:Gdk.Window.BeginPaint" /> diverts all drawing to a <paramref name="widget" />'s window to an offscreen buffer, and <see cref="M:Gdk.Window.EndPaint" /> draws the buffer to the screen. The result is that users see the window update in one smooth step, and don't see individual graphics primitives being rendered.
|
||||
Widgets are double buffered by default, you can use this function to turn off the buffering. "Double buffered" simply means that <see cref="M:Gdk.Window.BeginPaintRegion" /> and <see cref="M:Gdk.Window.EndPaint" /> are called automatically around <see cref="F:Gtk.Widget.ExposeEvent" /> events sent to the widget. <see cref="M:Gdk.Window.BeginPaint" /> diverts all drawing to a <paramref name="widget" />'s window to an offscreen buffer, and <see cref="M:Gdk.Window.EndPaint" /> draws the buffer to the screen. The result is that users see the window update in one smooth step, and don't see individual graphics primitives being rendered.
|
||||
</para>
|
||||
<para>
|
||||
In very simple terms, double buffered widgets don't flicker, so you would only use this function to turn off double buffering if you had special needs and really knew what you were doing.
|
||||
In very simple terms, double buffered widgets don't flicker, so you would only use this function to turn off double buffering if you had special needs and really knew what you were doing.
|
||||
</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
@ -1586,9 +1623,13 @@
|
||||
<ReturnType>Gtk.Settings</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Settings'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Obtains the settings object holding the settings (global property settings, RC file information, etc) used for this <paramref name="widget" />.</summary>
|
||||
<returns>The relevant <see cref="T:Gtk.Settings" /> object.</returns>
|
||||
<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>
|
||||
</Member>
|
||||
<Member MemberName="ParentWindow">
|
||||
@ -1601,10 +1642,14 @@
|
||||
<Parameter Name="value" Type="Gdk.Window" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'Gdk.Window'</param>
|
||||
<returns>To be added: an object of type 'Gdk.Window'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Sets or obtains <paramref name="widget" />'s parent window.</summary>
|
||||
<param name="value">The new parent window.</param>
|
||||
<returns>The parent window of <paramref name="widget" />.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
Sets or obtains <paramref name="widget" />'s parent window.
|
||||
</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="PangoContext">
|
||||
@ -1614,9 +1659,16 @@
|
||||
<ReturnType>Pango.Context</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Pango.Context'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Obtains a <see cref="T:Pango.Context" /> with the appropriate colormap, font description and base direction for <paramref name="widget" />.</summary>
|
||||
<returns></returns>
|
||||
<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>
|
||||
</Member>
|
||||
<Member MemberName="State">
|
||||
@ -1629,10 +1681,14 @@
|
||||
<Parameter Name="value" Type="Gtk.StateType" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'Gtk.StateType'</param>
|
||||
<returns>To be added: an object of type 'Gtk.StateType'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Sets the state of a <paramref name="widget" /> (insensitive, prelighted, etc.).</summary>
|
||||
<param name="value">New state for <paramref name="widget" />.</param>
|
||||
<returns>The <see cref="T:Gtk.StateType" /> of the <paramref name="widget" />.</returns>
|
||||
<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>
|
||||
</Member>
|
||||
<Member MemberName="Visual">
|
||||
@ -1642,9 +1698,13 @@
|
||||
<ReturnType>Gdk.Visual</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gdk.Visual'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Obtains the visual that will be used to render <paramref name="widget" />.</summary>
|
||||
<returns>The visual for <paramref name="widget" />.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
Obtains the visual that will be used to render <paramref name="widget" />.
|
||||
</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ModifierStyle">
|
||||
@ -1654,9 +1714,16 @@
|
||||
<ReturnType>Gtk.RcStyle</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.RcStyle'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Obtains the current modifier style for the widget.(As set by <see cref="M:Gtk.Widget.ModifyStyle" />)</summary>
|
||||
<returns>The modifier style for the widget. This rc style is owned by the widget.</returns>
|
||||
<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>
|
||||
</Member>
|
||||
<Member MemberName="Visible">
|
||||
@ -2514,4 +2581,4 @@
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
</Type>
|
||||
</Type>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<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>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
@ -323,4 +323,4 @@
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
</Type>
|
||||
</Type>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user