2003-02-12 01:58:46 +00:00
<Type Name= "FontDescription" FullName= "Pango.FontDescription" >
2003-02-15 03:08:25 +00:00
<TypeSignature Language= "C#" Value= "public class FontDescription : GLib.Opaque, IWrapper" Maintainer= "auto" />
2003-02-12 01:58:46 +00:00
<AssemblyInfo >
<AssemblyName > pango-sharp</AssemblyName>
2003-12-24 01:35:30 +00:00
<AssemblyPublicKey >
</AssemblyPublicKey>
2003-02-12 01:58:46 +00:00
<AssemblyVersion > 0.0.0.0</AssemblyVersion>
2003-10-28 00:48:23 +00:00
<AssemblyCulture > neutral</AssemblyCulture>
2003-02-12 01:58:46 +00:00
<Attributes />
</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 01:58:46 +00:00
<Docs >
2004-06-18 17:57:09 +00:00
<summary > Represents the description of an ideal font.</summary>
<remarks > This class is used both to list what fonts are available on the system and also for specifying the characteristics of a font to load.</remarks>
2003-02-12 01:58:46 +00:00
</Docs>
<Base >
<BaseTypeName > GLib.Opaque</BaseTypeName>
</Base>
<Interfaces >
<Interface >
<InterfaceName > GLib.IWrapper</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members >
<Member MemberName= "FromString" >
<MemberSignature Language= "C#" Value= "public static Pango.FontDescription FromString (string str);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Pango.FontDescription</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "str" Type= "System.String" />
</Parameters>
2003-02-12 01:58:46 +00:00
<Docs >
2004-05-10 17:26:50 +00:00
<summary > Creates a new font description from a string representation.</summary>
2004-06-18 17:57:09 +00:00
<param name= "str" > The string representation of the font description.</param>
2004-05-10 17:26:50 +00:00
<returns > The object of type <see cref= "T:Pango.FontDescription" /> created.</returns>
<remarks > The form of the string representation is "[FAMILY-LIST] [STYLE-OPTIONS] [SIZE]", where:
<list type= "bullet" >
<item >
<term > FAMILY-LIST is a comma separated list of families optionally terminated by a comma.</term>
</item>
<item >
<term > STYLE-OPTIONS is a whitespace separated list of words where each WORD describes one of style, variant, weight, or stretch.</term>
</item>
<item >
<term > SIZE is a decimal number (size in points)</term>
</item>
</list> <para >
Any one of the options may be absent. If FAMILY-LIST is absent, then the family_name field of the resulting font description will be initialized to NULL. If STYLE-OPTIONS is missing, then all style options will be set to the default values. If SIZE is missing, the size in the resulting font description will be set to 0.
</para> </remarks>
2003-02-12 01:58:46 +00:00
</Docs>
</Member>
<Member MemberName= "Copy" >
<MemberSignature Language= "C#" Value= "public Pango.FontDescription Copy ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Pango.FontDescription</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > To be added</summary>
<returns > To be added: an object of type 'Pango.FontDescription'</returns>
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "BetterMatch" >
<MemberSignature Language= "C#" Value= "public bool BetterMatch (Pango.FontDescription old_match, Pango.FontDescription new_match);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "old_match" Type= "Pango.FontDescription" />
<Parameter Name= "new_match" Type= "Pango.FontDescription" />
</Parameters>
2003-02-12 01:58:46 +00:00
<Docs >
2004-06-18 17:57:09 +00:00
<summary > Determines which <see cref= "T:Pango.FontDescription" /> better matches the current instance.</summary>
2003-02-12 01:58:46 +00:00
<param name= "old_match" > To be added: an object of type 'Pango.FontDescription'</param>
<param name= "new_match" > To be added: an object of type 'Pango.FontDescription'</param>
2004-06-18 17:57:09 +00:00
<returns >
<see langword= "true" /> if new_match is a better match.</returns>
<remarks > Determines if the style attributes of new_match are a closer match for the current instance than old_match, or if old_match is <see langword= "null" /> , determines if new_match is a match at all. Approximate matching is done for weight and style; other attributes must match exactly.</remarks>
2003-02-12 01:58:46 +00:00
</Docs>
</Member>
<Member MemberName= "Free" >
<MemberSignature Language= "C#" Value= "public void Free ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > To be added</summary>
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "MergeStatic" >
<MemberSignature Language= "C#" Value= "public void MergeStatic (Pango.FontDescription desc_to_merge, bool replace_existing);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "desc_to_merge" Type= "Pango.FontDescription" />
<Parameter Name= "replace_existing" Type= "System.Boolean" />
</Parameters>
2003-02-12 01:58:46 +00:00
<Docs >
2004-06-18 17:57:09 +00:00
<summary > Merges the fields of a font description into the current instance without copying the field data (shallow copy).</summary>
2003-02-12 01:58:46 +00:00
<param name= "desc_to_merge" > To be added: an object of type 'Pango.FontDescription'</param>
<param name= "replace_existing" > To be added: an object of type 'bool'</param>
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "ToFilename" >
<MemberSignature Language= "C#" Value= "public string ToFilename ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-06-18 17:57:09 +00:00
<summary > Creates a filename representation of a font description.</summary>
2003-02-12 01:58:46 +00:00
<returns > To be added: an object of type 'string'</returns>
2004-06-18 17:57:09 +00:00
<remarks > The filename created is identical to the result from calling <see cref= "M:Pango.FontDescription.ToString" /> , but with underscores instead of characters that are untypical in filenames, and in lower case only.</remarks>
2003-02-12 01:58:46 +00:00
</Docs>
</Member>
<Member MemberName= "Merge" >
<MemberSignature Language= "C#" Value= "public void Merge (Pango.FontDescription desc_to_merge, bool replace_existing);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "desc_to_merge" Type= "Pango.FontDescription" />
<Parameter Name= "replace_existing" Type= "System.Boolean" />
</Parameters>
2003-02-12 01:58:46 +00:00
<Docs >
2004-06-18 17:57:09 +00:00
<summary > Merges the fields of a font description into the current instance.</summary>
<param name= "desc_to_merge" > The <see cref= "T:Pango.FontDescription" /> to merge from.</param>
<param name= "replace_existing" > If <see langword= "true" /> , replace fields in current instance with the corresponding values from desc_to_merge, even if they are already exist.</param>
2003-02-12 01:58:46 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "CopyStatic" >
<MemberSignature Language= "C#" Value= "public Pango.FontDescription CopyStatic ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Pango.FontDescription</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > To be added</summary>
<returns > To be added: an object of type 'Pango.FontDescription'</returns>
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "Equal" >
<MemberSignature Language= "C#" Value= "public bool Equal (Pango.FontDescription desc2);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "desc2" Type= "Pango.FontDescription" />
</Parameters>
2003-02-12 01:58:46 +00:00
<Docs >
<summary > To be added</summary>
<param name= "desc2" > To be added: an object of type 'Pango.FontDescription'</param>
<returns > To be added: an object of type 'bool'</returns>
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "UnsetFields" >
<MemberSignature Language= "C#" Value= "public void UnsetFields (Pango.FontMask to_unset);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "to_unset" Type= "Pango.FontMask" />
</Parameters>
2003-02-12 01:58:46 +00:00
<Docs >
2004-06-18 17:57:09 +00:00
<summary > Unsets some of the fields in the <see cref= "T:Pango.FontDescription" /> .</summary>
2003-02-12 01:58:46 +00:00
<param name= "to_unset" > To be added: an object of type 'Pango.FontMask'</param>
2004-06-18 17:57:09 +00:00
<remarks > This merely marks the fields cleared, it does not clear the settings for those fields. To clear a family name set with <see cref= "P:Pango.FontDescription.FamilyStatic" /> so that it won't be returned by <see cref= "P:Pango.FontDescription.Family" /> , you must actually set <see cref= "P:Pango.FontDescription.Family" /> to <see langword= "null" /> .</remarks>
2003-02-12 01:58:46 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public FontDescription (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 01:58:46 +00:00
<Docs >
2003-02-23 07:26:30 +00:00
<summary > Internal constructor</summary>
<param name= "raw" > Pointer to the C object.</param>
<returns > An instance of FontDescription, wrapping the C object.</returns>
<remarks >
<para > This is an internal constructor, and should not be used by user code.</para>
</remarks>
2003-02-12 01:58:46 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public FontDescription ();" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs >
<summary > To be added</summary>
<returns > To be added: an object of type 'Pango.FontDescription'</returns>
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "Style" >
<MemberSignature Language= "C#" Value= "public Pango.Style Style { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Pango.Style</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 01:58:46 +00:00
<Docs >
2004-06-18 17:57:09 +00:00
<summary > The style of the font.</summary>
2003-02-12 01:58:46 +00:00
<param name= "value" > To be added: an object of type 'Pango.Style'</param>
<returns > To be added: an object of type 'Pango.Style'</returns>
2004-06-18 17:57:09 +00:00
<remarks > Most fonts will either have a italic style or an oblique style, but not both, and font matching in Pango will match italic specifications with oblique fonts and vice-versa if an exact match is not found.</remarks>
2003-02-12 01:58:46 +00:00
</Docs>
</Member>
<Member MemberName= "Stretch" >
<MemberSignature Language= "C#" Value= "public Pango.Stretch Stretch { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Pango.Stretch</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 01:58:46 +00:00
<Docs >
2004-06-18 17:57:09 +00:00
<summary > The stretch of the font.</summary>
2003-02-12 01:58:46 +00:00
<param name= "value" > To be added: an object of type 'Pango.Stretch'</param>
<returns > To be added: an object of type 'Pango.Stretch'</returns>
2004-06-18 17:57:09 +00:00
<remarks > The stretch property specifies how narrow or wide the font should be.</remarks>
2003-02-12 01:58:46 +00:00
</Docs>
</Member>
<Member MemberName= "SetFields" >
<MemberSignature Language= "C#" Value= "public Pango.FontMask SetFields { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Pango.FontMask</ReturnType>
</ReturnValue>
<Docs >
2004-06-18 17:57:09 +00:00
<summary > Determines which fields in the font description have been set.</summary>
2003-02-12 01:58:46 +00:00
<returns > To be added: an object of type 'Pango.FontMask'</returns>
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "Size" >
<MemberSignature Language= "C#" Value= "public int Size { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 01:58:46 +00:00
<Docs >
2004-06-18 17:57:09 +00:00
<summary > The size of the font in pango units.</summary>
2003-02-12 01:58:46 +00:00
<param name= "value" > To be added: an object of type 'int'</param>
<returns > To be added: an object of type 'int'</returns>
2004-06-18 17:57:09 +00:00
<remarks > There are <see cref= "F:Pango.Scale.PangoScale" /> pango units in one device unit - for fonts, font points are the device unit. Therefore, the size of the font in points is <see cref= "P:Pango.FontDescription.Size" /> / <see cref= "F:Pango.Scale.PangoScale" /> .</remarks>
2003-02-12 01:58:46 +00:00
</Docs>
</Member>
<Member MemberName= "FamilyStatic" >
<MemberSignature Language= "C#" Value= "public string FamilyStatic { set; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.String</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 01:58:46 +00:00
<Docs >
2004-06-18 17:57:09 +00:00
<summary > Sets the family name of the font without copying the string.</summary>
2003-02-12 01:58:46 +00:00
<param name= "value" > To be added: an object of type 'string'</param>
<returns > To be added: an object of type 'string'</returns>
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "Variant" >
<MemberSignature Language= "C#" Value= "public Pango.Variant Variant { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Pango.Variant</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 01:58:46 +00:00
<Docs >
2004-06-18 17:57:09 +00:00
<summary > The variant of the font.</summary>
2003-02-12 01:58:46 +00:00
<param name= "value" > To be added: an object of type 'Pango.Variant'</param>
<returns > To be added: an object of type 'Pango.Variant'</returns>
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "Weight" >
<MemberSignature Language= "C#" Value= "public Pango.Weight Weight { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Pango.Weight</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 01:58:46 +00:00
<Docs >
2004-06-18 17:57:09 +00:00
<summary > The weight (boldness) of the font.</summary>
2003-02-12 01:58:46 +00:00
<param name= "value" > To be added: an object of type 'Pango.Weight'</param>
<returns > To be added: an object of type 'Pango.Weight'</returns>
2004-06-18 17:57:09 +00:00
<remarks > The weight property specifies how bold or light the font should be. In addition to the values of the <see cref= "T:Pango.Weight" /> enumeration, other intermediate numeric values are possible.</remarks>
2003-02-12 01:58:46 +00:00
</Docs>
</Member>
<Member MemberName= "Family" >
<MemberSignature Language= "C#" Value= "public string Family { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.String</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 01:58:46 +00:00
<Docs >
2004-06-18 17:57:09 +00:00
<summary > The family name of the font.</summary>
2003-02-12 01:58:46 +00:00
<param name= "value" > To be added: an object of type 'string'</param>
<returns > To be added: an object of type 'string'</returns>
2004-06-18 17:57:09 +00:00
<remarks > The family name represents a family of related font styles, and will resolve to a particular <see cref= "T:Pango.FontFamily" /> . In some uses of <see cref= "T:Pango.FontDescription" /> , it is also possible to use a comma separated list of family names for this property.</remarks>
2003-02-12 01:58:46 +00:00
</Docs>
</Member>
2003-10-28 00:48:23 +00:00
<Member MemberName= "ToString" >
<MemberSignature Language= "C#" Value= "public override string ToString ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-05-10 17:26:50 +00:00
<summary > Creates a string representation of a font description.</summary>
2003-10-28 00:48:23 +00:00
<returns > a <see cref= "T:System.String" /> </returns>
2004-05-10 17:26:50 +00:00
<remarks > See <see cref= "M:Pango.FontDescription.FromString()" /> for a description of the format of the string representation. The family list in the string description will only have a terminating comma if the last word of the list is a valid style option.</remarks>
2003-10-28 00:48:23 +00:00
</Docs>
</Member>
2003-11-05 04:30:47 +00:00
<Member MemberName= "Hash" >
<MemberSignature Language= "C#" Value= "public uint Hash { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > To be added</summary>
<returns > a <see cref= "T:System.UInt32" /> </returns>
<remarks > To be added</remarks>
</Docs>
</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>
2003-12-24 01:35:30 +00:00
<returns > a <see cref= "T:GLib.GType" /> </returns>
2004-06-21 20:14:42 +00:00
<remarks > Returns the native <see cref= "T:GLib.GType" /> value for <see cref= "T:Pango.FontDescription" /> .</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
2003-02-12 01:58:46 +00:00
</Members>
2003-09-17 21:56:59 +00:00
</Type>
