GtkSharp/doc/en/Atk/TextAttribute.xml

<Type Name="TextAttribute" FullName="Atk.TextAttribute">
  <TypeSignature Language="C#" Maintainer="auto" Value="public enum TextAttribute" />
  <AssemblyInfo>
    <AssemblyName>atk-sharp</AssemblyName>
    <AssemblyPublicKey>
    </AssemblyPublicKey>
    <AssemblyVersion>2.12.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>Describes the text attributes supported</summary>
    <remarks />
  </Docs>
  <Base>
    <BaseTypeName>System.Enum</BaseTypeName>
  </Base>
  <Attributes>
    <Attribute>
      <AttributeName>GLib.GType(typeof(Atk.TextAttributeGType))</AttributeName>
    </Attribute>
  </Attributes>
  <Members>
    <Member MemberName="Invalid">
      <MemberSignature Language="C#" Value="Invalid" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> Invalid attribute</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="LeftMargin">
      <MemberSignature Language="C#" Value="LeftMargin" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> The pixel width of the left margin</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="RightMargin">
      <MemberSignature Language="C#" Value="RightMargin" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> The pixel width of the right margin</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Indent">
      <MemberSignature Language="C#" Value="Indent" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> The number of pixels that the text is indented</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Invisible">
      <MemberSignature Language="C#" Value="Invisible" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> Either "true" or "false" indicating whether text is visible or not</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Editable">
      <MemberSignature Language="C#" Value="Editable" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> Either "true" or "false" indicating whether text is editable or not</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="PixelsAboveLines">
      <MemberSignature Language="C#" Value="PixelsAboveLines" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> Pixels of blank space to leave above each newline-terminated line.</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="PixelsBelowLines">
      <MemberSignature Language="C#" Value="PixelsBelowLines" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> Pixels of blank space to leave below each newline-terminated line.</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="PixelsInsideWrap">
      <MemberSignature Language="C#" Value="PixelsInsideWrap" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph).</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="BgFullHeight">
      <MemberSignature Language="C#" Value="BgFullHeight" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>"true" or "false" whether to make the background color for each character the height of the highest font used on the current line, or the height of the font used for the current character.</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Rise">
      <MemberSignature Language="C#" Value="Rise" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Number of pixels that the characters are risen above the baseline</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Underline">
      <MemberSignature Language="C#" Value="Underline" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> "none", "single", "double" or "low"</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Strikethrough">
      <MemberSignature Language="C#" Value="Strikethrough" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> "true" or "false" whether the text is strikethrough</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Size">
      <MemberSignature Language="C#" Value="Size" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> The size of the characters.</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Scale">
      <MemberSignature Language="C#" Value="Scale" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> The scale of the characters. The value is a string representation of a double</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Weight">
      <MemberSignature Language="C#" Value="Weight" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> The weight of the characters.</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Language">
      <MemberSignature Language="C#" Value="Language" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> The language used</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="FamilyName">
      <MemberSignature Language="C#" Value="FamilyName" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> The font family name</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="BgColor">
      <MemberSignature Language="C#" Value="BgColor" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> The background color. The value is an RGB value of the format "u,u,u"</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="FgColor">
      <MemberSignature Language="C#" Value="FgColor" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>The foreground color. The value is an RGB value of the format "u,u,u"</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="BgStipple">
      <MemberSignature Language="C#" Value="BgStipple" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> "true" if a GdkBitmap is set for stippling the background color.</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="FgStipple">
      <MemberSignature Language="C#" Value="FgStipple" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> "true" if a GdkBitmap is set for stippling the foreground color.</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="WrapMode">
      <MemberSignature Language="C#" Value="WrapMode" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> The wrap mode of the text, if any. Values are "none", "char" or "word"</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Direction">
      <MemberSignature Language="C#" Value="Direction" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> The direction of the text, if set. Values are "none", "ltr" or "rtl"</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Justification">
      <MemberSignature Language="C#" Value="Justification" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> The justification of the text, if set. Values are "left", "right", "center" or "fill"</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Stretch">
      <MemberSignature Language="C#" Value="Stretch" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>The stretch of the text, if set. Values are "ultra_condensed", "extra_condensed", "condensed", "semi_condensed", "normal", "semi_expanded", "expanded", "extra_expanded" or "ultra_expanded"</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Variant">
      <MemberSignature Language="C#" Value="Variant" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> The capitalization variant of the text, if set. Values are "normal" or "small_caps"</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Style">
      <MemberSignature Language="C#" Value="Style" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> The slant style of the text, if set. Values are "normal", "oblique" or "italic"</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="LastDefined">
      <MemberSignature Language="C#" Value="LastDefined" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextAttribute</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary> not a valid text attribute, used for finding end of enumeration</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>