GtkSharp/doc/en/Pango/Item.xml
Dan Winship 622c360576 * parser/gapi2xml.pl (addFuncElems): if a struct or boxed type has
a constructor or a ref, unref, or destroy method, then it must be
	a reference type, so mark it "opaque" but then also mark all of
	its fields public and writable.

	* */*-api*.raw: Regen

	* generator/Parser.cs (ParseNamespace): make the opaque attribute
	check actually look at the value of the attribute rather than just
	checking if it's there, so that you can change a struct's opaque
	attribute from "true" to "false" via metadata and have that work.

	* generator/BoxedGen.cs (Generate): do not generate the boxed's
	"Free" method (since it's guaranteed to crash when we pass it a
	stack pointer). If "Copy" is marked deprecated, create a
	deprecated no-op for it, otherwise just skip it (since otherwise
	it will just leak memory when we copy its result onto the stack).

	* pango/Pango.metadata: deprecate Pango.Color.Copy and
	Pango.Matrix.Copy. Hide some array fields in Pango.GlyphString
	that we've never generated correctly. Tweak Pango.LayoutLine
	fields to be the same as they used to be.

	* pango/GlyphItem.custom (glyphs, item):
	* pango/GlyphString.custom (Zero, New):
	* pango/Item.custom (Zero, New):
	* pango/LayoutRun.custom (glyphs, item): add deprecated API compat

	* gdk/Gdk.metadata: undo the parser's new opaquification of
	Gdk.Font; it's been deprecated since pre-gtk# times, and no one
	should be using it, so there's no point in fixing it now. Fix up a
	few other things to match how they used to be. Fix RgbCmap's
	constructor args.

	* gdk/RgbCmap.custom (Zero, New): deprecated API compat

	* gdk/PangoAttrEmbossed.custom:
	* gdk/PangoAttrStipple.custom (Zero, New, Attr): deprecated API
	compat
	(explicit operator ...): allow casting back and forth between
	Pango.Attribute. (We can't usefully make them real subclasses of
	Pango.Attribute, because there's no way for
	Pango.Attribute.GetAttribute() to be able to dtrt with them.)

	* gtk/Gtk.metadata: deprecate Gtk.Requisition.Copy,
	Gtk.TextIter.Copy, and Gtk.TreeIter.Copy. Mark the return value of
	TextView.DefaultAttributes as "owned". Mark TargetList's fields
	private so it stays how it used to be.

	* gtk/TextAttributes.custom (Zero, New): deprecated API compat

	* gnomevfs/Gnomevfs.metadata: remove a bunch of opaque
	declarations that the parser figures out on its own now.

	* art/Art.metadata:
	* glade/Glade.metadata:
	* rsvg/Rsvg.metadata: un-mark everything the parser marked opaque
	in these libraries, because all of the structs in question would
	still be unusably broken, so the API churn would be pointless.

svn path=/trunk/gtk-sharp/; revision=48387
2005-08-15 15:15:57 +00:00

167 lines
6.9 KiB
XML

<Type Name="Item" FullName="Pango.Item">
<TypeSignature Language="C#" Maintainer="auto" Value="public class Item : GLib.Opaque" />
<AssemblyInfo>
<AssemblyName>pango-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.6.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>Stores information about a segment of text.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName="Zero">
<MemberSignature Language="C#" Value="public static Pango.Item Zero;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Pango.Item</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns an empty <see cref="T:Pango.Item" /></summary>
<remarks />
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message="Pango.Item is a reference type now, use null", IsError=False)</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Item ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<summary>Creates a new Item</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Pango.Item New ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Item</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Obsolete: replaced by ordinary constructor</summary>
<returns>a new <see cref="T:Pango.Item" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Item (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal method.</summary>
<param name="raw">an object of type <see cref="T:System.IntPtr" /></param>
<remarks>This is an internal method, and should not be used by user code.</remarks>
</Docs>
</Member>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Pango.Item New (IntPtr raw);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Item</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Obsolete internal constructor</summary>
<param name="raw">an object of type <see cref="T:System.IntPtr" /></param>
<returns>an object of type <see cref="T:Pango.Item" /></returns>
<remarks>This is an internal method, and should not be used by user code.</remarks>
</Docs>
</Member>
<Member MemberName="Copy">
<MemberSignature Language="C#" Value="public Pango.Item Copy ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Item</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Copy an existing <see cref="T:Pango.Item" /> structure.</summary>
<returns>a new <see cref="T:Pango.Item" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Split">
<MemberSignature Language="C#" Value="public Pango.Item Split (int split_index, int split_offset);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Item</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="split_index" Type="System.Int32" />
<Parameter Name="split_offset" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Modifies orig to cover only the text after <paramref name="split_index" />, and returns a new item that covers the text before <paramref name="split_index" /> that used to be in orig.</summary>
<param name="split_index"> byte index of position to split item, relative to the start of the item</param>
<param name="split_offset"> number of chars between start of orig and <paramref name="split_index" /></param>
<returns> new item representing text before <paramref name="split_index" /></returns>
<remarks>You can think of <paramref name="split_index" /> as the length of the returned item. <paramref name="split_index" /> may not be 0, and it may not be greater than or equal to the length of orig (that is, there must be at least one byte assigned to each item, you cannot create a zero-length item). <paramref name="split_offset" /> is the length of the first item in chars, and must be provided because the text used to generate the item is not available, so <see cref="M:Pango.Item.Split()" /> cannot count the char length of the split items itself.</remarks>
</Docs>
</Member>
<Member MemberName="Offset">
<MemberSignature Language="C#" Value="public int Offset { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>the offset of the segment from the beginning of the string in bytes.</summary>
<value>the offset of the segment from the beginning of the string in bytes.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="Length">
<MemberSignature Language="C#" Value="public int Length { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>the length of the segment in bytes.</summary>
<value>the length of the segment in bytes.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="NumChars">
<MemberSignature Language="C#" Value="public int NumChars { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>the length of the segment in characters.</summary>
<value>the length of the segment in characters.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="Analysis">
<MemberSignature Language="C#" Value="public Pango.Analysis Analysis { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.Analysis</ReturnType>
</ReturnValue>
<Docs>
<summary>the properties of the segment.</summary>
<value>the properties of the segment.</value>
<remarks />
</Docs>
</Member>
</Members>
</Type>