233 lines
9.7 KiB
XML
233 lines
9.7 KiB
XML
<Type Name="PrintJob" FullName="Gtk.PrintJob">
|
|
<TypeSignature Language="C#" Value="public class PrintJob : GLib.Object" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>gtk-sharp</AssemblyName>
|
|
<AssemblyVersion>2.10.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>GLib.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected PrintJob (GLib.GType gtype);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.Obsolete</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<Parameters>
|
|
<Parameter Name="gtype" Type="GLib.GType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="gtype">Native type value.</param>
|
|
<summary>Obsolete Protected Constructor.</summary>
|
|
<remarks>Do not use. Replaced by <see cref="M:GLib.Object.CreateNativeObject" /> which registers native types automatically. Subclasses should chain to the IntPtr constructor passing <see cref="M:System.IntPtr.Zero" /> and call CreateNativeObject instead of using this constructor. This constructor is provided for backward compatibility if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public PrintJob (IntPtr raw);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="raw" Type="System.IntPtr" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="raw">Native object pointer.</param>
|
|
<summary>Internal constructor</summary>
|
|
<remarks>This is not typically used by C# code. Exposed primarily for use by language bindings to wrap native object instances.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public PrintJob (string title, Gtk.Printer printer, Gtk.PrintSettings settings, Gtk.PageSetup page_setup);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="title" Type="System.String" />
|
|
<Parameter Name="printer" Type="Gtk.Printer" />
|
|
<Parameter Name="settings" Type="Gtk.PrintSettings" />
|
|
<Parameter Name="page_setup" Type="Gtk.PageSetup" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="title">Job title.</param>
|
|
<param name="printer">Printer target.</param>
|
|
<param name="settings">Print settings.</param>
|
|
<param name="page_setup">Page setup.</param>
|
|
<summary>Public constructor.</summary>
|
|
<remarks>Instantiates a print job.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GType">
|
|
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>GLib.GType</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>GType Property.</summary>
|
|
<value>The native <see cref="T:GLib.GType" /> value.</value>
|
|
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.PrintJob" />.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnStatusChanged">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnStatusChanged ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.PrintJob.StatusChanged" /> event.</summary>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.PrintJob.StatusChanged" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PageSetup">
|
|
<MemberSignature Language="C#" Value="public Gtk.PageSetup PageSetup { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("page-setup")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.PageSetup</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>PageSetup property.</summary>
|
|
<value>A <see cref="T:Gtk.PageSetup" />.</value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Printer">
|
|
<MemberSignature Language="C#" Value="public Gtk.Printer Printer { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("printer")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.Printer</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Printer property.</summary>
|
|
<value>A <see cref="T:Gtk.Printer" />.</value>
|
|
<remarks>The printer associated with the job.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Send">
|
|
<MemberSignature Language="C#" Value="public void Send (Gtk.PrintJobCompleteFunc cb);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="cb" Type="Gtk.PrintJobCompleteFunc" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="cb">Completion callback delegate.</param>
|
|
<summary>Sends a job to a printer.</summary>
|
|
<remarks>When sending is complete, <paramref name="cb" /> is invoked.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetSourceFile">
|
|
<MemberSignature Language="C#" Value="public bool SetSourceFile (string filename);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="filename" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="filename">Print source file.</param>
|
|
<summary>SetSourceFile method.</summary>
|
|
<returns>If <see langword="false" />, an error occurred.</returns>
|
|
<remarks>Causes the print job to send an existing source document to the printer. Typically the file is in Postscript format, but on some platforms PDF may also be supported.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Settings">
|
|
<MemberSignature Language="C#" Value="public Gtk.PrintSettings Settings { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("settings")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.PrintSettings</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Settings property.</summary>
|
|
<value>The <see cref="T:Gtk.PrintSettings" /> for the job.</value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Status">
|
|
<MemberSignature Language="C#" Value="public Gtk.PrintStatus Status { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.PrintStatus</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Status property.</summary>
|
|
<value>a <see cref="T:Gtk.PrintStatus" />.</value>
|
|
<remarks>Indicates the current print status of the job.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="StatusChanged">
|
|
<MemberSignature Language="C#" Value="public event EventHandler StatusChanged;" />
|
|
<MemberType>Event</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal("status-changed")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>StatusChanged event.</summary>
|
|
<remarks>Reports changes in print status. Only raised if <see cref="M:Gtk.PrintJob.TrackPrintStatus" /> is <see langword="true" />. Use <see cref="M:Gtk.PrintJob.Status" /> to obtain the current status.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Title">
|
|
<MemberSignature Language="C#" Value="public string Title { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("title")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Title property.</summary>
|
|
<value>The job title string, or <see langword="null" /> if untitled.</value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="TrackPrintStatus">
|
|
<MemberSignature Language="C#" Value="public bool TrackPrintStatus { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("track-print-status")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>TrackPrintStatus property.</summary>
|
|
<value>If <see langword="true" />, the job raises events to report status.</value>
|
|
<remarks>Indicates if the job will raise <see cref="M:Gtk.PrintJob.StatusChanged" /> events to report print progress.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
<Docs>
|
|
<summary>Print job class.</summary>
|
|
<remarks>Represents a job sent to a printer. Direct use of this class is only necessary when using the non-portable <see cref="T:Gtk.PrintUnixDialog" /> API. The <see cref="M:Gtk.PrintJob.Surface" /> property accesses the cairo surface onto which the pages should be drawn. When finished drawing, call <see cref="M:Gtk.PrintJob.Send" /> to send the job to the printer.</remarks>
|
|
<since version="Gtk# 2.10" />
|
|
</Docs>
|
|
</Type>
|