mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-12-26 01:35:31 +00:00
c0cb153d7d
* en/Pango/*: Filled in all "To be added"; cleaned up existing docs and made them more consistent. svn path=/trunk/gtk-sharp/; revision=31738
227 lines
12 KiB
XML
227 lines
12 KiB
XML
<Type Name="Global" FullName="Pango.Global">
|
|
<TypeSignature Language="C#" Value="public class Global" Maintainer="auto" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>pango-sharp</AssemblyName>
|
|
<AssemblyPublicKey>
|
|
</AssemblyPublicKey>
|
|
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
<AssemblyCulture>neutral</AssemblyCulture>
|
|
<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>Global API elements for <see cref="N:Pango" />. Most of these are utility functions.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Base>
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Attributes />
|
|
<Members>
|
|
<Member MemberName="SplitFileList">
|
|
<MemberSignature Language="C#" Value="public static string SplitFileList (string str);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="str" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Splits a list of filename strings and normalizes their paths.</summary>
|
|
<param name="str">a <see cref="T:System.String" /></param>
|
|
<returns>a <see cref="T:System.String" /></returns>
|
|
<remarks>In the underlying C implementation, the string returned is intended as an argument to g_strfreev.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="TrimString">
|
|
<MemberSignature Language="C#" Value="public static string TrimString (string str);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="str" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Trims leading and trailing whitespace from a string.</summary>
|
|
<param name="str">a <see cref="T:System.String" /></param>
|
|
<returns>a <see cref="T:System.String" /></returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetLogAttrs">
|
|
<MemberSignature Language="C#" Value="public static void GetLogAttrs (string text, int level, Pango.Language language, Pango.LogAttr log_attrs, int attrs_len);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="text" Type="System.String" />
|
|
<Parameter Name="level" Type="System.Int32" />
|
|
<Parameter Name="language" Type="Pango.Language" />
|
|
<Parameter Name="log_attrs" Type="Pango.LogAttr" />
|
|
<Parameter Name="attrs_len" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Computes a <see cref="T:Pango.LogAttr" /> for each character in <paramref name="text" />.</summary>
|
|
<param name="text"> text to process</param>
|
|
<param name="level"> embedding level, or -1 if unknown</param>
|
|
<param name="language"> language tag</param>
|
|
<param name="log_attrs"> array with one PangoLogAttr per character in text, plus one extra, to be filled in</param>
|
|
<param name="attrs_len">a <see cref="T:System.Int32" /></param>
|
|
<remarks>The <paramref name="log_attrs" /> array must have one <see cref="T:Pango.LogAttr" /> for each position in text; if text contains N characters, it has N+1 positions, including the last position at the end of the text. text should be an entire paragraph; logical attributes cannot be computed without context (for example you need to see spaces on either side of a word to know the word is a word).</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SkipSpace">
|
|
<MemberSignature Language="C#" Value="public static bool SkipSpace (string pos);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="pos" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Skips 0 or more characters of whitespace</summary>
|
|
<param name="pos">a <see cref="T:System.String" /></param>
|
|
<returns>a <see cref="T:System.Boolean" />, which is true if there are non-whitespace characters before the end of the string.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Global ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Default constructor</summary>
|
|
<returns>a <see cref="T:Pango.Global" /></returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ParseWeight">
|
|
<MemberSignature Language="C#" Value="public static bool ParseWeight (string str, out Pango.Weight weight, bool warn);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="str" Type="System.String" />
|
|
<Parameter Name="weight" Type="Pango.Weight&" RefType="out" />
|
|
<Parameter Name="warn" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Parses a string into a <see cref="T:Pango.Weight&" /> object.</summary>
|
|
<param name="str">a <see cref="T:System.String" /> to parse</param>
|
|
<param name="weight">a <see cref="T:Pango.Weight&" /> object to set up with the weight parsed out of the string</param>
|
|
<param name="warn">a <see cref="T:System.Boolean" /> for whether to warn on bad input.</param>
|
|
<returns>a <see cref="T:System.Boolean" /> for whether the string was successfully parsed.</returns>
|
|
<remarks>The allowed values are "heavy", "ultrabold", "bold", "normal", "light", "ultralight" and integers. Case variations are ignored.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ParseStretch">
|
|
<MemberSignature Language="C#" Value="public static bool ParseStretch (string str, out Pango.Stretch stretch, bool warn);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="str" Type="System.String" />
|
|
<Parameter Name="stretch" Type="Pango.Stretch&" RefType="out" />
|
|
<Parameter Name="warn" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Parses a string into a <see cref="T:Pango.Stretch&" /> object.</summary>
|
|
<param name="str">a <see cref="T:System.String" /> to parse</param>
|
|
<param name="stretch">a <see cref="T:Pango.Stretch&" /> to set up with the stretch value parsed out of the string</param>
|
|
<param name="warn">a <see cref="T:System.Boolean" /> for whether to warn on bad input.</param>
|
|
<returns>a <see cref="T:System.Boolean" /> for whether the string was successfully parsed.</returns>
|
|
<remarks>The allowed values are "ultra_condensed", "extra_condensed", "condensed", "semi_condensed", "normal",
|
|
"semi_expanded", "expanded", "extra_expanded" and "ultra_expanded". Case variations are ignored and the '_'
|
|
characters may be omitted.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ParseVariant">
|
|
<MemberSignature Language="C#" Value="public static bool ParseVariant (string str, out Pango.Variant variant, bool warn);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="str" Type="System.String" />
|
|
<Parameter Name="variant" Type="Pango.Variant&" RefType="out" />
|
|
<Parameter Name="warn" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Parses a string into a <see cref="T:Pango.Variant&" /> object.</summary>
|
|
<param name="str">a <see cref="T:System.String" /> to parse</param>
|
|
<param name="variant">a <see cref="T:Pango.Variant&" />to set up with the variant value parsed out of the string</param>
|
|
<param name="warn">a <see cref="T:System.Boolean" /> for whether to warn on bad input.</param>
|
|
<returns>a <see cref="T:System.Boolean" /> for whether the string was successfully parsed.</returns>
|
|
<remarks>The allowed values are "normal" and "smallcaps" or "small_caps", case variations being ignored.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ParseStyle">
|
|
<MemberSignature Language="C#" Value="public static bool ParseStyle (string str, out Pango.Style style, bool warn);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="str" Type="System.String" />
|
|
<Parameter Name="style" Type="Pango.Style&" RefType="out" />
|
|
<Parameter Name="warn" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Parses a string into a <see cref="T:Pango.Style&" /> object.</summary>
|
|
<param name="str">a <see cref="T:System.String" /> to parse</param>
|
|
<param name="style">a <see cref="T:Pango.Style&" /> to set up with the style parsed out of the string.</param>
|
|
<param name="warn">a <see cref="T:System.Boolean" /> for whether to warn on bad input.</param>
|
|
<returns>a <see cref="T:System.Boolean" /> for whether the string was successfully parsed.</returns>
|
|
<remarks>The allowed values are "normal", "italic" and "oblique", case variations being ignored.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="FindParagraphBoundary">
|
|
<MemberSignature Language="C#" Value="public static void FindParagraphBoundary (string text, out int paragraph_delimiter_index, out int next_paragraph_start);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="text" Type="System.String" />
|
|
<Parameter Name="paragraph_delimiter_index" Type="System.Int32&" RefType="out" />
|
|
<Parameter Name="next_paragraph_start" Type="System.Int32&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Locates a paragraph boundary in <paramref name="text" />.</summary>
|
|
<param name="text"> UTF-8 text</param>
|
|
<param name="paragraph_delimiter_index"> return location for index of delimiter</param>
|
|
<param name="next_paragraph_start"> return location for start of next paragraph</param>
|
|
<remarks>
|
|
<para>
|
|
A boundary is caused by delimiter characters, such as a newline, carriage return, carriage return-newline pair, or Unicode paragraph separator character. The index of the run of delimiters is returned in <paramref name="paragraph_delimiter_index" />. The index of the start of the paragraph (index after all delimiters) is stored in <paramref name="next_paragraph_start" />.
|
|
</para>
|
|
If no delimiters are found, both <paramref name="paragraph_delimiter_index" /> and <paramref name="next_paragraph_start" /> are filled with the length of text (an index one off the end).</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ScanInt">
|
|
<MemberSignature Language="C#" Value="public static bool ScanInt (string pos, out int out_param);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="pos" Type="System.String" />
|
|
<Parameter Name="out_param" Type="System.Int32&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Scans a string looking for an integer. An integer consists of up to 31 decimal digits.</summary>
|
|
<param name="pos">a <see cref="T:System.String" />, a string to scan.</param>
|
|
<param name="out_param">a <see cref="T:System.Int32&" />, an integer to put the result into.</param>
|
|
<returns>a <see cref="T:System.Boolean" />, false if a parse error occurred.</returns>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |