GtkSharp/doc/en/Gnome/CanvasRichText.xml

563 lines
20 KiB
XML
Raw Normal View History

<Type Name="CanvasRichText" FullName="Gnome.CanvasRichText">
<TypeSignature Language="C#" Maintainer="auto" Value="public class CanvasRichText : Gnome.CanvasItem" />
<AssemblyInfo>
<AssemblyName>gnome-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.8.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>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.CanvasItem</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Members>
<Member MemberName="PasteClipboard">
<MemberSignature Language="C#" Value="public void PasteClipboard ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Paste the contents of the clipboard into the text buffer at the current cursor location.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CutClipboard">
<MemberSignature Language="C#" Value="public void CutClipboard ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Cut the selected text.</summary>
<remarks>This method copies the highlighted text from the <see cref="T:Gtk.TextBuffer" /> into the clipboard.
<block subset="none" type="note">
<para>If none of the text is selected, the contents of the clipboard are still set to the null string.
</para>
</block></remarks>
</Docs>
</Member>
<Member MemberName="CopyClipboard">
<MemberSignature Language="C#" Value="public void CopyClipboard ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Copy the selected text.</summary>
<remarks>This method copies the highlighted text from the <see cref="T:Gtk.TextBuffer" /> into the clipboard.
<block subset="none" type="note">
<para>If nothing is highlighted in the text, the contents of the clipboard are still replaced with the null string.
</para>
</block></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CanvasRichText (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 CanvasRichText (Gnome.CanvasGroup group);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Docs>
<summary>Add a new RichTextItem to the given <see cref="T:Gnome.CanvasGroup" />.</summary>
<param name="group">To be added: an object of type 'Gnome.CanvasGroup'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Buffer">
<MemberSignature Language="C#" Value="public Gtk.TextBuffer Buffer { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.TextBuffer</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The <see cref="T:Gtk.TextBuffer" /> that is displayed on the <see cref="T:Gnome.CanvasItem" />.</summary>
<value>To be added: an object of type 'Gtk.TextBuffer'</value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CursorVisible">
<MemberSignature Language="C#" Value="public bool CursorVisible { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Whether the cursor is visible or not.</summary>
<value>To be added: an object of type 'bool'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="cursor_visible")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Visible">
<MemberSignature Language="C#" Value="public bool Visible { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Whether the item is visible or not.</summary>
<value>To be added: an object of type 'bool'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="visible")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="GrowHeight">
<MemberSignature Language="C#" Value="public bool GrowHeight { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Whether the box height should grow if the text does not fit.</summary>
<value>To be added: an object of type 'bool'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="grow_height")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Height">
<MemberSignature Language="C#" Value="public double Height { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The height of the text box.</summary>
<value>To be added: an object of type 'double'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="height")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="WrapMode">
<MemberSignature Language="C#" Value="public Gtk.WrapMode WrapMode { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.WrapMode</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>How the text in the widget should wrap.</summary>
<value>To be added: an object of type 'Gtk.WrapMode'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="wrap_mode")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Anchor">
<MemberSignature Language="C#" Value="public Gtk.AnchorType Anchor { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.AnchorType</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Anchor point for text.</summary>
<value>To be added: an object of type 'Gtk.AnchorType'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="anchor")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="LeftMargin">
<MemberSignature Language="C#" Value="public int LeftMargin { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The number of pixels in the left margin.</summary>
<value>To be added: an object of type 'int'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="left_margin")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Width">
<MemberSignature Language="C#" Value="public double Width { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The width of the text box.</summary>
<value>To be added: an object of type 'double'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="width")</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>The text to be displayed.</summary>
<value>To be added: an object of type 'string'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="text")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Direction">
<MemberSignature Language="C#" Value="public Gtk.DirectionType Direction { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.DirectionType</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The direction for the text.</summary>
<value>To be added: an object of type 'Gtk.DirectionType'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="direction")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="PixelsAboveLines">
<MemberSignature Language="C#" Value="public int PixelsAboveLines { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The number of pixels above each line.</summary>
<value>To be added: an object of type 'int'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="pixels_above_lines")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Y">
<MemberSignature Language="C#" Value="public double Y { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The Y position.</summary>
<value>To be added: an object of type 'double'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="y")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="X">
<MemberSignature Language="C#" Value="public double X { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The X position.</summary>
<value>To be added: an object of type 'double'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="x")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Justification">
<MemberSignature Language="C#" Value="public Gtk.Justification Justification { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Justification</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The justification for the text.</summary>
<value>To be added: an object of type 'Gtk.Justification'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="justification")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Indent">
<MemberSignature Language="C#" Value="public int Indent { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The number of pixels to indent.</summary>
<value>To be added: an object of type 'int'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="indent")</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 is editable or not.</summary>
<value>To be added: an object of type 'bool'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="editable")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="RightMargin">
<MemberSignature Language="C#" Value="public int RightMargin { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The number of pixels in the right margin.</summary>
<value>To be added: an object of type 'int'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="right_margin")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="CursorBlink">
<MemberSignature Language="C#" Value="public bool CursorBlink { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Whether the cursor blinks or not.</summary>
<value>To be added: an object of type 'bool'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="cursor_blink")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="PixelsBelowLines">
<MemberSignature Language="C#" Value="public int PixelsBelowLines { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The number of pixels below each line.</summary>
<value>To be added: an object of type 'int'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="pixels_below_lines")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="PixelsInsideWrap">
<MemberSignature Language="C#" Value="public int PixelsInsideWrap { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The number of pixels inside the wrap.</summary>
<value>To be added: an object of type 'int'</value>
<remarks>To be added</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="pixels_inside_wrap")</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:Gnome.CanvasRichText" />.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CanvasRichText (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(Message=null, IsError=False)</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="GetIterLocation">
<MemberSignature Language="C#" Value="public Gdk.Rectangle GetIterLocation (Gtk.TextIter iter);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Rectangle</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="iter" Type="Gtk.TextIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">a <see cref="T:Gtk.TextIter" /></param>
<returns>a <see cref="T:Gdk.Rectangle" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetIterAtLocation">
<MemberSignature Language="C#" Value="public Gtk.TextIter GetIterAtLocation (int x, int y);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.TextIter</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="x" Type="System.Int32" />
<Parameter Name="y" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="x">a <see cref="T:System.Int32" /></param>
<param name="y">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gtk.TextIter" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CanvasRichText ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>