Ryujinx-GtkSharp/doc/en/Gtk/CellRenderer.xml
Duncan Mak efa9acf122 2003-03-06 Duncan Mak <duncan@ximian.com>
* en/*/*.xml: Updated all the docs to match the new API. All the nodes
	that no longer have a corresponding member in the type are now
	marked as deprecated. We'll have to wait for Miguel to implement
	this in the browser to stop displaying them.

	All gtype constructors have been regenerated, because of the
	'uint' to 'GLib.Type' change. However, this patch will preserve
	(well, it was regenerated) the customized text for those GType
	constructors.

	A lot of the 'Finalized' methods are also now marked as
	deprecated, because the classes implement 'Dispose' instead. This
	is a possible place for customized scripts to generate template
	documentation, similar to the GType property and GType constructors.

svn path=/trunk/gtk-sharp/; revision=12270
2003-03-07 01:30:00 +00:00

432 lines
18 KiB
XML

<Type Name="CellRenderer" FullName="Gtk.CellRenderer">
<TypeSignature Language="C#" Value="public class CellRenderer : Gtk.Object, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes />
</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>
</Docs>
<Base>
<BaseTypeName>Gtk.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="ModeGetType" Deprecated="true">
<MemberSignature Language="C#" Value="public static uint ModeGetType ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="StateGetType" Deprecated="true">
<MemberSignature Language="C#" Value="public static uint StateGetType ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Render">
<MemberSignature Language="C#" Value="public void Render (Gdk.Window window, Gtk.Widget widget, Gdk.Rectangle background_area, Gdk.Rectangle cell_area, Gdk.Rectangle expose_area, Gtk.CellRendererState flags);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="window" Type="Gdk.Window" />
<Parameter Name="widget" Type="Gtk.Widget" />
<Parameter Name="background_area" Type="Gdk.Rectangle" />
<Parameter Name="cell_area" Type="Gdk.Rectangle" />
<Parameter Name="expose_area" Type="Gdk.Rectangle" />
<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>
</Docs>
</Member>
<Member MemberName="GetSize">
<MemberSignature Language="C#" Value="public void GetSize (Gtk.Widget widget, Gdk.Rectangle cell_area, out int x_offset, out int y_offset, out int width, out int height);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="widget" Type="Gtk.Widget" />
<Parameter Name="cell_area" Type="Gdk.Rectangle" />
<Parameter Name="x_offset" Type="System.Int32&amp;" />
<Parameter Name="y_offset" Type="System.Int32&amp;" />
<Parameter Name="width" Type="System.Int32&amp;" />
<Parameter Name="height" Type="System.Int32&amp;" />
</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&amp;'</param>
<param name="y_offset">To be added: an object of type 'int&amp;'</param>
<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>
</Docs>
</Member>
<Member MemberName="SetFixedSize">
<MemberSignature Language="C#" Value="public void SetFixedSize (int width, int height);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="width" Type="System.Int32" />
<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>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetFixedSize">
<MemberSignature Language="C#" Value="public void GetFixedSize (out int width, out int height);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="width" Type="System.Int32&amp;" />
<Parameter Name="height" Type="System.Int32&amp;" />
</Parameters>
<Docs>
<summary>To be added</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>
</Docs>
</Member>
<Member MemberName="StartEditing">
<MemberSignature Language="C#" Value="public Gtk.CellEditable StartEditing (Gdk.Event evnt, Gtk.Widget widget, string path, Gdk.Rectangle background_area, Gdk.Rectangle cell_area, Gtk.CellRendererState flags);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.CellEditable</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
<Parameter Name="widget" Type="Gtk.Widget" />
<Parameter Name="path" Type="System.String" />
<Parameter Name="background_area" Type="Gdk.Rectangle" />
<Parameter Name="cell_area" Type="Gdk.Rectangle" />
<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>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Activate">
<MemberSignature Language="C#" Value="public bool Activate (Gdk.Event evnt, Gtk.Widget widget, string path, Gdk.Rectangle background_area, Gdk.Rectangle cell_area, Gtk.CellRendererState flags);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
<Parameter Name="widget" Type="Gtk.Widget" />
<Parameter Name="path" Type="System.String" />
<Parameter Name="background_area" Type="Gdk.Rectangle" />
<Parameter Name="cell_area" Type="Gdk.Rectangle" />
<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>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected virtual void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Disposes the resources associated with the object.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor" Deprecated="true">
<MemberSignature Language="C#" Value="protected CellRenderer (uint gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of CellRenderer, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gtk.CellRenderer" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CellRenderer (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
<returns>An instance of CellRenderer, wrapping the C object.</returns>
<remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CellRenderer ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.CellRenderer'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gtk.CellRenderer</summary>
<returns>The GLib Type for the Gtk.CellRenderer class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Height">
<MemberSignature Language="C#" Value="public int Height { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<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>
</Docs>
</Member>
<Member MemberName="Visible">
<MemberSignature Language="C#" Value="public bool Visible { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<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>
</Docs>
</Member>
<Member MemberName="Xalign">
<MemberSignature Language="C#" Value="public float Xalign { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Parameters>
<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>
</Docs>
</Member>
<Member MemberName="Width">
<MemberSignature Language="C#" Value="public int Width { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<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>
</Docs>
</Member>
<Member MemberName="Yalign">
<MemberSignature Language="C#" Value="public float Yalign { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Parameters>
<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>
</Docs>
</Member>
<Member MemberName="IsExpander">
<MemberSignature Language="C#" Value="public bool IsExpander { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<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>
</Docs>
</Member>
<Member MemberName="Ypad">
<MemberSignature Language="C#" Value="public uint Ypad { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<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>
</Docs>
</Member>
<Member MemberName="Xpad">
<MemberSignature Language="C#" Value="public uint Xpad { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<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>
</Docs>
</Member>
<Member MemberName="IsExpanded">
<MemberSignature Language="C#" Value="public bool IsExpanded { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<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>
</Docs>
</Member>
<Member MemberName="Mode">
<MemberSignature Language="C#" Value="public Gtk.CellRendererMode Mode { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.CellRendererMode</ReturnType>
</ReturnValue>
<Parameters>
<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>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CellRenderer (GLib.Type gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of CellRenderer, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gtk.CellRenderer" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>