422 lines
13 KiB
Plaintext
422 lines
13 KiB
Plaintext
<!-- $XConsortium: DtPrint.sgm /main/2 1996/10/28 13:39:32 cdedoc $ -->
|
|
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
|
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
|
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
|
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
|
<!-- (c) Copyright 1995 Novell, Inc. -->
|
|
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
|
<!-- (c) Copyright 1995 Hitachi. -->
|
|
|
|
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.dtprint">]]>
|
|
<![ %CDE.C.XO; [<RefEntry Id="XCSA.dtprint">]]>
|
|
<RefMeta>
|
|
<RefEntryTitle>Dt/Print.h</RefEntryTitle>
|
|
<ManVolNum>file formats</ManVolNum>
|
|
</RefMeta>
|
|
<RefNameDiv>
|
|
<RefName><Filename>Dt/Print.h</Filename></RefName>
|
|
<RefPurpose>print definitions
|
|
</RefPurpose>
|
|
</RefNameDiv>
|
|
<!-- CDE Common Source Format, Version 1.0.0-->
|
|
<!-- *************************************************************************-->
|
|
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
|
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
|
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
|
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
|
<!-- *************************************************************************-->
|
|
<RefSynopsisDiv>
|
|
<Synopsis>#include <Dt/Print.h>
|
|
</Synopsis>
|
|
</RefSynopsisDiv>
|
|
<RefSect1>
|
|
<Title>DESCRIPTION</Title>
|
|
<Para>The
|
|
<Filename Role="Header">Dt/Print.h</Filename> header defines resource names, resource values,
|
|
callback reasons, callback structures, and function prototypes for
|
|
the Print widget class.
|
|
</Para>
|
|
<para>
|
|
The <Filename Role="Header">Dt/Print.h</Filename> header defines
|
|
the following resource names:
|
|
</para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>DtNcancelCallback</term>
|
|
<listitem><para>cancelCallback</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtNclosePrintDisplayCallback</term>
|
|
<listitem><para>closePrintDisplayCallback</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtNcopies</term>
|
|
<listitem><para>copies</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtNdescription</term>
|
|
<listitem><para>description</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtNdestroyContextCallback</term>
|
|
<listitem><para>destroyContextCallback</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtNfileName</term>
|
|
<listitem><para>fileName</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtNminimizeButtons</term>
|
|
<listitem><para>minimizeButtons (if not otherwise named)</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtNoptionCount</term>
|
|
<listitem><para>optionCount</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtNoptions</term>
|
|
<listitem><para>options</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtNprintCallback</term>
|
|
<listitem><para>printCallback</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtNprintDestination</term>
|
|
<listitem><para>printDestination</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtNprinterInfoProc</term>
|
|
<listitem><para>printerInfoProc</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtNprinterName</term>
|
|
<listitem><para>printerName</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtNprintSetupMode</term>
|
|
<listitem><para>printSetupMode</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtNselectFileProc</term>
|
|
<listitem><para>selectFileProc</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtNselectPrinterProc</term>
|
|
<listitem><para>selectPrinterProc</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtNsetupCallback</term>
|
|
<listitem><para>setupCallback</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtNverifyPrinterProc</term>
|
|
<listitem><para>verifyPrinterProc</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtNworkAreaLocation</term>
|
|
<listitem><para>workAreaLocation</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCCancelCallback</term>
|
|
<listitem><para>CancelCallback</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCClosePrintDisplayCallback</term>
|
|
<listitem><para>ClosePrintDisplayCallback</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCCopies</term>
|
|
<listitem><para>Copies</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCDescription</term>
|
|
<listitem><para>Description</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCDestroyContextCallback</term>
|
|
<listitem><para>DestroyContextCallback</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCFileName</term>
|
|
<listitem><para>FileName</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCMinimizeButtons</term>
|
|
<listitem><para>MinimizeButtons (if not otherwise named)</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCOptionCount</term>
|
|
<listitem><para>OptionCount</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCOptions</term>
|
|
<listitem><para>Options</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCPrintCallback</term>
|
|
<listitem><para>PrintCallback</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCPrintDestination</term>
|
|
<listitem><para>PrintDestination</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCPrinterInfoProc</term>
|
|
<listitem><para>PrinterInfoProc</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCPrinterName</term>
|
|
<listitem><para>PrinterName</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCPrintSetupMode</term>
|
|
<listitem><para>PrintSetupMode</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCSelectFileProc</term>
|
|
<listitem><para>SelectFileProc</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term></term>
|
|
<listitem><para></para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCSelectPrinterProc</term>
|
|
<listitem><para>SelectPrinterProc</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCSetupCallback</term>
|
|
<listitem><para>SetupCallback</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCVerifyPrinterProc</term>
|
|
<listitem><para>VerifyPrinterProc</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtCWorkAreaLocation</term>
|
|
<listitem><para>WorkAreaLocation</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DtRPrintSetupProc</term>
|
|
<listitem><para>PrintSetupProc</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<para>
|
|
The <Filename Role="Header">Dt/Print.h</Filename> header declares the following values for the
|
|
<systemitem class="resource">DtNsetupMode</systemitem> resource:
|
|
</para>
|
|
<programlisting>
|
|
<systemitem class="constant">DtPRINT_SETUP_PLAIN</systemitem>
|
|
<systemitem class="constant">DtPRINT_SETUP_XP</systemitem>
|
|
</programlisting>
|
|
<para>
|
|
The <Filename Role="Header">Dt/Print.h</Filename> header declares the following values for the
|
|
<systemitem class="resource">DtNworkAreaLocation</systemitem> resource:
|
|
</para>
|
|
<programlisting>
|
|
<systemitem class="constant">DtWORK_AREA_NONE</systemitem>
|
|
<systemitem class="constant">DtWORK_AREA_TOP</systemitem>
|
|
<systemitem class="constant">DtWORK_AREA_TOP_AND_BOTTOM</systemitem>
|
|
<systemitem class="constant">DtWORK_AREA_BOTTOM</systemitem>
|
|
</programlisting>
|
|
<para>
|
|
The <Filename Role="Header">Dt/Print.h</Filename> header declares the following values for the
|
|
<systemitem class="resource">DtNprintDestination</systemitem> resource:
|
|
</para>
|
|
<programlisting>
|
|
<systemitem class="constant">DtPRINT_NO_DESTINATION</systemitem>
|
|
<systemitem class="constant">DtPRINT_TO_PRINTER</systemitem>
|
|
<systemitem class="constant">DtPRINT_TO_FILE</systemitem>
|
|
</programlisting>
|
|
<para>
|
|
The <Filename Role="Header">Dt/Print.h</Filename> header declares the following values for the
|
|
<systemitem class="resource">DtNprinterNameMode</systemitem> resource:
|
|
</para>
|
|
<programlisting>
|
|
<systemitem class="constant">DtSHORT_NAME</systemitem>
|
|
<systemitem class="constant">DtMEDIUM_NAME</systemitem>
|
|
<systemitem class="constant">DtLONG_NAME</systemitem>
|
|
</programlisting>
|
|
<para>
|
|
The <Filename Role="Header">Dt/Print.h</Filename> header declares the following mode values for
|
|
<function>DtPrintSetupBoxResetConnection()</function>:
|
|
</para>
|
|
<programlisting>
|
|
typedef enum {
|
|
DtPRINT_CLOSE_CONNECTION,
|
|
DtPRINT_RELEASE_CONNECTION
|
|
} DtPrintResetConnectionMode;
|
|
</programlisting>
|
|
<para>
|
|
The <Filename Role="Header">Dt/Print.h</Filename> header declares the following
|
|
callback reasons:
|
|
</para>
|
|
<programlisting>
|
|
DtPRINT_CR_NONE
|
|
DtPRINT_CR_CANCEL
|
|
DtPRINT_CR_CLOSE_PRINT_DISPLAY
|
|
DtPRINT_CR_PRINT
|
|
DtPRINT_CR_SETUP
|
|
</programlisting>
|
|
<para>
|
|
The <Filename Role="Header">Dt/Print.h</Filename> header declares the following
|
|
return values for the <command>DtPrint</command> procedure:
|
|
</para>
|
|
<programlisting>
|
|
DtPRINT_SUCCESS,
|
|
DtPRINT_BAD_PARM,
|
|
DtPRINT_FAILURE,
|
|
DtPRINT_INVALID_DISPLAY,
|
|
DtPRINT_NOT_XP_DISPLAY,
|
|
DtPRINT_NO_CONNECTION,
|
|
DtPRINT_NO_DEFAULT,
|
|
DtPRINT_NO_DEFAULT_DISPLAY,
|
|
DtPRINT_NO_PRINTER,
|
|
DtPRINT_PRINTER_MISSING
|
|
</programlisting>
|
|
|
|
<variablelist>
|
|
<varlistentry><term><systemitem class="constant">DtPRINT_SUCCESS</systemitem></term>
|
|
<listitem>
|
|
<para>The X printer connection was successfully obtained.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><systemitem class="constant">DtPRINT_BAD_PARM</systemitem></term>
|
|
<listitem>
|
|
<para>The value passed for <symbol role="Variable">print_data</symbol>
|
|
is <symbol role="define">NULL</symbol>, or the value of the
|
|
<systemitem class="resource">DtNprintSetupMode</systemitem>
|
|
resource for <symbol role="Variable">wid</symbol> is not
|
|
<systemitem class="constant">DtPRINT_SETUP_XP</systemitem>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><systemitem class="constant">DtPRINT_FAILURE</systemitem></term>
|
|
<listitem>
|
|
<para>The X printer connection failed.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><systemitem class="constant">DtPRINT_INVALID_DISPLAY</systemitem></term>
|
|
<listitem>
|
|
<para>The indicated X print server could not be found.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><systemitem class="constant">DtPRINT_NOT_XP_DISPLAY</systemitem></term>
|
|
<listitem>
|
|
<para>The indicated X server does not support the X Printing Extension.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><systemitem class="constant">DtPRINT_NO_CONNECTION</systemitem></term>
|
|
<listitem>
|
|
<para>An open X print server connection is not currently being
|
|
managed by the <function>DtPrintSetupBox</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><systemitem class="constant">DtPRINT_NO_PRINTER</systemitem></term>
|
|
<listitem>
|
|
<para>The indicated printer could not be found on the X print server, or a
|
|
default printer could not be determined.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<para>
|
|
The <Filename Role="Header">Dt/Print.h</Filename> header declares the following class record
|
|
constants:
|
|
</para>
|
|
<programlisting>
|
|
WidgetClass dtPrintSetupBoxWidgetClass;
|
|
|
|
_DtPrintSetupBoxClassRec * DtPrintSetupBoxWidgetClass;
|
|
_DtPrintSetupBoxRec * DtPrintSetupBoxWidget;
|
|
</programlisting>
|
|
<Para>The header defines the following callback prototypes:
|
|
</Para>
|
|
<Synopsis>
|
|
typedef struct _DtPrintSetupData
|
|
{
|
|
String <Symbol Role="Variable">printer_name</Symbol>;
|
|
Display *<Symbol Role="Variable">print_display</Symbol>;
|
|
XPContext <Symbol Role="Variable">print_context</Symbol>;
|
|
XtEnum <Symbol Role="Variable">destination</Symbol>;
|
|
String <Symbol Role="Variable">dest_info</Symbol>;
|
|
} DtPrintSetupData;
|
|
</Synopsis>
|
|
|
|
<Synopsis>
|
|
typedef struct _DtPrintSetupCallbackStruct
|
|
{
|
|
int <Symbol Role="Variable">reason</Symbol>;
|
|
XEvent <Symbol Role="Variable">*event</Symbol>;
|
|
DtPrintSetupData <Symbol Role="Variable">*print_data</Symbol>;
|
|
} DtPrintSetupCallbackStruct;
|
|
</Synopsis>
|
|
<Para>The header defines the following functions:</Para>
|
|
<Synopsis>
|
|
Widget DtCreatePrintSetupBox(
|
|
Widget <Symbol Role="Variable">p</Symbol>,
|
|
String <Symbol Role="Variable">name</Symbol>,
|
|
ArgList <Symbol Role="Variable">args</Symbol>,
|
|
Cardinal <Symbol Role="Variable">n</Symbol>);
|
|
</Synopsis>
|
|
|
|
<Synopsis>
|
|
Widget DtCreatePrintSetupDialog(
|
|
Widget <Symbol Role="Variable">ds_p</Symbol>,
|
|
String <Symbol Role="Variable">name</Symbol>,
|
|
ArgList <Symbol Role="Variable">sb_args</Symbol>,
|
|
Cardinal <Symbol Role="Variable">sb_n)</Symbol>;
|
|
</Synopsis>
|
|
|
|
<Synopsis>
|
|
DtPrintSetupData* DtPrintCopySetupData(
|
|
DtPrintSetupData* <Symbol Role="Variable">target</Symbol>,
|
|
const DtPrintSetupData* <Symbol Role="Variable">source</Symbol>);
|
|
</Synopsis>
|
|
|
|
<Synopsis>
|
|
XtEnum DtPrintFillSetupData(
|
|
Widget <Symbol Role="Variable">psub</Symbol>,
|
|
DtPrintSetupData* <Symbol Role="Variable">print_data</Symbol>);
|
|
</Synopsis>
|
|
|
|
<Synopsis>
|
|
void DtPrintFreeSetupData(
|
|
DtPrintSetupData* <Symbol Role="Variable">target</Symbol>);
|
|
</Synopsis>
|
|
|
|
<Synopsis>
|
|
XtEnum DtPrintResetConnection(
|
|
Widget <Symbol Role="Variable">psub</Symbol>,
|
|
DtPrintResetConnectionMode <Symbol Role="Variable">m</Symbol>);
|
|
</Synopsis>
|
|
|
|
</RefSect1>
|
|
<![ %CDE.C.CDE; [
|
|
|
|
|
|
<RefSect1>
|
|
<Title>SEE ALSO</Title>
|
|
<Para>
|
|
&cdeman.DtCreatePrintSetupBox;,
|
|
&cdeman.DtCreatePrintSetupDialog;,
|
|
&cdeman.DtPrintCopySetupData;,
|
|
&cdeman.DtPrintFillSetupData;,
|
|
&cdeman.DtPrintFreeSetupData;,
|
|
&cdeman.DtPrintResetConnection;,
|
|
&cdeman.DtPrintSetupBox;,
|
|
&cdeman.Print;, and
|
|
&cdeman.dtprintinfo;.
|
|
</Para>
|
|
</RefSect1>
|
|
]]>
|
|
</RefEntry>
|
|
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
|
|