GtkSharp/doc/en/Rsvg/Tool.xml
Mike Kestner 0e47e78f96 update docs to 2.8 API and document all new members
svn path=/trunk/gtk-sharp/; revision=54175
2005-12-09 23:12:49 +00:00

168 lines
6.2 KiB
XML

<Type Name="Tool" FullName="Rsvg.Tool">
<TypeSignature Language="C#" Value="public class Tool" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>rsvg-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>
<example>
<code lang="C#">
using System;
using Gtk;
class SvgHelloWorld
{
static void Main (string[] args)
{
Application.Init ();
MyMainWindow app = new MyMainWindow ();
app.ShowAll ();
Application.Run ();
}
}
class MyMainWindow : Gtk.Window
{
public MyMainWindow () : base ("SVG Hello World")
{
this.DeleteEvent += new DeleteEventHandler (delete_event);
string svg_file_name = "sample.svg";
Gdk.Pixbuf pixbuf = Rsvg.Tool.PixbufFromFile (svg_file_name);
Image image = new Image ();
image.Pixbuf = pixbuf;
this.Add (image);
}
private void delete_event (object obj, DeleteEventArgs args)
{
Application.Quit ();
}
}
</code>
</example>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName="PixbufFromFileAtZoomWithMaxSize">
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf PixbufFromFileAtZoomWithMaxSize (string file_name, double x_zoom, double y_zoom, int max_width, int max_height);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="file_name" Type="System.String" />
<Parameter Name="x_zoom" Type="System.Double" />
<Parameter Name="y_zoom" Type="System.Double" />
<Parameter Name="max_width" Type="System.Int32" />
<Parameter Name="max_height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="file_name">a <see cref="T:System.String" /></param>
<param name="x_zoom">a <see cref="T:System.Double" /></param>
<param name="y_zoom">a <see cref="T:System.Double" /></param>
<param name="max_width">a <see cref="T:System.Int32" /></param>
<param name="max_height">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="PixbufFromFileAtMaxSize">
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf PixbufFromFileAtMaxSize (string file_name, int max_width, int max_height);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="file_name" Type="System.String" />
<Parameter Name="max_width" Type="System.Int32" />
<Parameter Name="max_height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="file_name">a <see cref="T:System.String" /></param>
<param name="max_width">a <see cref="T:System.Int32" /></param>
<param name="max_height">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="PixbufFromFileAtSize">
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf PixbufFromFileAtSize (string file_name, int width, int height);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="file_name" Type="System.String" />
<Parameter Name="width" Type="System.Int32" />
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="file_name">a <see cref="T:System.String" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="PixbufFromFileAtZoom">
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf PixbufFromFileAtZoom (string file_name, double x_zoom, double y_zoom);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="file_name" Type="System.String" />
<Parameter Name="x_zoom" Type="System.Double" />
<Parameter Name="y_zoom" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="file_name">a <see cref="T:System.String" /></param>
<param name="x_zoom">a <see cref="T:System.Double" /></param>
<param name="y_zoom">a <see cref="T:System.Double" /></param>
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="PixbufFromFile">
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf PixbufFromFile (string file_name);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="file_name" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="file_name">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Tool ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<remarks>Should never be used.</remarks>
</Docs>
</Member>
</Members>
</Type>