412 lines
17 KiB
XML
412 lines
17 KiB
XML
<Type Name="PrintJob" FullName="Gtk.PrintJob">
|
|
<TypeSignature Language="C#" Value="public class PrintJob : GLib.Object" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PrintJob extends GLib.Object" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>gtk-sharp</AssemblyName>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>GLib.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<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>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public PrintJob (IntPtr raw);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" />
|
|
<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);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string title, class Gtk.Printer printer, class Gtk.PrintSettings settings, class Gtk.PageSetup page_setup) cil managed" />
|
|
<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="Collate">
|
|
<MemberSignature Language="C#" Value="public bool Collate { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool Collate" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version="Gtk# 3.0" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetPageRanges">
|
|
<MemberSignature Language="C#" Value="public Gtk.PageRange GetPageRanges (out int n_ranges);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Gtk.PageRange GetPageRanges(int32 n_ranges) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.PageRange</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="n_ranges" Type="System.Int32&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="n_ranges">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
<since version="Gtk# 3.0" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetSurface">
|
|
<MemberSignature Language="C#" Value="public Cairo.Surface GetSurface ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Cairo.Surface GetSurface() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Cairo.Surface</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
<since version="Gtk# 3.0" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GType">
|
|
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property valuetype GLib.GType GType" />
|
|
<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="NumCopies">
|
|
<MemberSignature Language="C#" Value="public int NumCopies { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 NumCopies" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version="Gtk# 3.0" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="NUp">
|
|
<MemberSignature Language="C#" Value="public uint NUp { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance unsigned int32 NUp" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.UInt32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version="Gtk# 3.0" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="NUpLayout">
|
|
<MemberSignature Language="C#" Value="public Gtk.NumberUpLayout NUpLayout { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype Gtk.NumberUpLayout NUpLayout" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.NumberUpLayout</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version="Gtk# 3.0" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnStatusChanged">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnStatusChanged ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnStatusChanged() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideStatusChanged", Type=typeof(Gtk.PrintJob))</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<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="Pages">
|
|
<MemberSignature Language="C#" Value="public Gtk.PrintPages Pages { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype Gtk.PrintPages Pages" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.PrintPages</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version="Gtk# 3.0" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PageSet">
|
|
<MemberSignature Language="C#" Value="public Gtk.PageSet PageSet { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype Gtk.PageSet PageSet" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.PageSet</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version="Gtk# 3.0" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PageSetup">
|
|
<MemberSignature Language="C#" Value="public Gtk.PageSetup PageSetup { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class Gtk.PageSetup PageSetup" />
|
|
<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; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class Gtk.Printer Printer" />
|
|
<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="Reverse">
|
|
<MemberSignature Language="C#" Value="public bool Reverse { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool Reverse" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version="Gtk# 3.0" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Rotate">
|
|
<MemberSignature Language="C#" Value="public bool Rotate { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool Rotate" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version="Gtk# 3.0" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Scale">
|
|
<MemberSignature Language="C#" Value="public double Scale { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance float64 Scale" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Double</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version="Gtk# 3.0" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Send">
|
|
<MemberSignature Language="C#" Value="public void Send (Gtk.PrintJobCompleteFunc cb);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Send(class Gtk.PrintJobCompleteFunc cb) cil managed" />
|
|
<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="SetPageRanges">
|
|
<MemberSignature Language="C#" Value="public void SetPageRanges (Gtk.PageRange ranges, int n_ranges);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetPageRanges(valuetype Gtk.PageRange ranges, int32 n_ranges) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="ranges" Type="Gtk.PageRange" />
|
|
<Parameter Name="n_ranges" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="ranges">To be added.</param>
|
|
<param name="n_ranges">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
<since version="Gtk# 3.0" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetSourceFile">
|
|
<MemberSignature Language="C#" Value="public bool SetSourceFile (string filename);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetSourceFile(string filename) cil managed" />
|
|
<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; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class Gtk.PrintSettings Settings" />
|
|
<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; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype Gtk.PrintStatus Status" />
|
|
<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;" />
|
|
<MemberSignature Language="ILAsm" Value=".event class System.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; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string Title" />
|
|
<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 { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool TrackPrintStatus" />
|
|
<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>
|
|
</Type>
|