GtkSharp/doc/en/Gtk/CellRendererText.xml

<Type Name="CellRendererText" FullName="Gtk.CellRendererText">
  <TypeSignature Language="C#" Maintainer="John Luke" Value="public class CellRendererText : Gtk.CellRenderer" />
  <AssemblyInfo>
    <AssemblyName>gtk-sharp</AssemblyName>
    <AssemblyPublicKey>
    </AssemblyPublicKey>
    <AssemblyVersion>2.10.0.0</AssemblyVersion>
  </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>Renders text in a cell</summary>
    <remarks>Used to add text to a <see cref="T:Gtk.TreeView" />.</remarks>
  </Docs>
  <Base>
    <BaseTypeName>Gtk.CellRenderer</BaseTypeName>
  </Base>
  <Interfaces>
  </Interfaces>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public CellRendererText (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>
        <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="public CellRendererText ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>Creates a new <see cref="T:Gtk.CellRendererText" />.</summary>
        <remarks>The default constructor.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FixedHeightFromFont">
      <MemberSignature Language="C#" Value="public int FixedHeightFromFont { set; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Sets the height of a renderer to explicitly be determined by the <see cref="P:Gtk.CellRendererText.Font" />.</summary>
        <value>an object of type <see cref="T:System.Int32" /></value>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Size">
      <MemberSignature Language="C#" Value="public int Size { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Font size.</summary>
        <value>an object of type <see cref="T:System.Int32" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("size")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Scale">
      <MemberSignature Language="C#" Value="public double Scale { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Font scaling factor.</summary>
        <value>an object of type <see cref="T:System.Double" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("scale")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Foreground">
      <MemberSignature Language="C#" Value="public string Foreground { set; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Foreground color as a string.</summary>
        <value>an object of type <see cref="T:System.String" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("foreground")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Strikethrough">
      <MemberSignature Language="C#" Value="public bool Strikethrough { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Whether to strike through the text.</summary>
        <value>an object of type <see cref="T:System.Boolean" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("strikethrough")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="FontDesc">
      <MemberSignature Language="C#" Value="public Pango.FontDescription FontDesc { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Pango.FontDescription</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>The font description as a <see cref="T:Pango.FontDescription" /></summary>
        <value>an object of type <see cref="T:Pango.FontDescription" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("font-desc")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Font">
      <MemberSignature Language="C#" Value="public string Font { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Font description as a <see cref="T:System.String" />.</summary>
        <value>an object of type <see cref="T:System.String" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("font")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="SizePoints">
      <MemberSignature Language="C#" Value="public double SizePoints { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Font size in points.</summary>
        <value>an object of type <see cref="T:System.Double" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("size-points")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Rise">
      <MemberSignature Language="C#" Value="public int Rise { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Offset of text above the baseline (below the baseline if rise is negative).</summary>
        <value>an object of type <see cref="T:System.Int32" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("rise")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Text">
      <MemberSignature Language="C#" Value="public string Text { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Text to render.</summary>
        <value>an object of type <see cref="T:System.String" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("text")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Weight">
      <MemberSignature Language="C#" Value="public int Weight { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Font weight.</summary>
        <value>an object of type <see cref="T:System.Int32" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("weight")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Background">
      <MemberSignature Language="C#" Value="public string Background { set; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Background color as a <see cref="T:System.String" />.</summary>
        <value>an object of type <see cref="T:System.String" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("background")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Editable">
      <MemberSignature Language="C#" Value="public bool Editable { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Whether the text can be modified by the user.</summary>
        <value>an object of type <see cref="T:System.Boolean" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("editable")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Variant">
      <MemberSignature Language="C#" Value="public Pango.Variant Variant { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Pango.Variant</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Font variant.</summary>
        <value>an object of type <see cref="T:Pango.Variant" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("variant")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="BackgroundGdk">
      <MemberSignature Language="C#" Value="public Gdk.Color BackgroundGdk { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Color</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Background color as a <see cref="T:Gdk.Color" />.</summary>
        <value>an object of type <see cref="T:Gdk.Color" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("background-gdk")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Family">
      <MemberSignature Language="C#" Value="public string Family { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Name of the font family, e.g. Sans, Helvetica, Times, Monospace.</summary>
        <value>an object of type <see cref="T:System.String" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("family")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Attributes">
      <MemberSignature Language="C#" Value="public Pango.AttrList Attributes { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Pango.AttrList</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>A list of style attributes to apply to the text of the renderer.</summary>
        <value>an object of type <see cref="T:Pango.AttrList" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("attributes")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Stretch">
      <MemberSignature Language="C#" Value="public Pango.Stretch Stretch { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Pango.Stretch</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Font stretch.</summary>
        <value>an object of type <see cref="T:Pango.Stretch" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("stretch")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Markup">
      <MemberSignature Language="C#" Value="public string Markup { set; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Marked up text to render.</summary>
        <value>an object of type <see cref="T:System.String" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("markup")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Style">
      <MemberSignature Language="C#" Value="public Pango.Style Style { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Pango.Style</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Font style.</summary>
        <value>an object of type <see cref="T:Pango.Style" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("style")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Underline">
      <MemberSignature Language="C#" Value="public Pango.Underline Underline { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Pango.Underline</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Style of underline for this text.</summary>
        <value>an object of type <see cref="T:Pango.Underline" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("underline")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="ForegroundGdk">
      <MemberSignature Language="C#" Value="public Gdk.Color ForegroundGdk { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Color</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Foreground color as a <see cref="T:Gdk.Color" />.</summary>
        <value>an object of type <see cref="T:Gdk.Color" /></value>
        <remarks />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("foreground-gdk")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Edited">
      <MemberSignature Language="C#" Value="public event Gtk.EditedHandler Edited;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.EditedHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Emitted when the cell is edited.</summary>
        <remarks>
        </remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Signal("edited")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="GType">
      <MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>GLib.GType</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>GType Property.</summary>
        <value>a <see cref="T:GLib.GType" /></value>
        <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.CellRendererText" />.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnEdited">
      <MemberSignature Language="C#" Value="protected virtual void OnEdited (string path, string new_text);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="path" Type="System.String" />
        <Parameter Name="new_text" Type="System.String" />
      </Parameters>
      <Docs>
        <summary>Default handler for the <see cref="M:Gtk.CellRendererText.Edited" /> event.</summary>
        <param name="path">a <see cref="T:System.String" /></param>
        <param name="new_text">a <see cref="T:System.String" /></param>
        <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.CellRendererText.Edited" /> event.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected CellRendererText (GLib.GType gtype);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="gtype" Type="GLib.GType" />
      </Parameters>
      <Docs>
        <summary>Protected Constructor.</summary>
        <param name="gtype">a <see cref="T:GLib.GType" /></param>
        <remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>System.Obsolete</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="SingleParagraphMode">
      <MemberSignature Language="C#" Value="public bool SingleParagraphMode { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Whether or not to keep all text in a single paragraph.</summary>
        <value>a <see cref="T:System.Boolean" /></value>
        <remarks>
        </remarks>
        <since version="Gtk# 2.4" />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("single-paragraph-mode")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Language">
      <MemberSignature Language="C#" Value="public string Language { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>The language this text is in, as an ISO code. </summary>
        <value>a <see cref="T:System.String" /></value>
        <remarks>
	  Pango can use this as a hint when rendering the text. If you 
	  don't understand this parameter, you probably don't need it.
	</remarks>
        <since version="Gtk# 2.4" />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("language")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Ellipsize">
      <MemberSignature Language="C#" Value="public Pango.EllipsizeMode Ellipsize { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Pango.EllipsizeMode</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Specifies the preferred place to ellipsize the string, if the cell renderer does not have enough room to display the entire string.</summary>
        <value>A <see cref="T:Pango.EllipsizeMode" />.</value>
        <remarks>Setting it to <see cref="E:Pango.EllipsizeMode.None" /> turns off ellipsizing. See the <see cref="P:Gtk.CellRendererText.WrapWidth" /> property for another way of making the text fit in a given width.</remarks>
        <since version="Gtk# 2.6" />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("ellipsize")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="WidthChars">
      <MemberSignature Language="C#" Value="public int WidthChars { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>The desired width of the cell, in characters.</summary>
        <value>A <see cref="T:System.Int32" /> that is equal or greater than -1.</value>
        <remarks>If this property is set to -1, the width will be calculated automatically, otherwise the cell will request either 3 characters or the property value, whichever is greater. It's default value is -1.</remarks>
        <since version="Gtk# 2.6" />
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("width-chars")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="WrapWidth">
      <MemberSignature Language="C#" Value="public int WrapWidth { set; get; };" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("wrap-width")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The width at which text is wrapped.</summary>
        <value>a width &gt;= -1, where -1 denotes no wrapping.</value>
        <remarks />
        <since version="Gtk# 2.8" />
      </Docs>
    </Member>
    <Member MemberName="WrapMode">
      <MemberSignature Language="C#" Value="public Pango.WrapMode WrapMode { set; get; };" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("wrap-mode")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Pango.WrapMode</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Wrapping mode.</summary>
        <value>a <see cref="T:Pango.WrapMode" /> indicating how text is wrapped.</value>
        <remarks>Defaults to <see cref="M:Pango.WrapMode.Char" />.</remarks>
        <since version="Gtk# 2.8" />
      </Docs>
    </Member>
    <Member MemberName="Alignment">
      <MemberSignature Language="C#" Value="public Pango.Alignment Alignment { set; get; };" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("alignment")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Pango.Alignment</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Identifies the Alignment of text within the renderer.</summary>
        <value>a <see cref="Pango.Alignment" />.</value>
        <remarks />
        <since version="Gtk# 2.10" />
      </Docs>
    </Member>
  </Members>
</Type>