2003-02-12 02:00:12 +00:00
<Type Name= "CellRenderer" FullName= "Gtk.CellRenderer" >
2005-05-23 20:41:51 +00:00
<TypeSignature Language= "C#" Maintainer= "John Luke" Value= "public class CellRenderer : Gtk.Object" />
2003-02-12 02:00:12 +00:00
<AssemblyInfo >
<AssemblyName > gtk-sharp</AssemblyName>
2003-12-24 01:35:30 +00:00
<AssemblyPublicKey >
</AssemblyPublicKey>
2005-09-03 04:11:38 +00:00
<AssemblyVersion > 2.6.0.0</AssemblyVersion>
2003-02-12 02:00:12 +00:00
</AssemblyInfo>
2003-02-23 07:26:30 +00:00
<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>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-21 00:13:00 +00:00
<summary > An object for rendering a single cell on a <see cref= "T:Gdk.Drawable" /> </summary>
2003-07-18 01:30:49 +00:00
<remarks >
2003-09-17 21:56:59 +00:00
<para >
2003-07-21 00:13:00 +00:00
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.
2003-07-18 01:30:49 +00:00
</para>
2003-09-17 21:56:59 +00:00
<para >
2003-07-21 00:13:00 +00:00
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.
2003-07-18 01:30:49 +00:00
Instead, any state is set just prior to use.
2003-07-21 00:13:00 +00:00
Then, the cell is measured using <see cref= "M:Gtk.CellRendererGetSize(Gtk.Widget,Gdk.Rectangle,System.Int32,System.Int32,System.Int32,System.Int32)" /> .
2005-01-12 19:27:37 +00:00
Finally, the cell is rendered in the correct location using <see cref= "M:Gtk.CellRenderer.Render(Gdk.Window,Gtk.Widget,Gdk.Rectangle,Gdk.Rectangle,Gdk.Rectangle,Gtk.CellRendererState)" /> .
2003-07-18 01:30:49 +00:00
</para>
2003-09-17 21:56:59 +00:00
<para >
2003-07-21 00:13:00 +00:00
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.
2003-07-18 01:30:49 +00:00
</para>
2003-09-17 21:56:59 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
<Base >
<BaseTypeName > Gtk.Object</BaseTypeName>
</Base>
<Interfaces >
</Interfaces>
<Members >
<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 >
2003-09-17 21:56:59 +00:00
<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>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-21 00:13:00 +00:00
<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>
2003-07-18 01:30:49 +00:00
<remarks >
2003-07-21 00:13:00 +00:00
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.
2003-07-18 01:30:49 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</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 >
2003-09-17 21:56:59 +00:00
<Parameter Name= "width" Type= "System.Int32" />
<Parameter Name= "height" Type= "System.Int32" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-18 01:30:49 +00:00
<summary > Sets the renderer size to be explicit, independent of the properties set.</summary>
2003-07-21 00:13:00 +00:00
<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>
2004-08-04 17:10:22 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</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 >
2003-09-17 21:56:59 +00:00
<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>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-21 00:13:00 +00:00
<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>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public CellRenderer (IntPtr raw);" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "raw" Type= "System.IntPtr" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-23 07:26:30 +00:00
<summary > Internal constructor</summary>
<param name= "raw" > Pointer to the C object.</param>
<remarks >
<para > This is an internal constructor, and should not be used by user code.</para>
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "Height" >
<MemberSignature Language= "C#" Value= "public int Height { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-18 01:30:49 +00:00
<summary > The fixed height.</summary>
2005-05-23 20:41:51 +00:00
<value > an object of type <see cref= "T:System.Int32" /> </value>
2003-07-18 01:30:49 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
<AttributeName > GLib.Property(Name="height")</AttributeName>
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "Visible" >
<MemberSignature Language= "C#" Value= "public bool Visible { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-18 01:30:49 +00:00
<summary > Display the cell.</summary>
2005-05-23 20:41:51 +00:00
<value > an object of type <see cref= "T:System.Boolean" /> </value>
2003-07-18 01:30:49 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
<AttributeName > GLib.Property(Name="visible")</AttributeName>
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "Xalign" >
<MemberSignature Language= "C#" Value= "public float Xalign { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Single</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-18 01:30:49 +00:00
<summary > The x-align.</summary>
2005-05-23 20:41:51 +00:00
<value > an object of type <see cref= "T:System.Single" /> </value>
2003-07-18 01:30:49 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
<AttributeName > GLib.Property(Name="xalign")</AttributeName>
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "Width" >
<MemberSignature Language= "C#" Value= "public int Width { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-18 01:30:49 +00:00
<summary > The fixed width.</summary>
2005-05-23 20:41:51 +00:00
<value > an object of type <see cref= "T:System.Int32" /> </value>
2003-07-18 01:30:49 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
<AttributeName > GLib.Property(Name="width")</AttributeName>
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "Yalign" >
<MemberSignature Language= "C#" Value= "public float Yalign { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Single</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-18 01:30:49 +00:00
<summary > The y-align.</summary>
2005-05-23 20:41:51 +00:00
<value > an object of type <see cref= "T:System.Single" /> </value>
2003-07-18 01:30:49 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
<AttributeName > GLib.Property(Name="yalign")</AttributeName>
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "IsExpander" >
<MemberSignature Language= "C#" Value= "public bool IsExpander { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-18 01:30:49 +00:00
<summary > Row has children.</summary>
2005-05-23 20:41:51 +00:00
<value > an object of type <see cref= "T:System.Boolean" /> </value>
2003-07-18 01:30:49 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
<AttributeName > GLib.Property(Name="is_expander")</AttributeName>
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "Ypad" >
<MemberSignature Language= "C#" Value= "public uint Ypad { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.UInt32</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-18 01:30:49 +00:00
<summary > The ypad.</summary>
2005-05-23 20:41:51 +00:00
<value > an object of type <see cref= "T:System.UInt32" /> </value>
2003-07-18 01:30:49 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
<AttributeName > GLib.Property(Name="ypad")</AttributeName>
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "Xpad" >
<MemberSignature Language= "C#" Value= "public uint Xpad { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.UInt32</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-18 01:30:49 +00:00
<summary > The xpad.</summary>
2005-05-23 20:41:51 +00:00
<value > an object of type <see cref= "T:System.UInt32" /> </value>
2003-07-18 01:30:49 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
<AttributeName > GLib.Property(Name="xpad")</AttributeName>
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "IsExpanded" >
<MemberSignature Language= "C#" Value= "public bool IsExpanded { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-18 01:30:49 +00:00
<summary > Row is an expander row, and is expanded.</summary>
2005-05-23 20:41:51 +00:00
<value > an object of type <see cref= "T:System.Boolean" /> </value>
2003-07-18 01:30:49 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
<AttributeName > GLib.Property(Name="is_expanded")</AttributeName>
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "Mode" >
<MemberSignature Language= "C#" Value= "public Gtk.CellRendererMode Mode { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Gtk.CellRendererMode</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-18 01:30:49 +00:00
<summary > Editable mode of the CellRenderer.</summary>
2005-05-23 20:41:51 +00:00
<value > an object of type <see cref= "T:Gtk.CellRendererMode" /> </value>
2003-07-18 01:30:49 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
<AttributeName > GLib.Property(Name="mode")</AttributeName>
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-07-17 06:38:40 +00:00
<Member MemberName= "CellBackgroundGdk" >
<MemberSignature Language= "C#" Value= "public Gdk.Color CellBackgroundGdk { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Gdk.Color</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-07-17 06:38:40 +00:00
<Docs >
2003-07-18 01:30:49 +00:00
<summary > Cell background color as a <see cref= "T:Gdk.Color" /> .</summary>
2005-05-23 20:41:51 +00:00
<value > a <see cref= "T:Gdk.Color" /> </value>
2003-07-18 01:30:49 +00:00
<remarks />
2003-07-17 06:38:40 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
<AttributeName > GLib.Property(Name="cell_background_gdk")</AttributeName>
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-07-17 06:38:40 +00:00
<Member MemberName= "CellBackground" >
<MemberSignature Language= "C#" Value= "public string CellBackground { set; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.String</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-07-17 06:38:40 +00:00
<Docs >
2003-07-18 01:30:49 +00:00
<summary > Cell background color as a <see cref= "T:System.String" /> .</summary>
2005-05-23 20:41:51 +00:00
<value > a <see cref= "T:System.String" /> </value>
2003-07-18 01:30:49 +00:00
<remarks />
2003-07-17 06:38:40 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
<AttributeName > GLib.Property(Name="cell_background")</AttributeName>
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-12-24 01:35:30 +00:00
<Member MemberName= "GType" >
<MemberSignature Language= "C#" Value= "public static GLib.GType GType { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-06-21 20:14:42 +00:00
<summary > GType Property.</summary>
2005-05-23 20:41:51 +00:00
<value > a <see cref= "T:GLib.GType" /> </value>
2004-06-21 20:14:42 +00:00
<remarks > Returns the native <see cref= "T:GLib.GType" /> value for <see cref= "T:Gtk.CellRenderer" /> .</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "protected CellRenderer (GLib.GType gtype);" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
<Parameter Name= "gtype" Type= "GLib.GType" />
</Parameters>
<Docs >
2004-06-21 20:33:11 +00:00
<summary > Protected Constructor.</summary>
2003-12-24 01:35:30 +00:00
<param name= "gtype" > a <see cref= "T:GLib.GType" /> </param>
2004-06-21 20:33:11 +00:00
<remarks > Chain to this constructor if you have manually registered a native <see cref= "T:GLib.GType" /> value for your subclass.</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
<AttributeName > System.Obsolete(Message=null, IsError=False)</AttributeName>
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2004-06-07 17:14:35 +00:00
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "protected CellRenderer ();" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs >
2004-12-31 21:06:38 +00:00
<summary > Protected constructor.</summary>
2004-08-04 17:10:22 +00:00
<remarks />
2004-06-07 17:14:35 +00:00
</Docs>
</Member>
<Member MemberName= "GetSize" >
<MemberSignature Language= "C#" Value= "public virtual void GetSize (Gtk.Widget widget, ref Gdk.Rectangle cell_area, out int x_offset, out int y_offset, out int width, out int height);" />
2004-05-27 19:02:19 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "widget" Type= "Gtk.Widget" />
2004-06-07 17:14:35 +00:00
<Parameter Name= "cell_area" Type= "Gdk.Rectangle&" RefType= "ref" />
2004-05-27 19:02:19 +00:00
<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 >
2004-06-07 17:14:35 +00:00
<summary > Obtains the <paramref name= "width" /> and <paramref name= "height" /> needed to render the cell.</summary>
2004-05-27 19:02:19 +00:00
<param name= "widget" > a <see cref= "T:Gtk.Widget" /> </param>
<param name= "cell_area" > a <see cref= "T:Gdk.Rectangle" /> </param>
<param name= "x_offset" > a <see cref= "T:System.Int32" /> </param>
<param name= "y_offset" > a <see cref= "T:System.Int32" /> </param>
<param name= "width" > a <see cref= "T:System.Int32" /> </param>
<param name= "height" > a <see cref= "T:System.Int32" /> </param>
2004-06-07 17:14:35 +00:00
<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>
2004-05-27 19:02:19 +00:00
</Docs>
</Member>
2004-06-07 17:14:35 +00:00
<Member MemberName= "Render" >
<MemberSignature Language= "C#" Value= "protected virtual void Render (Gdk.Drawable window, Gtk.Widget widget, Gdk.Rectangle background_area, Gdk.Rectangle cell_area, Gdk.Rectangle expose_area, Gtk.CellRendererState flags);" />
2004-05-27 19:02:19 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "window" Type= "Gdk.Drawable" />
<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 >
2004-08-17 20:43:49 +00:00
<summary > Invokes the virtual render function of the <see cref= "M:CellRenderer" /> . The three passed-in rectangles are areas of window. Most renderers will draw within <paramref name= "cell_area" /> ; the xalign, yalign, xpad, and ypad fields of the <see cref= "M:CellRenderer" /> should be honored with respect to <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.</summary>
2004-08-04 17:10:22 +00:00
<param name= "window" > a <see cref= "T:Gdk.Drawable" /> to render to</param>
<param name= "widget" > a <see cref= "T:Gtk.Widget" /> , the widget that owns <paramref name= "window" /> </param>
<param name= "background_area" > a <see cref= "T:Gdk.Rectangle" /> , entire cell area (including tree expanders and maybe padding on the sides)</param>
<param name= "cell_area" > a <see cref= "T:Gdk.Rectangle" /> , area normally rendered by a cell renderer</param>
<param name= "expose_area" > a <see cref= "T:Gdk.Rectangle" /> , area that needs updating</param>
<param name= "flags" > a <see cref= "T:System.Int32" /> , flags that affect rendering</param>
<remarks />
2004-05-27 19:02:19 +00:00
</Docs>
</Member>
2004-06-07 17:14:35 +00:00
<Member MemberName= "StartEditing" >
<MemberSignature Language= "C#" Value= "public virtual 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>
2004-06-01 18:05:26 +00:00
<Docs >
2004-06-07 17:14:35 +00:00
<summary > Passes an activate event to the <see cref= "T:Gtk.CellRenderer" /> for possible processing.</summary>
<param name= "evnt" > a <see cref= "T:Gdk.Event" /> </param>
<param name= "widget" > a <see cref= "T:Gtk.Widget" /> </param>
<param name= "path" > a <see cref= "T:System.String" /> </param>
<param name= "background_area" > a <see cref= "T:Gdk.Rectangle" /> </param>
<param name= "cell_area" > a <see cref= "T:Gdk.Rectangle" /> </param>
<param name= "flags" > a <see cref= "T:System.Int32" /> </param>
<returns > a <see cref= "T:Gtk.CellEditable" /> </returns>
2004-08-04 17:10:22 +00:00
<remarks > Some cell renderers may use events; for example, <see cref= "T:CellRendererToggle" /> toggles when it gets a mouse click.</remarks>
2004-06-01 18:05:26 +00:00
</Docs>
</Member>
2004-11-05 21:25:40 +00:00
<Member MemberName= "EditingCanceled" >
<MemberSignature Language= "C#" Value= "public event EventHandler EditingCanceled;" />
<MemberType > Event</MemberType>
<ReturnValue >
<ReturnType > System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-12-31 21:06:38 +00:00
<summary >
This event is fired when the user cancels the process of
editing a cell.
</summary>
<remarks >
For example, an editable cell renderer could be written to cancel
editing when the user presses Escape.
</remarks>
2005-06-16 18:56:42 +00:00
<since version= "Gtk# 2.4" />
2004-11-05 21:25:40 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
<AttributeName > GLib.Signal(CName="editing-canceled")</AttributeName>
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2004-11-05 21:25:40 +00:00
<Member MemberName= "OnEditingCanceled" >
<MemberSignature Language= "C#" Value= "protected virtual void OnEditingCanceled ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-12-08 02:37:02 +00:00
<summary > Default handler for the <see cref= "M:Gtk.CellRenderer.EditingCanceled" /> event.</summary>
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.CellRenderer.EditingCanceled" /> event.</remarks>
2005-06-16 18:56:42 +00:00
<since version= "Gtk# 2.4" />
2004-11-05 21:25:40 +00:00
</Docs>
</Member>
<Member MemberName= "CancelEditing" >
<MemberSignature Language= "C#" Value= "public void CancelEditing ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-12-31 21:06:38 +00:00
<summary > Causes the cell renderer to fire an <see cref= "M:Gtk.CellRenderer.EditingCanceled" /> event.</summary>
<remarks >
This function is for use only by implementations of cell renderers that need to
notify the client program that an editing process was canceled and the
changes were not committed.
</remarks>
2005-06-16 18:56:42 +00:00
<since version= "Gtk# 2.4" />
2004-11-05 21:25:40 +00:00
</Docs>
</Member>
2005-04-21 17:10:54 +00:00
<Member MemberName= "Sensitive" >
<MemberSignature Language= "C#" Value= "public bool Sensitive { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > To be added</summary>
2005-05-23 20:41:51 +00:00
<value > a <see cref= "T:System.Boolean" /> </value>
2005-04-21 17:10:54 +00:00
<remarks > To be added</remarks>
2005-06-16 19:27:40 +00:00
<since version= "Gtk# 2.6" />
2005-04-21 17:10:54 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
<AttributeName > GLib.Property(Name="sensitive")</AttributeName>
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2005-09-03 04:11:38 +00:00
<Member MemberName= "EditingStarted" >
<MemberSignature Language= "C#" Value= "public event Gtk.EditingStartedHandler EditingStarted;" />
<MemberType > Event</MemberType>
<ReturnValue >
<ReturnType > Gtk.EditingStartedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > To be added</summary>
<remarks > To be added</remarks>
<since version= "Gtk# 2.6" />
</Docs>
<Attributes >
<Attribute >
<AttributeName > GLib.Signal(CName="editing-started")</AttributeName>
</Attribute>
</Attributes>
</Member>
2005-04-21 17:10:54 +00:00
<Member MemberName= "OnEditingStarted" >
<MemberSignature Language= "C#" Value= "protected virtual void OnEditingStarted (Gtk.CellEditable editable, string path);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "editable" Type= "Gtk.CellEditable" />
<Parameter Name= "path" Type= "System.String" />
</Parameters>
<Docs >
2005-04-22 17:20:16 +00:00
<summary > Default handler for the <see cref= "M:Gtk.CellRenderer.EditingStarted" /> event.</summary>
2005-04-21 17:10:54 +00:00
<param name= "editable" > a <see cref= "T:Gtk.CellEditable" /> </param>
<param name= "path" > a <see cref= "T:System.String" /> </param>
2005-04-22 17:20:16 +00:00
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.CellRenderer.EditingStarted" /> event.</remarks>
2005-06-16 19:27:40 +00:00
<since version= "Gtk# 2.6" />
2005-04-21 17:10:54 +00:00
</Docs>
</Member>
<Member MemberName= "StopEditing" >
<MemberSignature Language= "C#" Value= "public void StopEditing (bool canceled);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "canceled" Type= "System.Boolean" />
</Parameters>
<Docs >
<summary > To be added</summary>
<param name= "canceled" > a <see cref= "T:System.Boolean" /> </param>
<remarks > To be added</remarks>
2005-06-16 19:27:40 +00:00
<since version= "Gtk# 2.6" />
2005-04-21 17:10:54 +00:00
</Docs>
</Member>
2005-06-16 18:56:42 +00:00
<Member MemberName= "GetFixedSize" >
2005-05-23 20:41:51 +00:00
<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&" RefType= "out" />
<Parameter Name= "height" Type= "System.Int32&" RefType= "out" />
</Parameters>
<Docs >
<param name= "width" > To be added.</param>
<param name= "height" > To be added.</param>
<summary > To be added.</summary>
<remarks > To be added.</remarks>
</Docs>
</Member>
2003-02-12 02:00:12 +00:00
</Members>
2005-06-17 18:43:30 +00:00
</Type>