mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-09-08 07:53:17 +02:00
2003-07-17 John Luke <jluke@cfl.rr.com>
* en/Gtk/CellRenderer.xml: documented svn path=/trunk/gtk-sharp/; revision=16365
This commit is contained in:
John Luke
parent
df08f5bb95
commit
5ee4beb801
@ -2,6 +2,7 @@
|
||||
|
||||
* en/Gtk/CellRendererMode.xml: documented
|
||||
* en/Gtk/CellRendererState.xml: documented
|
||||
* en/Gtk/CellRenderer.xml: documented
|
||||
|
||||
2003-07-17 Duncan Mak <duncan@ximian.com>
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<Type Name="CellRenderer" FullName="Gtk.CellRenderer">
|
||||
<TypeSignature Language="C#" Value="public class CellRenderer : Gtk.Object, IWrapper, IDisposable" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public class CellRenderer : Gtk.Object, IWrapper, IDisposable" Maintainer="John Luke" />
|
||||
<AssemblyInfo>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
@ -7,8 +7,27 @@
|
||||
</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>An object for rendering a single cell on a <see cref="T:Gdk.Drawable"/></summary>
|
||||
<remarks>
|
||||
<para>
|
||||
The <see cref="T:Gtk.CellRenderer"/> is a base class of a set of objects used for rendering a cell to a <see cref="T:Gdk.Drawable"/>.
|
||||
These objects are used primarily by the <see cref="T:Gtk.TreeView"/> widget, though they are not tied to them in any specific way.
|
||||
It is worth noting that <see cref="T:Gtk.CellRenderer"/> is not a <see cref="T:Gtk.Widget"/> and cannot be treated as such.
|
||||
</para>
|
||||
<para>
|
||||
The primary use of a <see cref="T:Gtk.CellRenderer"/> is for drawing a certain graphical elements on a <see cref="T:Gdk.Drawable"/>.
|
||||
Typically, one <see cref="T:Gtk.CellRenderer"/> is used to draw many cells on the screen.
|
||||
To this extent, it is not expected that a <see cref="T:Gtk.CellRenderer"/> keep any permanent state around.
|
||||
Instead, any state is set just prior to use.
|
||||
Then, the cell is measured using <see cref="M:Gtk.CellRendererGetSize(Gtk.Widget,Gdk.Rectangle,System.Int32,System.Int32,System.Int32,System.Int32)"/>.
|
||||
Finally, the cell is rendered in the correct location using <see cref="M:Gtk.CellRendererRender(Gdk.Window,Gtk.Widget,Gdk.Rectangle,Gdk.Rectangle,Gdk.Rectangle,Gtk.CellRendererState)"/>.
|
||||
</para>
|
||||
<para>
|
||||
There are a number of rules that must be followed when writing a new <see cref="T:Gtk.CellRenderer"/>.
|
||||
First and foremost, it is important that a certain set of properties will always yield a <see cref="T:Gtk.CellRenderer"/> of the same size, barring a <see cref="T:Gtk.Style"/> change.
|
||||
The <see cref="T:Gtk.CellRenderer"/> also has a number of generic properties that are expected to be honored by all children.
|
||||
</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>Gtk.Object</BaseTypeName>
|
||||
@ -38,14 +57,19 @@
|
||||
<Parameter Name="flags" Type="Gtk.CellRendererState" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="window">To be added: an object of type 'Gdk.Window'</param>
|
||||
<param name="widget">To be added: an object of type 'Gtk.Widget'</param>
|
||||
<param name="background_area">To be added: an object of type 'Gdk.Rectangle'</param>
|
||||
<param name="cell_area">To be added: an object of type 'Gdk.Rectangle'</param>
|
||||
<param name="expose_area">To be added: an object of type 'Gdk.Rectangle'</param>
|
||||
<param name="flags">To be added: an object of type 'Gtk.CellRendererState'</param>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Invokes the virtual render function of the <see cref="T:Gtk.CellRenderer"/>.</summary>
|
||||
<param name="window">an object of type <see cref="T:Gdk.Window"/></param>
|
||||
<param name="widget">an object of type <see cref="T:Gtk.Widget"/></param>
|
||||
<param name="background_area">an object of type <see cref="T:Gdk.Rectangle"/></param>
|
||||
<param name="cell_area">an object of type <see cref="T:Gdk.Rectangle"/></param>
|
||||
<param name="expose_area">an object of type <see cref="T:Gdk.Rectangle"/></param>
|
||||
<param name="flags">an object of type <see cref="T:Gtk.CellRendererState"/></param>
|
||||
<remarks>
|
||||
The three passed-in rectangles are areas of <paramref name="window"/>.
|
||||
Most renderers will draw within <paramref name="cell_area"/>;
|
||||
<paramref name="background_area"/> includes the blank space around the cell, and also the area containing the tree expander; so the <paramref name="background_area"/> rectangles for all cells tile to cover the entire window.
|
||||
<paramref name="expose_area"/> is a clip rectangle.
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GetSize">
|
||||
@ -57,20 +81,24 @@
|
||||
<Parameters>
|
||||
<Parameter Name="widget" Type="Gtk.Widget" />
|
||||
<Parameter Name="cell_area" Type="Gdk.Rectangle" />
|
||||
<Parameter Name="x_offset" Type="System.Int32&" />
|
||||
<Parameter Name="y_offset" Type="System.Int32&" />
|
||||
<Parameter Name="width" Type="System.Int32&" />
|
||||
<Parameter Name="height" Type="System.Int32&" />
|
||||
<Parameter Name="x_offset" Type="System.Int32" RefType="out" />
|
||||
<Parameter Name="y_offset" Type="System.Int32" RefType="out" />
|
||||
<Parameter Name="width" Type="System.Int32" RefType="out" />
|
||||
<Parameter Name="height" Type="System.Int32" RefType="out" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="widget">To be added: an object of type 'Gtk.Widget'</param>
|
||||
<param name="cell_area">To be added: an object of type 'Gdk.Rectangle'</param>
|
||||
<param name="x_offset">To be added: an object of type 'int&'</param>
|
||||
<param name="y_offset">To be added: an object of type 'int&'</param>
|
||||
<param name="width">To be added: an object of type 'int&'</param>
|
||||
<param name="height">To be added: an object of type 'int&'</param>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Obtains the <paramref name="width"/> and <paramref name="height"/> needed to render the cell.</summary>
|
||||
<param name="widget">an object of type <see cref="T:Gtk.Widget"/></param>
|
||||
<param name="cell_area">an object of type <see cref="T:Gdk.Rectangle"/></param>
|
||||
<param name="x_offset">an object of type <see cref="T:System.Int32"/></param>
|
||||
<param name="y_offset">an object of type <see cref="T:System.Int32"/></param>
|
||||
<param name="width">an object of type <see cref="T:System.Int32"/></param>
|
||||
<param name="height">an object of type <see cref="T:System.Int32"/></param>
|
||||
<remarks>
|
||||
Used by view widgets to determine the appropriate size for the <paramref name="cell_area"/> passed to gtk_cell_renderer_render().
|
||||
If <paramref name="cell_area"/> is not <see langword="null"/>, fills in the x and y offsets (if set) of the cell relative to this location.
|
||||
Please note that the values set in <paramref name="width"/> and <paramref name="height"/>, as well as those in <paramref name="x_offset"/> and <paramref name="y_offset"/> are inclusive of the xpad and ypad properties.
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="SetFixedSize">
|
||||
@ -84,9 +112,9 @@
|
||||
<Parameter Name="height" Type="System.Int32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="width">To be added: an object of type 'int'</param>
|
||||
<param name="height">To be added: an object of type 'int'</param>
|
||||
<summary>Sets the renderer size to be explicit, independent of the properties set.</summary>
|
||||
<param name="width">an object of type <see cref="T:System.Int32"/></param>
|
||||
<param name="height">an object of type <see cref="T:System.Int32"/></param>
|
||||
<remarks>To be added</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
@ -97,13 +125,13 @@
|
||||
<ReturnType>System.Void</ReturnType>
|
||||
</ReturnValue>
|
||||
<Parameters>
|
||||
<Parameter Name="width" Type="System.Int32&" />
|
||||
<Parameter Name="height" Type="System.Int32&" />
|
||||
<Parameter Name="width" Type="System.Int32" RefType="out" />
|
||||
<Parameter Name="height" Type="System.Int32" RefType="out" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="width">To be added: an object of type 'int&'</param>
|
||||
<param name="height">To be added: an object of type 'int&'</param>
|
||||
<param name="width">an object of type <see cref="T:System.Int32"/></param>
|
||||
<param name="height">an object of type <see cref="T:System.Int32"/></param>
|
||||
<remarks>To be added</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
@ -122,14 +150,14 @@
|
||||
<Parameter Name="flags" Type="Gtk.CellRendererState" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="evnt">To be added: an object of type 'Gdk.Event'</param>
|
||||
<param name="widget">To be added: an object of type 'Gtk.Widget'</param>
|
||||
<param name="path">To be added: an object of type 'string'</param>
|
||||
<param name="background_area">To be added: an object of type 'Gdk.Rectangle'</param>
|
||||
<param name="cell_area">To be added: an object of type 'Gdk.Rectangle'</param>
|
||||
<param name="flags">To be added: an object of type 'Gtk.CellRendererState'</param>
|
||||
<returns>To be added: an object of type 'Gtk.CellEditable'</returns>
|
||||
<summary>Passes an activate event to the <see cref="T:Gtk.CellRenderer"/> for possible processing.</summary>
|
||||
<param name="evnt">an object of type <see cref="T:Gdk.Event"/></param>
|
||||
<param name="widget">an object of type <see cref="T:Gtk.Widget"/></param>
|
||||
<param name="path">an object of type <see cref="T:System.String"/></param>
|
||||
<param name="background_area">an object of type <see cref="T:Gdk.Rectangle"/></param>
|
||||
<param name="cell_area">an object of type <see cref="T:Gdk.Rectangle"/></param>
|
||||
<param name="flags">an object of type <see cref="T:Gtk.CellRendererState"/></param>
|
||||
<returns>an object of type <see cref="T:Gtk.CellEditable"/></returns>
|
||||
<remarks>To be added</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
@ -148,15 +176,15 @@
|
||||
<Parameter Name="flags" Type="Gtk.CellRendererState" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="evnt">To be added: an object of type 'Gdk.Event'</param>
|
||||
<param name="widget">To be added: an object of type 'Gtk.Widget'</param>
|
||||
<param name="path">To be added: an object of type 'string'</param>
|
||||
<param name="background_area">To be added: an object of type 'Gdk.Rectangle'</param>
|
||||
<param name="cell_area">To be added: an object of type 'Gdk.Rectangle'</param>
|
||||
<param name="flags">To be added: an object of type 'Gtk.CellRendererState'</param>
|
||||
<returns>To be added: an object of type 'bool'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Passes an activate event to the <see cref="T:Gtk.CellRenderer"/> for possible processing.</summary>
|
||||
<param name="evnt">an object of type <see cref="T:Gdk.Event"/></param>
|
||||
<param name="widget">an object of type <see cref="T:Gtk.Widget"/></param>
|
||||
<param name="path">an object of type <see cref="T:System.String"/></param>
|
||||
<param name="background_area">an object of type <see cref="T:Gdk.Rectangle"/></param>
|
||||
<param name="cell_area">an object of type <see cref="T:Gdk.Rectangle"/></param>
|
||||
<param name="flags">an object of type <see cref="T:Gtk.CellRendererState"/></param>
|
||||
<returns>an object of type <see cref="T:System.Boolean"/></returns>
|
||||
<remarks>Some <see cref="T:Gtk.CellRenderer"/>s may use events; for example, <see cref="T:Gtk.CellRendererToggle"/> toggles when it gets a mouse click.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Finalize">
|
||||
@ -193,9 +221,9 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.CellRenderer'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Internal constructor</summary>
|
||||
<returns>an object of type <see cref="T:Gtk.CellRenderer"/></returns>
|
||||
<remarks>This is an internal constructor, and should not be used by user code. Normally this would be called by an inherited class.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GType">
|
||||
@ -205,8 +233,8 @@
|
||||
<ReturnType>System.UInt32</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>The GLib Type for Gtk.CellRenderer</summary>
|
||||
<returns>The GLib Type for the Gtk.CellRenderer class.</returns>
|
||||
<summary>The <see cref="T:GLib.Type"/> for <see cref="T:Gtk.CellRenderer"/></summary>
|
||||
<returns>The <see cref="T:GLib.Type"/> for the <see cref="T:Gtk.CellRenderer"/> class.</returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
@ -220,10 +248,10 @@
|
||||
<Parameter Name="value" Type="System.Int32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</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>
|
||||
<summary>The fixed height.</summary>
|
||||
<param name="value">an object of type <see cref="T:System.Int32"/></param>
|
||||
<returns>an object of type <see cref="T:System.Int32"/></returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Visible">
|
||||
@ -236,10 +264,10 @@
|
||||
<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>Display the cell.</summary>
|
||||
<param name="value">an object of type <see cref="T:System.Boolean"/></param>
|
||||
<returns>an object of type <see cref="T:System.Boolean"/></returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Xalign">
|
||||
@ -252,10 +280,10 @@
|
||||
<Parameter Name="value" Type="System.Single" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'float'</param>
|
||||
<returns>To be added: an object of type 'float'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The x-align.</summary>
|
||||
<param name="value">an object of type <see cref="T:System.Single"/></param>
|
||||
<returns>an object of type <see cref="T:System.Single"/></returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Width">
|
||||
@ -268,10 +296,10 @@
|
||||
<Parameter Name="value" Type="System.Int32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</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>
|
||||
<summary>The fixed width.</summary>
|
||||
<param name="value">an object of type <see cref="T:System.Int32"/></param>
|
||||
<returns>an object of type <see cref="T:System.Int32"/></returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Yalign">
|
||||
@ -284,10 +312,10 @@
|
||||
<Parameter Name="value" Type="System.Single" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'float'</param>
|
||||
<returns>To be added: an object of type 'float'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The y-align.</summary>
|
||||
<param name="value">an object of type <see cref="T:System.Single"/></param>
|
||||
<returns>an object of type <see cref="T:System.Single"/></returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="IsExpander">
|
||||
@ -300,10 +328,10 @@
|
||||
<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>Row has children.</summary>
|
||||
<param name="value">an object of type <see cref="T:System.Boolean"/></param>
|
||||
<returns>an object of type <see cref="T:System.Boolean"/></returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Ypad">
|
||||
@ -316,10 +344,10 @@
|
||||
<Parameter Name="value" Type="System.UInt32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'uint'</param>
|
||||
<returns>To be added: an object of type 'uint'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The ypad.</summary>
|
||||
<param name="value">an object of type <see cref="T:System.UInt32"/></param>
|
||||
<returns>an object of type <see cref="T:System.UInt32"/></returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Xpad">
|
||||
@ -332,10 +360,10 @@
|
||||
<Parameter Name="value" Type="System.UInt32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'uint'</param>
|
||||
<returns>To be added: an object of type 'uint'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The xpad.</summary>
|
||||
<param name="value">an object of type <see cref="T:System.UInt32"/></param>
|
||||
<returns>an object of type <see cref="T:System.UInt32"/></returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="IsExpanded">
|
||||
@ -348,10 +376,10 @@
|
||||
<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>Row is an expander row, and is expanded.</summary>
|
||||
<param name="value">an object of type <see cref="T:System.Boolean"/></param>
|
||||
<returns>an object of type <see cref="T:System.Boolean"/></returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Mode">
|
||||
@ -364,10 +392,10 @@
|
||||
<Parameter Name="value" Type="Gtk.CellRendererMode" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'Gtk.CellRendererMode'</param>
|
||||
<returns>To be added: an object of type 'Gtk.CellRendererMode'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Editable mode of the CellRenderer.</summary>
|
||||
<param name="value">an object of type <see cref="T:Gtk.CellRendererMode"/></param>
|
||||
<returns>an object of type <see cref="T:Gtk.CellRendererMode"/></returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
@ -396,10 +424,10 @@
|
||||
<Parameter Name="value" Type="Gdk.Color" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>Cell background color as a <see cref="T:Gdk.Color" />.</summary>
|
||||
<param name="value">a <see cref="T:Gdk.Color" /></param>
|
||||
<returns>a <see cref="T:Gdk.Color" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="CellBackground">
|
||||
@ -412,11 +440,11 @@
|
||||
<Parameter Name="value" Type="System.String" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>Cell background color as a <see cref="T:System.String" />.</summary>
|
||||
<param name="value">a <see cref="T:System.String" /></param>
|
||||
<returns>a <see cref="T:System.String" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
</Type>
|
||||
</Type>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user