Main Page   Namespace List   Compound List   File List   Compound Members   File Members   Related Pages  

dfvifc.h

Go to the documentation of this file.
00001 /**
00002  * @file    dfvifc.h
00003  * @brief   SBC C++ Interface
00004  *
00005  * @author  Antenna House, Inc.
00006  *
00007  * Copyright (C) 2002-2013 Antenna House, Inc. All rights reserved.
00008  */
00009 
00010 #ifndef DFVIFC_H__
00011 #define DFVIFC_H__
00012 
00013 #ifndef __cplusplus
00014 #error  This is a header for C++ compiler.
00015 #endif
00016 
00017 #include <iostream>
00018 #include "dfvifc_c.h"   /* include common definitions */
00019 
00020 namespace DfvInterface {
00021 
00022 class DfvCppIfObject;
00023 
00024 /***************************************************************
00025  * Event class that returns the error information in the formatting process.
00026  */
00027 class DFVINTERFACE_API MessageListener
00028 {
00029 public:
00030     MessageListener() {}
00031     virtual ~MessageListener() {}
00032 
00033     /**
00034      * Event that returns the error information(error level, error code, error message) in the formatting process.
00035      *
00036      * errLevel     - Returns the errorlevel
00037      * errCode      - Returns the errorcode
00038      * errMessage   - Returns the errormessage
00039      */
00040     virtual void onMessage(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char* errMessage) {}
00041     virtual void onMessageW(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t* errMessage) {}
00042 
00043 #if !defined(_DOXYGEN) && defined(_MSC_VER)
00044  /* Please do not use following methods directly. */
00045  #ifdef _NATIVE_WCHAR_T_DEFINED
00046     virtual void onMessageW(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const unsigned short* errMessage) {}
00047  #else
00048     virtual void onMessageW(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const __wchar_t* errMessage) {}
00049  #endif
00050 #endif
00051 };
00052 
00053 /***************************************************************
00054  * Event class that returns the page number in the formatting process.
00055  */
00056 class DFVINTERFACE_API DfvFormatPageListener
00057 {
00058 public:
00059     DfvFormatPageListener() {}
00060     virtual ~DfvFormatPageListener() {}
00061 
00062     /**
00063      * Returns the formatted page number that occurred during the formatting process.
00064      * More than or equal to 1 : Page number when formatting finished.
00065      *  0 : All page formatting has finished.
00066      *
00067      * pageNo       - Returns the page number
00068      */
00069     virtual void onFormatPage(long pageNo) {}
00070 };
00071 
00072 /***************************************************************
00073  * Office Server Document Converter C++ Interface Object Class
00074  */
00075 class DFVINTERFACE_API DfvObj
00076 {
00077 private:
00078     DfvCppIfObject* m_pDfvObj;  /* instance of DfvObj */
00079 
00080 public:
00081     /**
00082      * Constructor
00083      */
00084     DfvObj();
00085 
00086     /**
00087      * Destructor
00088      */
00089     virtual ~DfvObj();
00090 
00091     /**
00092      * Get instance of DfvObj
00093      *
00094      * @return  pointer to DfvObj instance.
00095      */
00096     DfvCppIfObject* getDfvObj() const { return m_pDfvObj; }
00097 
00098     /**
00099      * Get the URL of document you will format.
00100      *
00101      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00102      *          the string is truncated and terminated with a NULL character.
00103      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00104      * @return  Returns the 'pVal'.
00105      */
00106     char* getDocumentURI(char* pVal, int size) const;
00107     /**
00108      * Get the URL of document you will format.
00109      *
00110      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00111      *          the string is truncated and terminated with a NULL character.
00112      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00113      * @return  Returns the 'pVal'.
00114      */
00115     wchar_t* getDocumentURIW(wchar_t* pVal, int size) const;
00116 
00117     /**
00118      * Specifies the URL of document you will format.
00119      * If it is omitted or "\@STDIN" is specified, document is loaded from stdin.
00120      * The document loaded from stdin are supposed to be FO files.
00121      *
00122      * @param   newVal  Pointer to a null-terminated string to be used as the URL of document.
00123      */
00124     void setDocumentURI(const char* newVal);
00125 
00126     /**
00127      * Specifies the URL of document you will format.
00128      * If it is omitted or "\@STDIN" is specified, document is loaded from stdin.
00129      * The document loaded from stdin are supposed to be FO files.
00130      *
00131      * @param   newVal  Pointer to a null-terminated string to be used as the URL of document.
00132      */
00133     void setDocumentURIW(const wchar_t* newVal);
00134 
00135     /**
00136      * Get the path name of the output file.
00137      *
00138      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00139      *          the string is truncated and terminated with a NULL character.
00140      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00141      * @return  Returns the 'pVal'.
00142      */
00143     char* getOutputFilePath(char* pVal, int size) const;
00144     /**
00145      * Get the path name of the output file.
00146      *
00147      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00148      *          the string is truncated and terminated with a NULL character.
00149      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00150      * @return  Returns the 'pVal'.
00151      */
00152     wchar_t* getOutputFilePathW(wchar_t* pVal, int size) const;
00153 
00154     /**
00155      * Specifies the path name of the output file. When "\@STDOUT" is specified, it is considered as stdout.
00156      * If both the printer name and this property are specified, the formatted result will be stored in
00157      * the file by the printer driver.
00158      * When "\@PDF" is specified as output, the PDF is stored in the file specified by this property.
00159      * If the property is not specified, it is considered as stdout.
00160      *
00161      * @param   newVal  Pointer to a null-terminated string to be used as the path name of the output file.
00162      */
00163     void setOutputFilePath(const char* newVal);
00164     /**
00165      * Specifies the path name of the output file. When "\@STDOUT" is specified, it is considered as stdout.
00166      * If both the printer name and this property are specified, the formatted result will be stored in
00167      * the file by the printer driver.
00168      * When "\@PDF" is specified as output, the PDF is stored in the file specified by this property.
00169      * If the property is not specified, it is considered as stdout.
00170      *
00171      * @param   newVal  Pointer to a null-terminated string to be used as the path name of the output file.
00172      */
00173     void setOutputFilePathW(const wchar_t* newVal);
00174 
00175     /**
00176      * Get the path name of format Option setting file which describes Office Server Document Converter options.
00177      *
00178      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00179      *          the string is truncated and terminated with a NULL character.
00180      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00181      * @param   n       Specifies to get n-th URI. 0 means first URI.
00182      * @return  Returns the 'pVal'.
00183      */
00184     char* getOptionFileURI(char* pVal, int size, int n=0) const;
00185     /**
00186      * Get the path name of format Option setting file which describes Office Server Document Converter options.
00187      *
00188      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00189      *          the string is truncated and terminated with a NULL character.
00190      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00191      * @param   n       Specifies to get n-th URI. 0 means first URI.
00192      * @return  Returns the 'pVal'.
00193      */
00194     wchar_t* getOptionFileURIW(wchar_t* pVal, int size, int n=0) const;
00195 
00196     /**
00197      * Specifies the path name of format Option setting file which describes Office Server Document Converter options.
00198      * The set of former URIs is thrown away.
00199      *
00200      * @param   newVal  Pointer to a null-terminated string to be used as the path name of format Option setting file.
00201      */
00202     void setOptionFileURI(const char* newVal);
00203     /**
00204      * Specifies the path name of format Option setting file which describes Office Server Document Converter options.
00205      * The set of former URIs is thrown away.
00206      *
00207      * @param   newVal  Pointer to a null-terminated string to be used as the path name of format Option setting file.
00208      */
00209     void setOptionFileURIW(const wchar_t* newVal);
00210 
00211     /**
00212      * Append the path name of format Option setting file which describes Office Server Document Converter options.
00213      * 
00214      *
00215      * @param   newVal  Pointer to a null-terminated string to be used as the path name of format Option setting file.
00216      */
00217     void addOptionFileURI(const char* newVal);
00218     /**
00219      * Append the path name of format Option setting file which describes Office Server Document Converter options.
00220      * 
00221      *
00222      * @param   newVal  Pointer to a null-terminated string to be used as the path name of format Option setting file.
00223      */
00224     void addOptionFileURIW(const wchar_t* newVal);
00225 
00226     /**
00227      * Get the number of URIs of format Option setting file which describes Office Server Document Converter options.
00228      * 
00229      *
00230      * @return  Returns the number of URIs.
00231      */
00232     int getOptionFileCount() const;
00233 
00234     /**
00235      * Get the start page number of document to output.
00236      *
00237      * @return  start page number of document to output.
00238      */
00239     long getStartPage() const;
00240 
00241     /**
00242      * Specifies the start page number of document to output.
00243      * If the start page is omitted or the specified value is 0 or less, the start page is
00244      * considered from the first page.
00245      * If the setting is inconsistent, (for example, StartPage=5 EndPage=3) an error occurs.
00246      *
00247      * @param   newVal  start page number of output.
00248      */
00249     void setStartPage(long newVal);
00250 
00251     /**
00252      * Get the end page number of document to output.
00253      *
00254      * @return  end page number of output.
00255      */
00256     long getEndPage() const;
00257 
00258     /**
00259      * Specifies the end page number of document to output.
00260      * If the end page is omitted or the specified value exceeds the actual page number, the end page
00261      * is considered as the last page.
00262      * If the setting is inconsistent, (for example, StartPage=5 EndPage=3) an error occurs.
00263      *
00264      * @param   newVal  end page number of output.
00265      */
00266     void setEndPage(long newVal);
00267 
00268     /**
00269      * Effective when outputting to PDF.
00270      * Specifies the owner password for PDF. The password must be within 32 bytes.
00271      * 
00272      *
00273      * @param   newVal  Pointer to a null-terminated string to be used as the owner password.
00274      */
00275     void setPdfOwnerPassword(const char* newVal);
00276 
00277     /**
00278      * Effective when outputting to PDF.
00279      * Specifies the owner password for PDF. The password must be within 32 bytes.
00280      * 
00281      *
00282      * @param   newVal  Pointer to a null-terminated string to be used as the owner password.
00283      */
00284     void setPdfOwnerPasswordW(const wchar_t* newVal);
00285 
00286     /**
00287      * Effective when outputting to PDF.
00288      * Specifies the user password for PDF. The password must be within 32 bytes.
00289      * 
00290      *
00291      * @param   newVal  Pointer to a null-terminated string to be used as the user password.
00292      */
00293     void setPdfUserPassword(const char* newVal);
00294 
00295     /**
00296      * Effective when outputting to PDF.
00297      * Specifies the user password for PDF. The password must be within 32 bytes.
00298      * 
00299      *
00300      * @param   newVal  Pointer to a null-terminated string to be used as the user password.
00301      */
00302     void setPdfUserPasswordW(const wchar_t* newVal);
00303 
00304     /**
00305      * Effective when outputting to PDF.
00306      * Disables printing the PDF file.
00307      * 
00308      *
00309      * @param   newVal  If nonezero is specified, Disables printing the PDF file.
00310      */
00311     void setPdfNoPrinting(long newVal);
00312 
00313     /**
00314      * Effective when outputting to PDF.
00315      * Get disables printing the PDF file.
00316      * 
00317      *
00318      * @return  If zero is returned, Enables printing the PDF file.
00319      *          If nonezero is returned, Disables printing the PDF file.
00320      */
00321     long getPdfNoPrinting() const;
00322 
00323     /**
00324      * Effective when outputting to PDF.
00325      * Disables making changes of the PDF file.
00326      * 
00327      *
00328      * @param   newVal  If nonezero is specified, Disables making changes of the PDF file.
00329      */
00330     void setPdfNoChanging(long newVal);
00331 
00332     /**
00333      * Effective when outputting to PDF.
00334      * Get disables making changes of the PDF file.
00335      * 
00336      *
00337      * @return  If zero is returned, Enables making changes of the PDF file.
00338      *          If nonezero is returned, Disables making changes of the PDF file.
00339      */
00340     long getPdfNoChanging() const;
00341 
00342     /**
00343      * Effective when outputting to PDF.
00344      * Disables copying the content of the PDF file.
00345      * 
00346      *
00347      * @param   newVal  If nonezero is specified, Disables copying the content of the PDF file.
00348      */
00349     void setPdfNoContentCopying(long newVal);
00350 
00351     /**
00352      * Effective when outputting to PDF.
00353      * Get disables copying the content of the PDF file.
00354      * 
00355      *
00356      * @return  If zero is returned, Enables copying the content of the PDF file.
00357      *          If nonezero is returned, Disables copying the content of the PDF file.
00358      */
00359     long getPdfNoContentCopying() const;
00360 
00361     /**
00362      * Effective when outputting to PDF.
00363      * Disables adding comments and form fields to the PDF file.
00364      * 
00365      *
00366      * @param   newVal  If nonezero is specified, Disables adding comments and form fields to the PDF file.
00367      */
00368     void setPdfNoAddingOrChangingCommnets(long newVal);
00369 
00370     /**
00371      * Effective when outputting to PDF.
00372      * Get disables adding comments and form fields to the PDF file.
00373      * 
00374      *
00375      * @return  If zero is returned, Enables adding comments and form fields to the PDF file.
00376      *          If nonezero is returned, Disables adding comments and form fields to the PDF file.
00377      */
00378     long getPdfNoAddingOrChangingCommnets() const;
00379 
00380     /**
00381      * Effective when outputting to PDF.
00382      * Disables adding comments and form fields to the PDF file.
00383      * 
00384      *
00385      * @param   newVal  If nonezero is specified, Disables adding comments and form fields to the PDF file.
00386      */
00387     void setPdfNoAddingOrChangingComments(long newVal);
00388 
00389     /**
00390      * Effective when outputting to PDF.
00391      * Get disables adding comments and form fields to the PDF file.
00392      * 
00393      *
00394      * @return  If zero is returned, Enables adding comments and form fields to the PDF file.
00395      *          If nonezero is returned, Disables adding comments and form fields to the PDF file.
00396      */
00397     long getPdfNoAddingOrChangingComments() const;
00398 
00399     /**
00400      * Effective when outputting to PDF.
00401      * Enables specifying whether the version of PDF is 1.3, 1.4 or 1.5.
00402      * 
00403      *
00404      * @param   newVal  Specifies the version of PDF.
00405      */
00406     void setPdfVersion(DfvPDFVERSION newVal);
00407 
00408     /**
00409      * Effective when outputting to PDF.
00410      * Get the version of PDF.
00411      * 
00412      *
00413      * @return  the version of PDF.
00414      */
00415     DfvPDFVERSION   getPdfVersion() const;
00416 
00417     /**
00418      * Effective when outputting to PDF.
00419      * Disables filling in of form fields and signing of the PDF file.
00420      * This parameter is effective only when you specify PDF1.4 or later to PDF version.
00421      * 
00422      *
00423      * @param   newVal  If nonezero is specified, Disables filling in of form fields and signing of the PDF file.
00424      */
00425     void setPdfNoFillForm(long newVal);
00426 
00427     /**
00428      * Effective when outputting to PDF.
00429      * Get disables filling in of form fields and signing of the PDF file.
00430      * 
00431      *
00432      * @return  If zero is returned, Enables filling in of form fields and signing of the PDF file.
00433      *          If nonezero is returned, Disables filling in of form fields and signing of the PDF file.
00434      */
00435     long getPdfNoFillForm() const;
00436 
00437     /**
00438      * Effective when outputting to PDF.
00439      * Disables text access for screen reader devices of the PDF file.
00440      * This parameter is effective only when you specify 1.4 or later with PDF version.
00441      * 
00442      *
00443      * @param   newVal  If nonezero is specified, Disables text access for screen reader devices of the PDF file.
00444      */
00445     void setPdfNoAccessibility(long newVal);
00446 
00447     /**
00448      * Effective when outputting to PDF.
00449      * Get disables text access for screen reader devices of the PDF file.
00450      * 
00451      *
00452      * @return  If zero is returned, Enables text access for screen reader devices of the PDF file.
00453      *          If nonezero is returned, Disables text access for screen reader devices of the PDF file.
00454      */
00455     long getPdfNoAccessibility() const;
00456 
00457     /**
00458      * Effective when outputting to PDF.
00459      * Disables inserting, deleting and rotating the PDF pages.
00460      * This parameter is effective only when you specify 1.4 or later with PDF version
00461      * 
00462      *
00463      * @param   newVal  If nonezero is specified, Disables inserting, deleting and rotating the PDF pages.
00464      */
00465     void setPdfNoAssembleDoc(long newVal);
00466 
00467     /**
00468      * Effective when outputting to PDF.
00469      * Get disables inserting, deleting and rotating the PDF pages.
00470      * 
00471      *
00472      * @return  If zero is returned, Enables inserting, deleting and rotating the PDF pages.
00473      *          If nonezero is returned, Disables inserting, deleting and rotating the PDF pages.
00474      */
00475     long getPdfNoAssembleDoc() const;
00476 
00477     /**
00478      * Effective when outputting to PDF.
00479      * Specifies the key length when encrypting the PDF file during outputting.
00480      * The key length can be specified as either 40 or 128 (bit).
00481      * This parameter is effective only when you specify PDF1.4 or later with PDF version
00482      * 
00483      *
00484      * @param   newVal  Specifies the key length.
00485      */
00486     void setPdfEncryptLevel(DfvPDFENCRYPTLEVEL newVal);
00487 
00488     /**
00489      * Effective when outputting to PDF.
00490      * Get the key length when encrypting the PDF file during outputting.
00491      * 
00492      *
00493      * @return  the key length.
00494      */
00495     DfvPDFENCRYPTLEVEL  getPdfEncryptLevel() const;
00496 
00497     /**
00498      * Effective when outputting to PDF.
00499      * Gets the value of whether to embed all embeddable fonts in PDF.
00500      * 
00501      *
00502      * @return  the value of whether to embed all embeddable fonts
00503      */
00504     long getPdfEmbedAllFonts() const;
00505 
00506     /**
00507      * Effective when outputting to PDF.
00508      * Embeds all embeddable fonts in PDF to create.
00509      * 
00510      *
00511      * @param   newVal  If the value is 'true' is specified, Embeds all embeddable fonts
00512      */
00513     void setPdfEmbedAllFonts(long newVal);
00514 
00515     /**
00516      * Effective when outputting to PDF.
00517      * Gets the font specified to be embedded in PDF.
00518      * 
00519      *
00520      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
00521      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00522      * @return  the font specified to be embedded
00523      */
00524     char* getPdfEmbedFonts(char* pVal, int size) const;
00525 
00526     /**
00527      * Effective when outputting to PDF.
00528      * Gets the font specified to be embedded in PDF.
00529      * 
00530      *
00531      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
00532      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00533      * @return  the font specified to be embedded
00534      */
00535     wchar_t* getPdfEmbedFontsW(wchar_t* pVal, int size) const;
00536 
00537     /**
00538      * Effective when outputting to PDF.
00539      * Embeds the specified font in PDF to create. If you want to specify plural fonts, put commas between fonts.
00540      * 
00541      *
00542      * @param   newVal  fonts specified to embed
00543      */
00544     void setPdfEmbedFonts(const char* newVal);
00545 
00546     /**
00547      * Effective when outputting to PDF.
00548      * Embeds the specified font in PDF to create. If you want to specify plural fonts, put commas between fonts.
00549      * 
00550      *
00551      * @param   newVal  fonts specified to embed
00552      */
00553     void setPdfEmbedFontsW(const wchar_t* newVal);
00554 
00555     /**
00556      * Effective when outputting to PDF.
00557      * Gets the value of whether to issues the error when failing to embed fonts.
00558      * 
00559      *
00560      * @return  the value of whether to issues the error
00561      */
00562     long getPdfErrorOnEmbedFault() const;
00563 
00564     /**
00565      * Effective when outputting to PDF.
00566      * An error is issued in case of failing to embed fonts.
00567      * 
00568      *
00569      * @param   newVal  If the value is 'true' is specified, an error is issued.
00570      */
00571     void setPdfErrorOnEmbedFault(long newVal);
00572 
00573     /**
00574      * Effective when outputting to PDF.
00575      * Gets the value of whether to issues the error when missing glyph.
00576      * 
00577      *
00578      * @return  the value of whether to issues the error
00579      */
00580     long getPdfErrorOnMissingGlyph() const;
00581 
00582     /**
00583      * Effective when outputting to PDF.
00584      * An error is issued in case of missing glyph.
00585      * 
00586      *
00587      * @param   newVal  If the value is 'true' is specified, an error is issued.
00588      */
00589     void setPdfErrorOnMissingGlyph(long newVal);
00590 
00591     /**
00592      * Effective when outputting to PDF.
00593      * Gets the value of whether to print the resulting PDF file or not.
00594      * 
00595      *
00596      * <table border="0" cellspacing="0" cellpadding="0">
00597      *  <tr><td>PRALLOW_NONE    </td><td>= 0 Not Allowed</td></tr>
00598      *  <tr><td>PRALLOW_LOW     </td><td>= 1 Low Resolution Printing</td></tr>
00599      *  <tr><td>PRALLOW_HIGH    </td><td>= 2 High Resolution Printing</td></tr>
00600      * </table>
00601      *
00602      * @return  the value of printing allowed
00603      */
00604     DfvPDFPRINTALLOW getPdfPrintingAllowed() const;
00605 
00606     /**
00607      * Effective when outputting to PDF.
00608      * Spesifies whether to permit printing PDF to create with one of the following values.
00609      * This parameter is effective only when you specify PDF1.4 or later to PDF version (setPdfVersion).
00610      * 
00611      *
00612      * <table border="0" cellspacing="0" cellpadding="0">
00613      *  <tr><td>PRALLOW_NONE    </td><td>= 0 Not Allowed</td></tr>
00614      *  <tr><td>PRALLOW_LOW     </td><td>= 1 Low Resolution Printing</td></tr>
00615      *  <tr><td>PRALLOW_HIGH    </td><td>= 2 High Resolution Printing</td></tr>
00616      * </table>
00617      *
00618      * @param   newVal  the value of printing allowed
00619      */
00620     void setPdfPrintingAllowed(DfvPDFPRINTALLOW newVal);
00621 
00622     /**
00623      * Effective when outputting to PDF.
00624      * Gets the value of how to compress the color images embedded in PDF.
00625      * 
00626      *
00627      * <table border="0" cellspacing="0" cellpadding="0">
00628      *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto</td></tr>
00629      *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG compression</td></tr>
00630      *  <tr><td>IMGCMPR_ZLIB    </td><td>= 2 ZLIB compression</td></tr>
00631      *  <tr><td>IMGCMPR_JPEG2K  </td><td>= 3 JPEG2000 compression</td></tr>
00632      * </table>
00633      *
00634      * @return  the value of how raster graphics are compressed and stored
00635      */
00636     DfvPDFIMAGECOMPRESSION getPdfImageCompression() const;
00637 
00638     /**
00639      * Effective when outputting to PDF.
00640      * When the color image format cannot be stored directly in PDF, the image is stored after being transformed into the bit map format which is compatible with PDF. The compression method of the data stored in a PDF file is then specified by one of the following values.<BR>
00641      * When IMGCMPR_AUTO is selected, the process is automatically done and creates the image data according to the setting of setPdfJPEGQuality and setPdfRasterizeResolution. Whichever has the smaller compressed size, JPEG or ZLIB, is selected. <BR>
00642 This is the setting for the color image. Spesify setPdfGrayscaleImageCompression for the grayscale image, and setPdfMonochromeImageCompression for the monochrome image.
00643      * 
00644      *
00645      * <table border="0" cellspacing="0" cellpadding="0">
00646      *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto</td></tr>
00647      *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG compression</td></tr>
00648      *  <tr><td>IMGCMPR_ZLIB    </td><td>= 2 ZLIB compression</td></tr>
00649      *  <tr><td>IMGCMPR_JPEG2K  </td><td>= 3 JPEG2000 compression</td></tr>
00650      * </table>
00651      *
00652      * @param   newVal  the value of how raster graphics are compressed and stored
00653      */
00654     void setPdfImageCompression(DfvPDFIMAGECOMPRESSION newVal);
00655 
00656     /**
00657      * Gets the value of the quality of JPEG format that is specified by setPdfImageCompression() stored in PDF.
00658      * 
00659      *
00660      * @return  the value of the quality of JPEG format
00661      */
00662     int getPdfJPEGQuality() const;
00663 
00664     /**
00665      * Effective when outputting to PDF.
00666      * For the color image format that can not be stored directly in PDF, specifies the image quality by the numerical value within the range of 1-100 when IMGCMPR_JPEG is specified by setPdfImageCompression. The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger.<BR>
00667      * CAUTION:     It is not for changing the quality of a JPEG format image.<BR>
00668      * This is the setting for the color image. Spesify setPdfGrayscaleJPEGQuality for the grayscale image.
00669      * 
00670      *
00671      * @param   newVal  the value of the quality of JPEG format
00672      */
00673     void setPdfJPEGQuality(int newVal);
00674 
00675     /**
00676      * Effective when outputting to PDF.
00677      * Gets the value of whether the text and the line art in PDF are compressed in order to make the size of PDF smaller or not.
00678      * 
00679      *
00680      * @return  the value of whether make the size of PDF smaller or not
00681      */
00682     long getPdfCompressContentStream() const;
00683 
00684     /**
00685      * Effective when outputting to PDF.
00686      * Specifies whether the text and the line art in PDF are compressed in order to make the size of PDF smaller or not.
00687      * 
00688      *
00689      * @param   newVal  If the value is 'true' is specified, make the PDF compress
00690      */
00691     void setPdfCompressContentStream(long newVal);
00692 
00693     /**
00694      * Effective when outputting to PDF.
00695      * Gets the value of how to transform external link specified by the relative address in the PDF link.
00696      * 
00697      *
00698      * @return  the value of how to transform external link
00699      */
00700     long getPdfUseLaunchForRelativeURI() const;
00701 
00702     /**
00703      * Effective when outputting to PDF.
00704      * Specifies whether the external link specified by the relative address is transformed into 'Open the file' or into 'World Wide Web link' in the PDF link properties.
00705      * 
00706      *
00707      * @param   newVal  If nonezero is specified, it is transformed to 'Open the file'. If zero is specified, it is transformed to 'World Wide Web link'
00708      */
00709     void setPdfUseLaunchForRelativeURI(long newVal);
00710 
00711     /**
00712      * Effective when outputting to PDF.
00713      * Gets the value of how to convert the RGB color space (DebiceRGB) to DeviceGray.
00714      * 
00715      *
00716      * <table border="0" cellspacing="0" cellpadding="0">
00717      *  <tr><td>RGBCONV_NONE    </td><td>= 0 No Conversion</td></tr>
00718      *  <tr><td>RGBCONV_BLACK   </td><td>= 1 Black to DeviceGray</td></tr>
00719      *  <tr><td>RGBCONV_GRAY    </td><td>= 2 Gray to DeviceGray</td></tr>
00720      *  <tr><td>RGBCONV_ALL     </td><td>= 3 All RGB to DeviceGray</td></tr>
00721      * </table>
00722      *
00723      * @return  the value of how to convert
00724      */
00725     DfvPDFRGBCONVERSION getPdfRGBConversion() const;
00726 
00727     /**
00728      * Effective when outputting to PDF.
00729      * Specifies how to convert the RGB color space (DeviceRGB) to DeviceGray.
00730      * 
00731      *
00732      * <table border="0" cellspacing="0" cellpadding="0">
00733      *  <tr><td>RGBCONV_NONE    </td><td>= 0 No Conversion</td></tr>
00734      *  <tr><td>RGBCONV_BLACK   </td><td>= 1 Black to DeviceGray</td></tr>
00735      *  <tr><td>RGBCONV_GRAY    </td><td>= 2 Gray to DeviceGray</td></tr>
00736      *  <tr><td>RGBCONV_ALL     </td><td>= 3 All RGB to DeviceGray</td></tr>
00737      * </table>
00738      *
00739      * @param   newVal  the value of how to convert
00740      */
00741     void setPdfRGBConversion(DfvPDFRGBCONVERSION newVal);
00742 
00743 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
00744 
00745     /**
00746      * Effective when outputting to PDF.
00747      * Gets the value of the rasterised-resolution of the transformed raster images.
00748      * 
00749      *
00750      * @return  Rasterised-resolution
00751      */
00752     int getPdfRasterizeResolution() const;
00753 
00754     /**
00755      * Effective when outputting to PDF.
00756      * Specifies the value of the rasterised-resolution of the transformed raster images in the range from 70 to 500(dpi). SVG, EMF and WMF are drawn in PDF as vectors without being transformed to raster images.
00757      * This setting is effective only with Windows version.
00758      * 
00759      *
00760      * @param   newVal  Rasterised-resolution (70 to 500)
00761      */
00762     void setPdfRasterizeResolution(int newVal);
00763 
00764 #endif
00765 
00766     /**
00767      * Effective when outputting to PDF.
00768      * Gets the value of whether to output linearize PDF or not.
00769      * @since 7.0
00770      *
00771      * @return  the value of whether to output linearize pdf or not.
00772      */
00773     long getPdfLinearize() const;
00774 
00775     /**
00776      * Effective when outputting to PDF.
00777      * Specifies whether to output linearize PDF or not.
00778      * @since 7.0
00779      *
00780      * @param   newVal  If the value is 'true' is specified, output linearlize PDF.
00781      */
00782     void setPdfLinearize(long newVal);
00783 
00784     /**
00785      * Effective when outputting to PDF.
00786      * Gets the value of whether to embed all embeddable fonts
00787      * 
00788      *
00789      * <table border="0" cellspacing="0" cellpadding="0">
00790      *  <tr><td>EMBALLFONT_PART </td><td>= 0 Specified fonts </td></tr>
00791      *  <tr><td>EMBALLFONT_ALL  </td><td>= 1 All fonts except Base14 fonts</td></tr>
00792      *  <tr><td>EMBALLFONT_BASE14   </td><td>= 2 All fonts</td></tr>
00793      * </table>
00794      *
00795      * @return  the value of whether to embed all embeddable fonts
00796      */
00797     DfvEMBEDALLFONT getPdfEmbedAllFontsEx(void) const;
00798 
00799     /**
00800      * Effective when outputting to PDF.
00801      * Specifies whether to embed the all outline data of fonts in PDF or not with one of the following values, which are True type fonts and Type1 Fonts and are embeddable in the formatted result.
00802      * 
00803      *
00804      * <table border="0" cellspacing="0" cellpadding="0">
00805      *  <tr><td>EMBALLFONT_PART </td><td>= 0 Specified fonts </td></tr>
00806      *  <tr><td>EMBALLFONT_ALL  </td><td>= 1 All fonts except Base14 fonts</td></tr>
00807      *  <tr><td>EMBALLFONT_BASE14   </td><td>= 2 All fonts</td></tr>
00808      * </table>
00809      *
00810      *If the value is EMBALLFONT_PART, only fonts specified in setPdfEmbedFonts are embedded. If the value is EMBALLFONT_ALL, all fonts that can be embedded except Base 14 fonts will be embedded. If the value is EMBALLFONT_BASE14, all fonts including Base 14 fonts that can be embedded will be embedded.
00811      *
00812      * @param   newVal  the value of whether to embed all embeddable fonts
00813      */
00814     void setPdfEmbedAllFontsEx(DfvEMBEDALLFONT newVal);
00815 
00816     /**
00817      * Effective when outputting to PDF.
00818      * Gets the value of method to downsample the color image
00819      * 
00820      *
00821      * @return  the value of method to downsample the color image
00822      */
00823     DfvIMAGEDOWNSAMPLING getPdfImageDownSampling(void) const;
00824 
00825     /**
00826      * Effective when outputting to PDF.
00827      * Specifies the following either of method to downsample the color image that is put into PDF.
00828      * 
00829      *
00830      * <table border="0" cellspacing="0" cellpadding="0">
00831      *  <tr><td>IMGDOWNSAMPLING_NONE    </td><td>= 0 No downsampling </td></tr>
00832      *  <tr><td>IMGDOWNSAMPLING_AVERAGE </td><td>= 1 Average downsamplin</td></tr>
00833      *  <tr><td>IMGDOWNSAMPLING_BICUBIC </td><td>= 2 Bicubic downsampling</td></tr>
00834      *  <tr><td>IMGDOWNSAMPLING_SUBSAMPLING </td><td>= 3 Subsampling</td></tr>
00835      * </table>
00836      *
00837      * When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by setPdfImageDownSamplingDPI will be downsampled into the resolution specified by setPdfImageDownSamplingTarget.
00838 This is the setting for the color image. Spesify setPdfGrayscaleImageDownSampling for the grayscale image, and setPdfMonochromeImageDownSampling for the monochrome image.
00839      *
00840      * @param   newVal  the value of method to downsample the color image
00841      */
00842     void setPdfImageDownSampling(DfvIMAGEDOWNSAMPLING newVal);
00843 
00844     /**
00845      * Effective when outputting to PDF.
00846      * Gets resolution when the color image is downsampled.
00847      * 
00848      *
00849      * @return  the value of resolution.
00850      */
00851     int getPdfImageDownSamplingTarget(void) const;
00852 
00853     /**
00854      * Effective when outputting to PDF.
00855      * Set resolution when the color image is downsampled.
00856      * 
00857      *
00858      * @param   newVal  the value of resolution.
00859      */
00860     void setPdfImageDownSamplingTarget(int newVal);
00861 
00862     /**
00863      * Effective when outputting to PDF.
00864      * Gets resolution of the color image which performs a downsampling.
00865      * 
00866      *
00867      * @return  the value of resolution.
00868      */
00869     int getPdfImageDownSamplingDPI(void) const;
00870 
00871     /**
00872      * Effective when outputting to PDF.
00873      * Set resolution of the color image which performs a downsampling.
00874      * 
00875      *
00876      * @param   newVal  the value of resolution.
00877      */
00878     void setPdfImageDownSamplingDPI(int newVal);
00879 
00880     /**
00881      * Effective when outputting to PDF.
00882      * Gets specification whether to embed to PDF the ICC profile of the color image that will be embedded to PDF.
00883      * 
00884      *
00885      * @return  If nonezero is specified, it is embedded. If zero is specified, it is not embedded.
00886      */
00887     long getPdfPutImageColorProfile(void) const;
00888 
00889     /**
00890      * Effective when outputting to PDF.
00891      * Specifies whether to embed to PDF the ICC profile of the color image that will be embedded to PDF.
00892      * 
00893      *
00894      * @param   newVal  If nonezero is specified, it is embedded. If zero is specified, it is not embedded.
00895      */
00896     void setPdfPutImageColorProfile(long newVal);
00897 
00898     /**
00899      * Effective when outputting to PDF.
00900      * Gets the value of how to compress the grayscale images embedded in PDF.
00901      * 
00902      *
00903      * <table border="0" cellspacing="0" cellpadding="0">
00904      *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto</td></tr>
00905      *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG compression</td></tr>
00906      *  <tr><td>IMGCMPR_ZLIB    </td><td>= 2 ZLIB compression</td></tr>
00907      *  <tr><td>IMGCMPR_JPEG2K  </td><td>= 3 JPEG2000 compression</td></tr>
00908      * </table>
00909      *
00910      * @return  the value of how raster graphics are compressed and stored
00911      */
00912     DfvPDFIMAGECOMPRESSION getPdfGrayscaleImageCompression(void) const;
00913 
00914     /**
00915      * Effective when outputting to PDF.
00916      * When the grayscale image format cannot be stored directly in PDF, the image is stored after being transformed into the bit map format which is compatible with PDF. The compression method of the data stored in a PDF file is then specified by one of the following values.<BR>
00917      * When IMGCMPR_AUTO is selected, the process is automatically done and creates the image data according to the setting of setPdfGrayscaleJPEGQuality and setPdfRasterizeResolution. Whichever has the smaller compressed size, JPEG or ZLIB, is selected. <BR>
00918 This is the setting for the grayscale image. Spesify setPdfImageCompression for the color image, and setPdfMonochromeImageCompression for the monochrome image.
00919      * 
00920      *
00921      * <table border="0" cellspacing="0" cellpadding="0">
00922      *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto</td></tr>
00923      *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG compression</td></tr>
00924      *  <tr><td>IMGCMPR_ZLIB    </td><td>= 2 ZLIB compression</td></tr>
00925      *  <tr><td>IMGCMPR_JPEG2K  </td><td>= 3 JPEG2000 compression</td></tr>
00926      * </table>
00927      *
00928      * @param   newVal  the value of how raster graphics are compressed and stored
00929      */
00930     void setPdfGrayscaleImageCompression(DfvPDFIMAGECOMPRESSION newVal);
00931 
00932     /**
00933      * Effective when outputting to PDF.
00934      * Gets the value of the quality of JPEG format that is specified by setPdfGrayscaleImageCompression stored in PDF.
00935      * 
00936      *
00937      * @return  the value of the quality of JPEG format
00938      */
00939     int getPdfGrayscaleJPEGQuality(void) const;
00940 
00941     /**
00942      * Effective when outputting to PDF.
00943      * For the grayscale image format that can not be stored directly in PDF, specifies the image quality by the numerical value within the range of 1-100 when IMGCMPR_JPEG is specified by setPdfGrayscaleImageCompression. The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger.<BR>
00944      * CAUTION: It is not for changing the quality of a JPEG format image.<BR>
00945      * This is the setting for the grayscale image. Spesify setPdfJPEGQuality for the color image.
00946      * 
00947      *
00948      * @param   newVal  the value of the quality of JPEG format
00949      */
00950     void setPdfGrayscaleJPEGQuality(int newVal);
00951 
00952     /**
00953      * Effective when outputting to PDF.
00954      * Gets the value of method to downsample the grayscale image
00955      * 
00956      *
00957      * @return  the value of method to downsample the grayscale image
00958      */
00959     DfvIMAGEDOWNSAMPLING getPdfGrayscaleImageDownSampling(void) const;
00960 
00961     /**
00962      * Effective when outputting to PDF.
00963      * Specifies the following either of method to downsample the grayscale image that is put into PDF.
00964      * 
00965      *
00966      * <table border="0" cellspacing="0" cellpadding="0">
00967      *  <tr><td>IMGDOWNSAMPLING_NONE    </td><td>= 0 No downsampling </td></tr>
00968      *  <tr><td>IMGDOWNSAMPLING_AVERAGE </td><td>= 1 Average downsamplin</td></tr>
00969      *  <tr><td>IMGDOWNSAMPLING_BICUBIC </td><td>= 2 Bicubic downsampling</td></tr>
00970      *  <tr><td>IMGDOWNSAMPLING_SUBSAMPLING </td><td>= 3 Subsampling</td></tr>
00971      * </table>
00972      *
00973      * When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by setPdfGrayscaleImageDownSamplingDPI will be downsampled into the resolution specified by setPdfGrayscaleImageDownSamplingTarget.
00974 This is the setting for the grayscale image. Spesify setPdfImageDownSampling for the color image, and setPdfMonochromeImageDownSampling for the monochrome image.
00975      *
00976      * @param   newVal  the value of method to downsample the grayscale image
00977      */
00978     void setPdfGrayscaleImageDownSampling(DfvIMAGEDOWNSAMPLING newVal);
00979 
00980     /**
00981      * Effective when outputting to PDF.
00982      * Gets resolution when the grayscale image is downsampled.
00983      * 
00984      *
00985      * @return  the value of resolution.
00986      */
00987     int getPdfGrayscaleImageDownSamplingTarget(void) const;
00988 
00989     /**
00990      * Effective when outputting to PDF.
00991      * Set resolution when the grayscale image is downsampled.
00992      * 
00993      *
00994      * @param   newVal  the value of resolution.
00995      */
00996     void setPdfGrayscaleImageDownSamplingTarget(int newVal);
00997 
00998     /**
00999      * Effective when outputting to PDF.
01000      * Gets resolution of the grayscale image which performs a downsampling.
01001      * 
01002      *
01003      * @return  the value of resolution.
01004      */
01005     int getPdfGrayscaleImageDownSamplingDPI(void) const;
01006 
01007     /**
01008      * Effective when outputting to PDF.
01009      * Set resolution of the grayscale image which performs a downsampling.
01010      * 
01011      *
01012      * @param   newVal  the value of resolution.
01013      */
01014     void setPdfGrayscaleImageDownSamplingDPI(int newVal);
01015 
01016     /**
01017      * Effective when outputting to PDF.
01018      * Gets the value of how to compress the monochrome images embedded in PDF.
01019      * 
01020      *
01021      * <table border="0" cellspacing="0" cellpadding="0">
01022      *  <tr><td>MONOCMPR_CCITT4     </td><td>= 0 CCITTFaxDecode group 4 filter,default value</td></tr>
01023      *  <tr><td>MONOCMPR_CCITT3     </td><td>= 1 CCITTFaxDecode group 3 filter</td></tr>
01024      *  <tr><td>MONOCMPR_RUNLENGTH  </td><td>= 2 RunLengthDecode filter</td></tr>
01025      *  <tr><td>MONOCMPR_ZLIB       </td><td>= 3 FlateDecode filter</td></tr>
01026      *  <tr><td>MONOCMPR_OFF        </td><td>= 4 no filter</td></tr>
01027      * </table>
01028      *
01029      * @return  the value of how raster graphics are compressed and stored
01030      */
01031     DfvMONOCHROMECOMPRESSION getPdfMonochromeImageCompression(void) const;
01032 
01033     /**
01034      * Effective when outputting to PDF.
01035      * When the monochrome image format cannot be stored directly in PDF, the image is stored after being transformed into the bit map format which is compatible with PDF. The compression method of the data stored in a PDF file is then specified by one of the following values.<BR>
01036 This is the setting for the monochrome image. Spesify setPdfGrayscaleImageCompression for the grayscale image, and setPdfImageCompression for the color image.
01037      * 
01038      *
01039      * <table border="0" cellspacing="0" cellpadding="0">
01040      *  <tr><td>MONOCMPR_CCITT4     </td><td>= 0 CCITTFaxDecode group 4 filter,default value</td></tr>
01041      *  <tr><td>MONOCMPR_CCITT3     </td><td>= 1 CCITTFaxDecode group 3 filter</td></tr>
01042      *  <tr><td>MONOCMPR_RUNLENGTH  </td><td>= 2 RunLengthDecode filter</td></tr>
01043      *  <tr><td>MONOCMPR_ZLIB       </td><td>= 3 FlateDecode filter</td></tr>
01044      *  <tr><td>MONOCMPR_OFF        </td><td>= 4 no filter</td></tr>
01045      * </table>
01046      *
01047      * @param   newVal  the value of how raster graphics are compressed and stored
01048      */
01049     void setPdfMonochromeImageCompression(DfvMONOCHROMECOMPRESSION newVal);
01050 
01051     /**
01052      * Effective when outputting to PDF.
01053      * Gets the value of method to downsample the monochrome image
01054      * 
01055      *
01056      * @return  the value of method to downsample the monochrome image
01057      */
01058     DfvIMAGEDOWNSAMPLING getPdfMonochromeImageDownSampling(void) const;
01059 
01060     /**
01061      * Effective when outputting to PDF.
01062      * Specifies the following either of method to downsample the monochrome image that is put into PDF.
01063      * 
01064      *
01065      * <table border="0" cellspacing="0" cellpadding="0">
01066      *  <tr><td>IMGDOWNSAMPLING_NONE    </td><td>= 0 No downsampling </td></tr>
01067      *  <tr><td>IMGDOWNSAMPLING_AVERAGE </td><td>= 1 Average downsamplin</td></tr>
01068      *  <tr><td>IMGDOWNSAMPLING_BICUBIC </td><td>= 2 Bicubic downsampling</td></tr>
01069      *  <tr><td>IMGDOWNSAMPLING_SUBSAMPLING </td><td>= 3 Subsampling</td></tr>
01070      * </table>
01071      *
01072      * When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by setPdfMonochromeImageDownSamplingDPI will be downsampled into the resolution specified by setPdfMonochromeImageDownSamplingTarget.
01073 This is the setting for the monochrome image. Spesify setPdfImageDownSampling for the color image, and setPdfGrayscaleImageDownSampling for the grayscale image.
01074      *
01075      * @param   newVal  the value of method to downsample the monochrome image
01076      */
01077     void setPdfMonochromeImageDownSampling(DfvIMAGEDOWNSAMPLING newVal);
01078 
01079     /**
01080      * Effective when outputting to PDF.
01081      * Gets resolution when the monochrome image is downsampled.
01082      * 
01083      *
01084      * @return  the value of resolution.
01085      */
01086     int getPdfMonochromeImageDownSamplingTarget(void) const;
01087 
01088     /**
01089      * Effective when outputting to PDF.
01090      * Set resolution when the monochrome image is downsampled.
01091      * 
01092      *
01093      * @param   newVal  the value of resolution.
01094      */
01095     void setPdfMonochromeImageDownSamplingTarget(int newVal);
01096 
01097     /**
01098      * Effective when outputting to PDF.
01099      * Gets resolution of the monochrome image which performs a downsampling.
01100      * 
01101      *
01102      * @return  the value of resolution.
01103      */
01104     int getPdfMonochromeImageDownSamplingDPI(void) const;
01105 
01106     /**
01107      * Effective when outputting to PDF.
01108      * Set resolution of the monochrome image which performs a downsampling.
01109      * 
01110      *
01111      * @param   newVal  the value of resolution.
01112      */
01113     void setPdfMonochromeImageDownSamplingDPI(int newVal);
01114 
01115     /**
01116      * Effective when outputting to PDF.
01117      * Gets the width of PDF to output.
01118      * 
01119      *
01120      * @param   pVal        Pointer to the buffer that will receive the width of PDF. If the string is as long or longer than the buffer,
01121      *          the string is truncated and terminated with a NULL character.
01122      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01123      * @return  Returns the 'pVal'.
01124      */
01125     char* getPdfOutputWidth(char* pVal, int size) const;
01126 
01127     /**
01128      * Effective when outputting to PDF.
01129      * Gets the width of PDF to output.
01130      * 
01131      *
01132      * @param   pVal        Pointer to the buffer that will receive the width of PDF. If the string is as long or longer than the buffer,
01133      *          the string is truncated and terminated with a NULL character.
01134      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01135      * @return  Returns the 'pVal'.
01136      */
01137     wchar_t* getPdfOutputWidthW(wchar_t* pVal, int size) const;
01138 
01139     /**
01140      * Effective when outputting to PDF.
01141      * Scales the width of PDF to output. A value with a unit or % value can be specified as length.
01142      * 
01143      *
01144      * @param   newVal  Pointer to a null-terminated string to be used as the width of PDF to output.
01145      */
01146     void setPdfOutputWidth(const char* newVal);
01147 
01148     /**
01149      * Effective when outputting to PDF.
01150      * Scales the width of PDF to output. A value with a unit or % value can be specified as length.
01151      * 
01152      *
01153      * @param   newVal  Pointer to a null-terminated string to be used as the width of PDF to output.
01154      */
01155     void setPdfOutputWidthW(const wchar_t* newVal);
01156 
01157     /**
01158      * Effective when outputting to PDF.
01159      * Gets the height of PDF to output.
01160      * 
01161      *
01162      * @param   pVal        Pointer to the buffer that will receive the height of PDF. If the string is as long or longer than the buffer,
01163      *          the string is truncated and terminated with a NULL character.
01164      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01165      * @return  Returns the 'pVal'.
01166      */
01167     char* getPdfOutputHeight(char* pVal, int size) const;
01168 
01169     /**
01170      * Effective when outputting to PDF.
01171      * Gets the height of PDF to output.
01172      * 
01173      *
01174      * @param   pVal        Pointer to the buffer that will receive the height of PDF. If the string is as long or longer than the buffer,
01175      *          the string is truncated and terminated with a NULL character.
01176      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01177      * @return  Returns the 'pVal'.
01178      */
01179     wchar_t* getPdfOutputHeightW(wchar_t* pVal, int size) const;
01180 
01181     /**
01182      * Effective when outputting to PDF.
01183      * Scales the height of PDF to output. A value with a unit or % value can be specified as length.
01184      * 
01185      *
01186      * @param   newVal  Pointer to a null-terminated string to be used as the width of PDF to output.
01187      */
01188     void setPdfOutputHeight(const char* newVal);
01189 
01190     /**
01191      * Effective when outputting to PDF.
01192      * Scales the height of PDF to output. A value with a unit or % value can be specified as length.
01193      * 
01194      *
01195      * @param   newVal  Pointer to a null-terminated string to be used as the width of PDF to output.
01196      */
01197     void setPdfOutputHeightW(const wchar_t* newVal);
01198 
01199     /**
01200     * Specifies the scaling ratio of the PDF to output.
01201     * A value with a unit or % value can be specified as length.
01202     * Effective when outputting to PDF.
01203     *
01204     * @param    newVal      the scaling ratio of the PDF
01205     */
01206     void setPdfOutputScale(const char* newVal);
01207 
01208     /**
01209     * Specifies the scaling ratio of the PDF to output.
01210     * A value with a unit or % value can be specified as length.
01211     * Effective when outputting to PDF.
01212     *
01213     * @param    newVal      the scaling ratio of the PDF
01214     */
01215     void setPdfOutputScaleW(const wchar_t* newVal);
01216 
01217     /**
01218      * Effective when outputting to PDF.
01219      * Gets the value of whether to issue error or not when PDF/X is generating.
01220      * 
01221      *
01222      * @return  the value of whether to issue error.
01223      */
01224     long getPdfErrorOnPDFXFault();
01225 
01226     /**
01227      * Effective when outputting to PDF.
01228      * An error is not issued when PDF/X is generating.
01229      * 
01230      *
01231      * @param   newVal  If the value is 'true' is specified, no error is issued.
01232      */
01233     void setPdfErrorOnPDFXFault(long newVal);
01234 
01235     /**
01236      * Effective when inputting from PDF.
01237      * Specifies whether to output PDF Annotation.
01238      * 
01239      *
01240      * @return  If true is returned, Annotation is output.
01241      *          If false is returned, Annotation is not output.
01242      */
01243     bool getPdfAnnotation() const;
01244 
01245     /**
01246      * Effective when inputting from PDF.
01247      * Gets the setting indicating whether to output PDF Annotation.
01248      * 
01249      *
01250      * @param   newVal  If true is specified, Annotation is output.
01251      */
01252     void setPdfAnnotation(bool newVal);
01253 
01254     /**
01255     * Effective when outputting to PDF.
01256     * Gets the format for naming files when the outputted PDF becomes multiple.
01257     *
01258     *
01259     * @param    pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
01260     * @param    size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01261     * @return   Returns the 'pVal'.
01262     */
01263     char* getPdfFormat(char* pVal, int size) const;
01264 
01265     /**
01266     * Effective when outputting to PDF.
01267     * Gets the format for naming files when the outputted PDF becomes multiple.
01268     *
01269     *
01270     * @param    pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
01271     * @param    size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01272     * @return   Returns the 'pVal'.
01273     */
01274     wchar_t* getPdfFormatW(wchar_t* pVal, int size) const;
01275 
01276     /**
01277     * Effective when outputting to PDF.
01278     * Specifies the format for naming files when the outputted PDF becomes multiple.
01279     *
01280     *
01281     * @param    newVal  Pointer to a null-terminated string to be used as the PDF file name format.
01282     */
01283     void setPdfFormat(const char* newVal);
01284 
01285     /**
01286     * Effective when outputting to PDF.
01287     * Specifies the format for naming files when the outputted PDF becomes multiple.
01288     *
01289     *
01290     * @param    newVal  Pointer to a null-terminated string to be used as the PDF file name format.
01291     */
01292     void setPdfFormatW(const wchar_t* newVal);
01293 
01294 
01295     /**
01296      * Effective when outputting to SVG.
01297      * Get the version of SVG.
01298      * 
01299      *
01300      * @return  the version of SVG.
01301      */
01302     DfvSVGVERSION   getSvgVersion() const;
01303 
01304     /**
01305      * Effective when outputting to SVG.
01306      * Enables specifying whether the version of SVG is 1.1, Basic or Tiny.
01307      * 
01308      *
01309      * @param   newVal  Specifies the version of SVG.
01310      */
01311     void setSvgVersion(DfvSVGVERSION newVal);
01312 
01313     /**
01314      * Effective when outputting to SVG.
01315      * Gets the setting indicating whether to compress the outputted SVG into gzip format or not.
01316      * 
01317      *
01318      * @return  whether gzip compression or not.
01319      */
01320     long getSvgGzipCompression() const;
01321 
01322     /**
01323      * Effective when outputting to SVG.
01324      * Specifies whether to compress the outputted SVG into gzip format or not.
01325      * 
01326      *
01327      * @param   newVal      If the value is 'true' is specified, enables to compress data into gzip format.
01328      */
01329     void setSvgGzipCompression(long newVal);
01330 
01331     /**
01332      * this function is not supported.
01333      */
01334     long getSvgEmbedAllFonts() const;
01335 
01336     /**
01337      * this function is not supported.
01338      */
01339     void setSvgEmbedAllFonts(long newVal);
01340 
01341     /**
01342      * Effective when outputting to SVG.
01343      * Gets the format for naming files when the outputted SVG becomes multiple.
01344      * 
01345      *
01346      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
01347      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01348      * @return  Returns the 'pVal'.
01349      */
01350     char* getSvgFormat(char* pVal, int size) const;
01351 
01352     /**
01353      * Effective when outputting to SVG.
01354      * Gets the format for naming files when the outputted SVG becomes multiple.
01355      * 
01356      *
01357      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
01358      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01359      * @return  Returns the 'pVal'.
01360      */
01361     wchar_t* getSvgFormatW(wchar_t* pVal, int size) const;
01362 
01363     /**
01364      * Effective when outputting to SVG.
01365      * Specifies the format for naming files when the outputted SVG becomes multiple.
01366      * 
01367      *
01368      * @param   newVal  Pointer to a null-terminated string to be used as the SVG file name format.
01369      */
01370     void setSvgFormat(const char* newVal);
01371 
01372     /**
01373      * Effective when outputting to SVG.
01374      * Specifies the format for naming files when the outputted SVG becomes multiple.
01375      * 
01376      *
01377      * @param   newVal  Pointer to a null-terminated string to be used as the SVG file name format.
01378      */
01379     void setSvgFormatW(const wchar_t* newVal);
01380 
01381     /**
01382      * this function is not supported.
01383      */
01384     char* getSvgEmbedFonts(char* pVal, int size) const;
01385 
01386     /**
01387      * this function is not supported.
01388      */
01389     wchar_t* getSvgEmbedFontsW(wchar_t* pVal, int size) const;
01390 
01391     /**
01392      * this function is not supported.
01393      */
01394     void setSvgEmbedFonts(const char* newVal);
01395 
01396     /**
01397      * this function is not supported.
01398      */
01399     void setSvgEmbedFontsW(const wchar_t* newVal);
01400 
01401     /**
01402      * this function is not supported.
01403      */
01404     long getSvgErrorOnEmbedFault() const;
01405 
01406     /**
01407      * this function is not supported.
01408      */
01409     void setSvgErrorOnEmbedFault(long newVal);
01410 
01411     /**
01412      * Effective when outputting to SVG.
01413      * Gets the value of how to compress the images embedded in SVG.
01414      * 
01415      *
01416      * <table border="0" cellspacing="0" cellpadding="0">
01417      *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto conversion</td></tr>
01418      *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG conversion</td></tr>
01419      *  <tr><td>IMGCMPR_PNG     </td><td>= 2 PNG conversion</td></tr>
01420      * </table>
01421      *
01422      * @return  the value of how raster graphics are compressed and stored
01423      */
01424     DfvIMAGECONVERSION getSvgImageConversion() const;
01425 
01426     /**
01427      * Effective when outputting to SVG.
01428      * Selects how to compress the images embedded in SVG to create from the following.
01429      * 
01430      *
01431      * <table border="0" cellspacing="0" cellpadding="0">
01432      *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto conversion</td></tr>
01433      *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG conversion</td></tr>
01434      *  <tr><td>IMGCMPR_PNG     </td><td>= 2 PNG conversion</td></tr>
01435      * </table>
01436      *
01437      * @param   newVal  the value of how raster graphics are compressed and stored
01438      */
01439     void setSvgImageConversion(DfvIMAGECONVERSION newVal);
01440 
01441     /**
01442      * Gets the value of the quality of JPEG format that is specified by setSvgImageConversion() stored in SVG.
01443      * 
01444      *
01445      * @return  the value of the quality
01446      */
01447     int getSvgJPEGQuality() const;
01448 
01449     /**
01450      * Effective when outputting to SVG.
01451      * Specifies the quality of the Raster graphics when stored in JPEG format using the range of 1-100.
01452      * The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger.
01453      * The initial value is 80.
01454      * 
01455      *
01456      * @param   newVal  JPEG quality (1 to 100)
01457      */
01458     void setSvgJPEGQuality(int newVal);
01459 
01460     /**
01461      * Effective when outputting to SVG.
01462      * Gets specification how to treat the referred image.
01463      * 
01464      *
01465      * <table border="0" cellspacing="0" cellpadding="0">
01466      *  <tr><td>IMGPT_EMBED_ALL </td><td>= 0 Embeds all images to SVG.</td></tr>
01467      *  <tr><td>IMGPT_COPY_ALL  </td><td>= 1 Copies all image files to the destination that is specified by setSvgImageCopyPath, and then links.</td></tr>
01468      *  <tr><td>IMGPT_LINK      </td><td>= 2 Links images that have been linked, and embeds the embedded image. However, the raster images other than JPEG and PNG are always embedded.</td></tr>
01469      *  <tr><td>IMGPT_COPY      </td><td>= 3 Copies images that have been linked to the destination that is specified by setSvgImageCopyPath, and links. The embedded image are embedded.</td></tr>
01470      * </table>
01471      *
01472      * @return  specification how to treat the referred image.
01473      */
01474     DfvIMAGEPROCTYPE getSvgImageProcessingType() const;
01475 
01476     /**
01477      * Effective when outputting to SVG.
01478      * Specifies how to treat the referred image.
01479      * 
01480      *
01481      * <table border="0" cellspacing="0" cellpadding="0">
01482      *  <tr><td>IMGPT_EMBED_ALL </td><td>= 0 Embeds all images to SVG.</td></tr>
01483      *  <tr><td>IMGPT_COPY_ALL  </td><td>= 1 Copies all image files to the destination that is specified by setSvgImageCopyPath, and then links.</td></tr>
01484      *  <tr><td>IMGPT_LINK      </td><td>= 2 Links images that have been linked, and embeds the embedded image. However, the raster images other than JPEG and PNG are always embedded.</td></tr>
01485      *  <tr><td>IMGPT_COPY      </td><td>= 3 Copies images that have been linked to the destination that is specified by setSvgImageCopyPath, and links. The embedded image are embedded.</td></tr>
01486      * </table>
01487      *
01488      * @param   newVal  specification how to treat the referred image.
01489      */
01490     void setSvgImageProcessingType(DfvIMAGEPROCTYPE newVal);
01491 
01492     /**
01493      * Effective when outputting to SVG.
01494      * Gets the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by setSvgImageProcessingType.
01495      * 
01496      *
01497      * @param   pVal        Pointer to the buffer that will receive the image copy path. If the string is as long or longer than the buffer,
01498      *          the string is truncated and terminated with a NULL character.
01499      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01500      * @return  Returns the 'pVal'.
01501      */
01502     char* getSvgImageCopyPath(char* pVal, int size) const;
01503 
01504     /**
01505      * Effective when outputting to SVG.
01506      * Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by setSvgImageProcessingType.
01507      * 
01508      *
01509      * @param   newVal  Pointer to a null-terminated string to be used as image copy path
01510      */
01511     void setSvgImageCopyPath(const char* newVal);
01512 
01513     /**
01514      * Effective when outputting to SVG.
01515      * Gets the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by setSvgImageProcessingType.
01516      * 
01517      *
01518      * @param   pVal        Pointer to the buffer that will receive the image copy path. If the string is as long or longer than the buffer,
01519      *          the string is truncated and terminated with a NULL character.
01520      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01521      * @return  Returns the 'pVal'.
01522      */
01523     wchar_t* getSvgImageCopyPathW(wchar_t* pVal, int size) const;
01524 
01525     /**
01526      * Effective when outputting to SVG.
01527      * Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by setSvgImageProcessingType.
01528      * 
01529      *
01530      * @param   newVal  Pointer to a null-terminated string to be used as image copy path
01531      */
01532     void setSvgImageCopyPathW(const wchar_t* newVal);
01533 
01534     /**
01535      * Effective when outputting to SVG.
01536      * Gets specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages. <BR>
01537      * 
01538      *
01539      * @return  specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.
01540      */
01541     long getSvgSingleFile() const;
01542 
01543     /**
01544      * Effective when outputting to SVG.
01545      * Specifies whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages. <BR>
01546      * If the value is true, outputs one SVG. If the value is false, outputs multiple SVG. When multiple SVG is output, the file name is modified by specifying format. <BR>
01547      * Effective only when outputting to the file. It is invalid in the output without the file name like the stream etc.
01548      * 
01549      *
01550      * @param   newVal  specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.
01551      */
01552     void setSvgSingleFile(long newVal);
01553 
01554 #if !defined(_DOXYGEN)
01555     /**
01556      * Gets the value specified by setSvgSingleFileMaxPages.
01557      * Effective when outputting to SVG. 
01558      *
01559      * @return  the value specified by setSvgSingleFileMaxPages.
01560      */
01561     int getSvgSingleFileMaxPages() const;
01562 
01563     /**
01564      * Specifies the maximum number of pages outputted when setSvgSingleFile = True is specified. .
01565      * When this parameter is omitted If this parameter is omitted, "5000" is considered as specified.
01566      * When either setSvgSingleFileMaxPages or setSvgSingleFileMaxHeight is specified, or both are specified, and the page exceeds either the maximum size (setSvgSingleFileMaxHeight) or the maximum number of pages (setSvgSingleFileMaxPages), Server Based Converter V1.2 will stop converting and abort the job as an error. Effective when outputting to SVG. 
01567      * 
01568      * @param   newVal  maximum number of pages 
01569      */
01570     void setSvgSingleFileMaxPages(int newVal);
01571 
01572     /**
01573      * Gets the value specified by setSvgImageDownsamplingDPI.
01574      * Effective when outputting to SVG. 
01575      * 
01576      * @return  the value specified by setSvgImageDownsamplingDPI. 
01577      */
01578     int getSvgImageDownsamplingDPI() const;
01579 
01580     /**
01581      * Specifies the resolution of the down sampling when embedding an image with 1 or more integers. .
01582      * When the resolution of the original image is lower than specification, it's embedded with the lower resolution. Effective when outputting to SVG. 
01583      * 
01584      * @return  newVal  the resolution of the down sampling 
01585      */
01586     void setSvgImageDownsamplingDPI(int dpi);
01587 
01588     /**
01589      * Gets the value specified by setSvgImageDownsamplingMethod.
01590      * Effective when outputting to SVG. 
01591      * 
01592      * @return  the value specified by setSvgImageDownsamplingMethod
01593      */
01594     int getSvgImageDownsamplingMethod() const;
01595 
01596     /**
01597      * Specifies the way of compression when down sampled.
01598      * 
01599      * S_SVG_IMGDOWNSAMPLING_AVERAGE : biliner 
01600      * S_SVG_IMGDOWNSAMPLING_BICUBIC : bicubic 
01601      * S_SVG_IMGDOWNSAMPLING_SUBSAMPLING : nearest neighbor
01602      * If this parameter is omitted, "IMGDOWNSAMPLING_AVERAGE" is considered as specified. Effective when outputting to SVG. 
01603      * 
01604      * @param   type    the way of compression when down sampled 
01605      */
01606     void setSvgImageDownsamplingMethod(int type);
01607 #endif
01608 
01609     /**
01610      * Effective when outputting to SVG.
01611      * Gets specification whether to rename all file name to prefix specified by setSvgImagePrefix, or use original name.
01612      * 
01613      *
01614      * @return  specification whether to rename all file name to prefix specified by setSvgImagePrefix, or use original name.
01615      */
01616     long getSvgImageRename() const;
01617 
01618     /**
01619      * Effective when outputting to SVG.
01620      * When images are copied to the directory specified by setSvgImageCopyPath etc. and processed, specifies whether to rename all file name to prefix specified by setSvgImagePrefix, or use original name. When the file name overlaps, sequential number is added. When true is specified, all files are renamed.
01621      * 
01622      *
01623      * @param   newVal  specification whether to rename all file name to prefix specified by setSvgImagePrefix, or use original nam
01624      */
01625     void setSvgImageRename(long newVal);
01626 
01627     /**
01628      * Effective when outputting to SVG.
01629      * Gets the prefix of the file name when images are copied to the directory specified by setSvgImageCopyPath and processed.
01630      * 
01631      *
01632      * @param   pVal        Pointer to the buffer that will receive the prefix. If the string is as long or longer than the buffer,
01633      *          the string is truncated and terminated with a NULL character.
01634      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01635      * @return  Returns the 'pVal'.
01636      */
01637     char* getSvgImagePrefix(char* pVal, int size) const;
01638 
01639     /**
01640      * Effective when outputting to SVG.
01641      * When images are copied to the directory specified by setSvgImageCopyPath and processed, specifies the prefix of the file name. The file name will be prefix with sequence numbers. Default is empty character string with only sequential numbers.
01642      * 
01643      *
01644      * @param   newVal  the prefix of the file name.
01645      */
01646     void setSvgImagePrefix(const char* newVal);
01647 
01648     /**
01649      * Effective when outputting to SVG.
01650      * Gets the prefix of the file name when images are copied to the directory specified by setSvgImageCopyPath and processed.
01651      * 
01652      *
01653      * @param   pVal        Pointer to the buffer that will receive the prefix. If the string is as long or longer than the buffer,
01654      *          the string is truncated and terminated with a NULL character.
01655      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01656      * @return  Returns the 'pVal'.
01657      */
01658     wchar_t* getSvgImagePrefixW(wchar_t* pVal, int size) const;
01659 
01660     /**
01661      * Effective when outputting to SVG.
01662      * When images are copied to the directory specified by setSvgImageCopyPath and processed, specifies the prefix of the file name. The file name will be prefix with sequence numbers. Default is empty character string with only sequential numbers.
01663      * 
01664      *
01665      * @param   newVal  the prefix of the file name.
01666      */
01667     void setSvgImagePrefixW(const wchar_t* newVal);
01668 
01669     /**
01670      * Effective when outputting to SVG.
01671      * Gets specification whether to add sequential number to the output SVG even if it has only one-page.
01672      * 
01673      *
01674      * @return  specification whether to add sequential number to the output SVG even if it has only one-page.
01675      */
01676     long getSvgSinglePageNumber() const;
01677 
01678     /**
01679      * Effective when outputting to SVG.
01680      * When setSvgSingleFile = 0 is specified, specifies whether to add sequential number to the output SVG even if it has only one-page. It is not added in case of false.
01681      * 
01682      *
01683      * @param   newVal  specification whether to add sequential number to the output SVG even if it has only one-page.
01684      */
01685     void setSvgSinglePageNumber(long newVal);
01686 
01687 
01688 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
01689     /**
01690      * Effective when outputting to SVG.
01691      * Gets the value of the rasterised-resolution of the transformed raster images.
01692      * 
01693      *
01694      * @return  Rasterised-resolution
01695      */
01696     int getSvgRasterizeResolution() const;
01697 
01698     /**
01699      * Effective when outputting to SVG.
01700      * Specifies the value of the rasterised-resolution of the transformed raster images in the range from 70 to 500(dpi). SVG, EMF and WMF are drawn in SVG as vectors without being transformed to raster images.
01701      * This setting is effective only with Windows version.
01702      * 
01703      *
01704      * @param   newVal  Rasterised-resolution (70 to 500)
01705      */
01706     void setSvgRasterizeResolution(int newVal);
01707 #endif
01708 
01709     /**
01710     * Get the start volume of document to output.
01711     * @since 7.1
01712     *
01713     * @return   start volume of document to output.
01714     */
01715     long getStartVolume() const;
01716 
01717     /**
01718     * Specifies the start volume of document to output.
01719     * If the start volume is omitted or the specified value is 0 or less, the start volume is
01720     * considered from the first volume.
01721     * If the setting is inconsistent, (for example, StartVolume=5 EndVolume=3) an error occurs.
01722     * @since 7.1
01723     *
01724     * @param    newVal  start volume of output.
01725     */
01726     void setStartVolume(long newVal);
01727 
01728     /**
01729     * Get the end volume of document to output.
01730     * @since 7.1
01731     *
01732     * @return   end volume of output.
01733     */
01734     long getEndVolume() const;
01735 
01736     /**
01737     * Specifies the end volume of document to output.
01738     * If the end volume is omitted or the specified value exceeds the actual volume, the end volume
01739     * is considered as the last volume.
01740     * If the setting is inconsistent, (for example, StartVolume=5 EndVolume=3) an error occurs.
01741     * @since 7.1
01742     *
01743     * @param    newVal  end volume of output.
01744     */
01745     void setEndVolume(long newVal);
01746 
01747     /**
01748     * Get multiple volume of PDF output.
01749     * @since 7.1
01750     *
01751     * @return   If zero is returned, multiple volume don't specified.
01752     *           If nonezero is returned, multiple volume specified.
01753     */
01754     long getMultiVolume() const;
01755 
01756     /**
01757     * Specifies multiple volume of PDF output.
01758     * @since 7.1
01759     *
01760     * @param    newVal  Specifies zero or nonzero.
01761     */
01762     void setMultiVolume(long newVal);
01763 
01764     /**
01765      * Get the error level to abort formatting process.
01766      *
01767      * @return  Returns the error level.
01768      */
01769     DfvIfErrorLevel getExitLevel() const;
01770 
01771     /**
01772      * Error level to abort formatting process. Office Server Document Converter will stop formatting when the detected
01773      * error level is equal to ExitLevel property or higher. The default value is 2 (Warning).
01774      * Thus if an error occurred and error level is 2 (Warning) or higher, formatting process will be
01775      * aborted. Please use the value from 1 to 4. When the value of 5 or more specified, it is considered
01776      * to be the value of 4. If a error-level:4 (fatal error) occurs, the formatting process will be
01777      * aborted unconditionally.
01778      * BTW : An error is not displayed no matter what value may be specified to be this property.
01779      *
01780      * <table border="0" cellspacing="0" cellpadding="0">
01781      *  <tr><td>ELVL_INFORMATION    </td><td>= 1 Information</td></tr>
01782      *  <tr><td>ELVL_WARNING        </td><td>= 2 Warning</td></tr>
01783      *  <tr><td>ELVL_RECOVERABLE    </td><td>= 3 Recoveable Error</td></tr>
01784      *  <tr><td>ELVL_FATAL          </td><td>= 4 Fatal Error</td></tr>
01785      * </table>
01786      *
01787      * @param   newVal  error level to abort formatting process.
01788      */
01789     void setExitLevel(DfvIfErrorLevel newVal);
01790 
01791     /**
01792      * Returns the error level of the error that occurred during the formatting process.
01793      *
01794      * <table border="0" cellspacing="0" cellpadding="0">
01795      *  <tr><td>ELVL_INFORMATION    </td><td>= 1 Information</td></tr>
01796      *  <tr><td>ELVL_WARNING        </td><td>= 2 Warning</td></tr>
01797      *  <tr><td>ELVL_RECOVERABLE    </td><td>= 3 Recoveable Error</td></tr>
01798      *  <tr><td>ELVL_FATAL          </td><td>= 4 Fatal Error</td></tr>
01799      * </table>
01800      *
01801      * @return  Returns the error level.
01802      */
01803     DfvIfErrorLevel getErrorLevel() const;
01804 
01805     /**
01806      * Returns the error code of the error that occurred during the formatting process.
01807      * Zero means no error. Non-zero indicates any error occurred.
01808      *
01809      * @return  Returns the error code.
01810      */
01811     DfvIfErrorCode getErrorCode() const;
01812 
01813     /**
01814      * Returns the error message of the error that occurred during the formatting process.
01815      *
01816      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
01817      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01818      * @return  Returns the 'pVal'.
01819      */
01820     char* getErrorMessage(char* pVal, int size) const;
01821     /**
01822      * Returns the error message of the error that occurred during the formatting process.
01823      *
01824      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
01825      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01826      * @return  Returns the 'pVal'.
01827      */
01828     wchar_t* getErrorMessageW(wchar_t* pVal, int size) const;
01829 
01830     /**
01831      * Sets the substitution of font name. This substitution acts on the font names existing in FO.
01832      * The font name 'fontName' is replaced to 'aliasName'.
01833      *
01834      * @param   src     Specifies the font name which is replaced.
01835      * @param   dst     Specifies the aliasName.
01836      */
01837     void setFontAlias(const char* src, const char* dst);
01838     /**
01839      * Sets the substitution of font name. This substitution acts on the font names existing in FO.
01840      * The font name 'fontName' is replaced to 'aliasName'.
01841      *
01842      * @param   src     Specifies the font name which is replaced.
01843      * @param   dst     Specifies the aliasName.
01844      */
01845     void setFontAliasW(const wchar_t* src, const wchar_t* dst);
01846 
01847     /**
01848      * Clear all substitutions of font name.
01849      *
01850      */
01851     void clearFontAlias();
01852 
01853     /**
01854      * Erase the substitution of font name 'fontName'.
01855      *
01856      * @param   src Specifies the font name which is replaced.
01857      */
01858     void eraseFontAlias(const char* src);
01859     /**
01860      * Erase the substitution of font name 'fontName'.
01861      *
01862      * @param   src Specifies the font name which is replaced.
01863      */
01864     void eraseFontAliasW(const wchar_t* src);
01865 
01866     /**
01867      * Execute formatting and output to a PDF specified in OutputFilePath or printer specified in PrinterName.
01868      *
01869      * @param   bNoThrow
01870      * If the value of 'false' is specified, throws XfoException.<BR>
01871      * If the value of 'true' is specified, returns the error code.
01872      * @return  Returns the error code. Zero means no error. Non-zero indicates any error occurred.
01873      */
01874     DfvIfErrorCode execute(bool bNoThrow=false);
01875 
01876     /**
01877      * Executes the formatting of document specified for inputStream, and outputs it to outputStream in the output form specified for setPrinterName.
01878      * @since 4.0
01879      *
01880      * @param   src Specifies document.
01881      * @param   out the output destination of the formatting result.
01882      */
01883     void render(std::istream& src, std::ostream& out);
01884 
01885     /**
01886      * Initialize formatting engine.
01887      *
01888      */
01889     void clear();
01890 
01891     /**
01892      * Register the MessageListener interface to the instance of implemented class
01893      * The error that occurred during the formatting process can be received as the event.
01894      *
01895      * @param   listener Pointer of the MessageListener instance.
01896      */
01897     void setMessageListener(MessageListener* listener);
01898 
01899     /**
01900      * Register the DfvFormatPageListener interface to the instance of implemented class
01901      * The page number that formatted during the formatting process can be received as the event.
01902      *
01903      * @param   listener Pointer of the DfvFormatPageListener instance.
01904      */
01905     void setFormatPageListener(DfvFormatPageListener* listener);
01906 
01907     /**
01908      * Get the printer name where the formatted result is outputted.
01909      *
01910      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
01911      *          the string is truncated and terminated with a NULL character.
01912      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01913      * @return  Returns the 'pVal'.
01914      */
01915     char* getPrinterName(char* pVal, int size) const;
01916     /**
01917      * Get the printer name where the formatted result is outputted.
01918      *
01919      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
01920      *          the string is truncated and terminated with a NULL character.
01921      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01922      * @return  Returns the 'pVal'.
01923      */
01924     wchar_t* getPrinterNameW(wchar_t* pVal, int size) const;
01925 
01926     /**
01927      * Specifies the output format or the printer name to output.
01928      * When a printer name is specified, the formatted result is outputted to that printer.
01929      * When "\@STDPRN" is specified, the converted result is outputted to the currently used printer.
01930      * When "\@PDF" is specified, the converted result is outputted to PDF.
01931      * When "\@SVG" is specified, the converted result is outputted to SVG.
01932      * When "\@INX" is specified, the converted result is outputted to INX.
01933      * When "\@XPS" is specified, the converted result is outputted to XPS.
01934      * When "\@JPEG" is specified, the converted result is outputted to JPEG.
01935      * When "\@PJPEG" is specified, the converted result is output as progressive JPEG.
01936      * When "\@PNG" is specified, the converted result is outputted to PNG.
01937      * When "\@IPNG" is specified, the converted result is output as interlaced PNG.
01938      * When "\@Flash" is specified, the formatted result is outputted to Flash.
01939      * When "\@TIFF" is specified, the converted result is outputted to TIFF.
01940      * When "\@TIFFC" is specified, the converted result is outputted to TIFF CMYK.
01941      * When "\@MTIFF" is specified, the converted result is outputted to multi-page TIFF.
01942      * When "\@MTIFFC" is specified, the converted result is outputted to multi-page TIFF of CMYK.
01943      * When omitted, it is considered as "\@PDF" was specified.
01944      * It's impossible to output to the printer with any OS's other than Windows.
01945      *
01946      * @param   newVal  Pointer to a null-terminated string to be used as the printer name.
01947      */
01948     void setPrinterName(const char* newVal);
01949     /**
01950      * Specifies the output format or the printer name to output.
01951      * When a printer name is specified, the formatted result is outputted to that printer.
01952      * When "\@STDPRN" is specified, the converted result is outputted to the currently used printer.
01953      * When "\@PDF" is specified, the converted result is outputted to PDF.
01954      * When "\@SVG" is specified, the converted result is outputted to SVG.
01955      * When "\@INX" is specified, the converted result is outputted to INX.
01956      * When "\@XPS" is specified, the converted result is outputted to XPS.
01957      * When "\@JPEG" is specified, the converted result is outputted to JPEG.
01958      * When "\@PJPEG" is specified, the converted result is output as progressive JPEG.
01959      * When "\@PNG" is specified, the converted result is outputted to PNG.
01960      * When "\@IPNG" is specified, the converted result is output as interlaced PNG.
01961      * When "\@Flash" is specified, the formatted result is outputted to Flash.
01962      * When "\@TIFF" is specified, the converted result is outputted to TIFF.
01963      * When "\@TIFFC" is specified, the converted result is outputted to TIFF CMYK.
01964      * When "\@MTIFF" is specified, the converted result is outputted to multi-page TIFF.
01965      * When "\@MTIFFC" is specified, the converted result is outputted to multi-page TIFF of CMYK.
01966      * When omitted, it is considered as "\@PDF" was specified.
01967      * It's impossible to output to the printer with any OS's other than Windows.
01968      *
01969      * @param   newVal  Pointer to a null-terminated string to be used as the printer name.
01970      */
01971     void setPrinterNameW(const wchar_t* newVal);
01972 
01973 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
01974 
01975     /**
01976      * Get the number of copies. Effective when outputting to printer.
01977      * This setting is effective only with Windows version.
01978      *
01979      * @return  Returns the number of copies.
01980      */
01981     long getPrnCopies() const;
01982 
01983     /**
01984      * Specifies the number of copies. Effective when outputting to printer.
01985      * If nothing is specified, the value is considered as 1.
01986      * This setting is effective only with Windows version.
01987      *
01988      * @param   newVal  the number of copies.
01989      */
01990     void setPrnCopies(long newVal);
01991 
01992     /**
01993      * Get collation of multiple copies.
01994      * This setting is effective only with Windows version.
01995      *
01996      * @return  If zero is returned, the same page is multi-copied continuously.
01997      *          If nonezero is returned, the pages specified from start to end are printed repeatedly.
01998      */
01999     long getPrnCollate() const;
02000 
02001     /**
02002      * Specifies collation of multiple copies. Effective when outputting to printer and the number of
02003      * copies is plural. If it is not specified or the value zero is specified, the same page is
02004      * multi-copied continuously.
02005      * If nonezero is specified, the pages specified from start to end are printed repeatedly.
02006      * This setting is effective only with Windows version.
02007      *
02008      * @param   newVal  Zpecifies zero or nonzero.
02009      */
02010     void setPrnCollate(long newVal);
02011 
02012     /**
02013      * Get the setting of whether print dialog box is displayed or not when printing
02014      * This setting is effective only with Windows version.
02015      *
02016      * @return  If zero, the print dialog box is displayed. If nonezero, the print dialog box is not displayed.
02017      */
02018     long getBatchPrint() const;
02019 
02020     /**
02021      * When the value 'false' is specified, the print dialog box is displayed when printing.
02022      * If the setting is omitted or the value 'true' is specified, the print dialog is not displayed.
02023      * This setting is effective only with Windows version.
02024      *
02025      * @param   newVal  If zero, the print dialog box is displayed. If nonezero, the print dialog box is not displayed.
02026      */
02027     void setBatchPrint(long newVal);
02028 
02029 #endif // defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))   /* WIN32 */
02030 
02031     /**
02032      * Get the version string of Office Server Document Converter.
02033      * 
02034      *
02035      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
02036      *          the string is truncated and terminated with a NULL character.
02037      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
02038      * @return  Returns the 'pVal'.
02039      */
02040     char* getVersion(char* pVal, int size) const;
02041 
02042     /**
02043      * Get the version string of Office Server Document Converter.
02044      * 
02045      *
02046      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
02047      *          the string is truncated and terminated with a NULL character.
02048      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
02049      * @return  Returns the 'pVal'.
02050      */
02051     wchar_t* getVersionW(wchar_t* pVal, int size) const;
02052 
02053     /**
02054      * Get INX output mode.
02055      *
02056      * @return  output mode of INX.
02057      */
02058     DfvINXOUTPUTMODE getInxOutputMode() const;
02059 
02060     /**
02061      * Set INX output mode.
02062      *
02063      * @param   newVal mode of INX.
02064      */
02065     void setInxOutputMode(DfvINXOUTPUTMODE newVal);
02066 
02067     /**
02068      * Get the specification that omit blank pages. return Specification that omit blank pages 
02069      */
02070     bool getOmitBlankPages();
02071     
02072     /**
02073      * In MS Word files, skip a blank page when it is at the beginning of the document.
02074      * Skip also if a page at the beginning of the document is only header and footer.
02075      * In MS Excel files, skip a blank page.
02076      * The original file is valid only for MS Word or MS Excel.
02077      * To skip and get only the page with the first content found, specify this property in combination with setEndPage = 1.
02078      * Operation in combination with anything other than setEndPage = 1 is not guaranteed.
02079      *
02080      * @param   newVal      If the value is 'true' is specified, omit blank pages 
02081      */
02082     void setOmitBlankPages(bool newVal);
02083 
02084     /**
02085      * Get specifies of the FlashPartiallyOutput.
02086      * @since 2.1
02087      *
02088      * @return  specifies of FlashPartiallyOutput.
02089      */
02090     long getFlashPartiallyOutput() const;
02091 
02092     /**
02093      * When an error occurs within the document, the flash file in process will be outputted.
02094      * Effective when outputting to Flash.
02095      * @since 2.1
02096      *
02097      * @param   newVal  Specifies zero or nonzero.
02098      */
02099     void setFlashPartiallyOutput(long newVal);
02100 
02101     /**
02102      * Get specifies of the FlashHidePageButton.
02103      * @since 3.0
02104      *
02105      * @return  specifies of FlashHidePageButton.
02106      */
02107     long getFlashHidePageButton() const;
02108 
02109     /**
02110      * Output a no page button. Effective when outputting to Flash.
02111      * @since 3.0
02112      *
02113      * @param   newVal  If the value is 'true' is specified, output a no page button.
02114      */
02115     void setFlashHidePageButton(long newVal);
02116 
02117     /**
02118      * Get the setting of the FlashSplitPage.
02119      *
02120      * @return
02121      * Specify FlashSplitPage.
02122      */
02123     bool getFlashSplitPage() const;
02124 
02125     /**
02126      * Outputs Flash file per page and saves as every single file..<BR>
02127      * Effective when outputting to Flash.
02128      *
02129      * @param newVal
02130      * If 'true' is specified, do not output Flash file per page.
02131      */
02132     void setFlashSplitPage(bool newVal);
02133 
02134     /**
02135      * Get the setting of FlashOutputAction.
02136      *
02137      * @return
02138      * Specify FlashOutputAction.
02139      */
02140     bool getFlashOutputAction() const;
02141 
02142     /**
02143      * Do not output features of ActionScript1.0, such as stop action per page, the page navigation button, linking, etc..<BR>
02144      * Effective when outputting to Flash.
02145      *
02146      * @param newVal
02147      * If 'true' is specified, do not output Flash file per page.
02148      */
02149     void setFlashOutputAction(bool newVal);
02150 
02151     /**
02152      * Get the setting of FlashImageLimitSize.
02153      *
02154      * @return
02155      * Specify FlashImageLimitSize.
02156      */
02157     int getFlashImageLimitSize() const;
02158 
02159     /**
02160      * Specifies the number of maximum pixels of images outputted to the Flash file by the integral value. 
02161      * When the width or the height of the output image exceeds the specified value, 
02162      * it is reduced to the specified value when outputting the flash file. 
02163      * When this parameter is omitted, 1000 is applied.  <BR>
02164      * The image size that can be embedded in Flash is limited to the value of width x height with 2 raised to the 24th power (16,777,216) 
02165      * by the number of pixels. Please note that when embedded image exceeds this size, 
02166      it may not be displayed with Flash Player.<BR>
02167      * Effective when outputting to Flash.
02168      *
02169      * @param newVal
02170      * If 'true' is specified, do not output Flash file per page.
02171      */
02172     void setFlashImageLimitSize(int newVal);
02173 
02174 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
02175 
02176     /**
02177      * It print at size of paper.
02178      * Default is false.
02179      * Effective only when outputting to image with Windows version. 
02180      * 
02181      * @param   newVal      If the value is 'true' is specified, print at size of paper. 
02182      */
02183     void setPrnFitPaper(bool newVal);
02184 
02185 #endif  // #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
02186 
02187 
02188     /**
02189      * Get the image resolution when outputting JPEG and PNG.
02190      * Effective only when outputting to image with Windows version and Linux version 6.0 or later. 
02191      *
02192      * @return      Image resolution
02193      */
02194     int getRasterDPI(void) const;
02195 
02196     /**
02197     * Sets the image resolution when outputting JPEG and PNG.
02198     * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02199      *
02200      * @param   newVal      Image resolution (1 to 1440) 
02201      */
02202     void setRasterDPI(int newVal);
02203 
02204     /**
02205      * Get the image scale when outputting JPEG and PNG.
02206      * Effective only when outputting to image with Windows version and Linux version 6.0 or later. 
02207      *
02208      * @param   pVal
02209      *      Pointer to the buffer that will receive the text.
02210      *      If the string is as long or longer than the buffer,
02211      *      the string is truncated and terminated with a NULL character.
02212      * @param   size
02213      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02214      *      If the text exceeds this limit, it is truncated.
02215      * @return  Returns the 'pVal'.
02216      */
02217     char* getRasterScale(char* pVal, int size) const;
02218 
02219     /**
02220      * Get the image scale when outputting JPEG and PNG.
02221      * Effective only when outputting to image with Windows version and Linux version 6.0 or later. 
02222      *
02223      * @param   pVal
02224      *      Pointer to the buffer that will receive the text.
02225      *      If the string is as long or longer than the buffer,
02226      *      the string is truncated and terminated with a NULL character.
02227      * @param   size
02228      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02229      *      If the text exceeds this limit, it is truncated.
02230      * @return  Returns the 'pVal'.
02231      */
02232     wchar_t* getRasterScaleW(wchar_t* pVal, int size) const;
02233 
02234     /**
02235      * Sets the image scale when outputting JPEG and PNG.
02236      * A numerical value, "%", or "px" (pixel) is available as the unit.
02237      * Specify the percentage for a numerical value and "%", and specify the width of image for pixel.
02238      * Effective only when outputting to image with Windows version and Linux version 6.0 or later. 
02239      *
02240      * @param   newVal      Image scale 
02241      */
02242     void setRasterScale(const char* newVal);
02243 
02244     /**
02245      * Sets the image scale when outputting JPEG and PNG.
02246      * A numerical value, "%", or "px" (pixel) is available as the unit.
02247      * Specify the percentage for a numerical value and "%", and specify the width of image for pixel.
02248      * Effective only when outputting to image with Windows version and Linux version 6.0 or later. 
02249      *
02250      * @param   newVal      Image scale 
02251      */
02252     void setRasterScaleW(const wchar_t* newVal);
02253 
02254     /**
02255      * Get the maximum image height when outputting JPEG and PNG.<BR>
02256      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02257      *
02258      * @return          Maximum image height
02259      */
02260     int getRasterHeight() const;
02261 
02262     /**
02263      * Sets the maximum image height decided by setRasterScale when outputting JPEG and PNG.<BR>
02264      * "px" (pixel) is available as the unit. 
02265      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02266      *
02267      * @param   newVal  Maximum image height
02268      */
02269     void setRasterHeight(int newVal);
02270 
02271     /**
02272      * Get the file name naming format when outputting PNG and JPEG.<BR>
02273      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02274      *
02275      * @param   pVal
02276      *      Pointer to the buffer that will receive the text.
02277      *      If the string is as long or longer than the buffer,
02278      *      the string is truncated and terminated with a NULL character.
02279      * @param   size
02280      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02281      *      If the text exceeds this limit, it is truncated.
02282      * @return  Returns the 'pVal'.
02283      */
02284     char* getRasterFormat(char* pVal, int size) const;
02285 
02286     /**
02287      * Get the file name naming format when outputting PNG and JPEG.<BR>
02288      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02289      *
02290      * @param   pVal
02291      *      Pointer to the buffer that will receive the text.
02292      *      If the string is as long or longer than the buffer,
02293      *      the string is truncated and terminated with a NULL character.
02294      * @param   size
02295      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02296      *      If the text exceeds this limit, it is truncated.
02297      * @return  Returns the 'pVal'.
02298      */
02299     wchar_t* getRasterFormatW(wchar_t* pVal, int size) const;
02300 
02301     /**
02302      * Specifies the file name naming format when outputting PNG and JPEG.<BR>
02303      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02304      *
02305      * @param   newVal  format for naming files
02306      */
02307     void setRasterFormat(const char* newVal);
02308 
02309     /**
02310      * Specifies the file name naming format when outputting PNG and JPEG.<BR>
02311      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02312      *
02313      * @param   newVal  format for naming files
02314      */
02315     void setRasterFormatW(const wchar_t* newVal);
02316 
02317     /**
02318      * Get the conversion accuracy when outputting JPEG.<BR>
02319      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02320      *
02321      * @return          JPEG quality
02322      */
02323     int getRasterJpegQuality() const;
02324 
02325     /**
02326      * Specifies the conversion accuracy by the value with the range of 1-100(%) when outputting JPEG.<BR>
02327      * When this parameter is omitted, it is regarded as 80%.
02328      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02329      *
02330      * @param   newVal  JPEG quality
02331      */
02332     void setRasterJpegQuality(int newVal);
02333 
02334 
02335 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
02336 
02337     /**
02338      * Gets specification whether to use GdiPlus .<BR>
02339      * Effective only when outputting to image with Windows version
02340      *
02341      * @return          Specification whether to use GdiPlus.
02342      */
02343     bool getRasterUseGdiPlus() const;
02344 
02345     /**
02346      * GdiPlus is used when the file is converted to Jpeg or PNG.<BR>
02347      * This setting is effective only with Windows Vista or later / Windows Server 2003.
02348      * Effective only when outputting to image with Windows version
02349      *
02350      * @param newVal Specifies whether to use GdiPlus.
02351      */
02352     void setRasterUseGdiPlus(bool newVal);
02353 
02354     /**
02355      * Gets specification whether to convert to monochrome image, when outputting JPEG and PNG.<BR>
02356      * Effective only when outputting to image with Windows version
02357      *
02358      * @return          Specification whether to convert to monochrome.
02359      */
02360     bool getRasterMonochrome() const;
02361 
02362     /**
02363      * Specifies whether to convert to monochrome image, when outputting JPEG and PNG.<BR>
02364      * Effective only when outputting to image with Windows version
02365      *
02366      * @param newVal Specifies whether to convert to monochrome.
02367      */
02368     void setRasterMonochrome(bool newVal);
02369 
02370 #endif // defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
02371 
02372 
02373     /**
02374      * Get the path name of RGB ICC profile for input when outputting CMYK TIFF.
02375      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02376      *
02377      * @param   pVal
02378      *      Pointer to the buffer that will receive the text.
02379      *      If the string is as long or longer than the buffer,
02380      *      the string is truncated and terminated with a NULL character.
02381      * @param   size
02382      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02383      *      If the text exceeds this limit, it is truncated.
02384      * @return  Returns the 'pVal'.
02385      */
02386     char* getRasterRGBProfile(char* pVal, int size) const;
02387 
02388     /**
02389      * Get the path name of RGB ICC profile for input when outputting CMYK TIFF.
02390      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02391      *
02392      * @param   pVal
02393      *      Pointer to the buffer that will receive the text. 
02394      *      If the string is as long or longer than the buffer,
02395      *      the string is truncated and terminated with a NULL character.
02396      * @param   size
02397      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02398      *      If the text exceeds this limit, it is truncated.
02399      * @return  Returns the 'pVal'.
02400      */
02401     wchar_t* getRasterRGBProfileW(wchar_t* pVal, int size) const;
02402 
02403     /**
02404      * Set the path name of RGB ICC profile for input when outputting CMYK TIFF.
02405      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02406      *
02407      * @param   newVal
02408      *      Pointer to a null-terminated string.
02409      */
02410     void setRasterRGBProfile(const char* newVal);
02411 
02412     /**
02413      * Set the path name of RGB ICC profile for input when outputting CMYK TIFF.
02414      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02415      *
02416      * @param   newVal
02417      *      Pointer to a null-terminated string.
02418      */
02419     void setRasterRGBProfileW(const wchar_t* newVal);
02420 
02421     /**
02422      * Get the path name of CMYK ICC profile for output when outputting CMYK TIFF.
02423      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02424      *
02425      * @param   pVal
02426      *      Pointer to the buffer that will receive the text.
02427      *      If the string is as long or longer than the buffer,
02428      *      the string is truncated and terminated with a NULL character.
02429      * @param   size
02430      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02431      *      If the text exceeds this limit, it is truncated.
02432      * @return  Returns the 'pVal'.
02433      */
02434     char* getRasterCMYKProfile(char* pVal, int size) const;
02435 
02436     /**
02437      * Get the path name of CMYK ICC profile for output when outputting CMYK TIFF.
02438      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02439      *
02440      * @param   pVal
02441      *      Pointer to the buffer that will receive the text. 
02442      *      If the string is as long or longer than the buffer,
02443      *      the string is truncated and terminated with a NULL character.
02444      * @param   size
02445      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02446      *      If the text exceeds this limit, it is truncated.
02447      * @return  Returns the 'pVal'.
02448      */
02449     wchar_t* getRasterCMYKProfileW(wchar_t* pVal, int size) const;
02450 
02451     /**
02452      * Set the path name of CMYK ICC profile for output when outputting CMYK TIFF.
02453      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02454      *
02455      * @param   newVal
02456      *      Pointer to a null-terminated string.
02457      */
02458     void setRasterCMYKProfile(const char* newVal);
02459 
02460     /**
02461      * Set the path name of CMYK ICC profile for output when outputting CMYK TIFF.
02462      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02463      *
02464      * @param   newVal
02465      *      Pointer to a null-terminated string.
02466      */
02467     void setRasterCMYKProfileW(const wchar_t* newVal);
02468 
02469     /**
02470      * Get the setting of whether to convert images to grayscale 256 tones.
02471      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02472      *
02473      * @return 
02474      * Specify whether to convert images to grayscale 256 tones.
02475      */
02476     bool getRasterGrayscale() const;
02477 
02478     /**
02479      * Outputs grayscale 256 tones..<BR>
02480      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02481      *
02482      * @param newVal
02483      * If "true" is specified, convert images to grayscale 256 tones.
02484      */
02485     void setRasterGrayscale(bool newVal);
02486 
02487 
02488 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
02489 
02490     /**
02491      * Get the setting of whether to convert images to 256 colors, and only Windows version.
02492      * Effective only when outputting to image with Windows version
02493      *
02494      * @return
02495      * Specify whether to convert images to 256 colors.
02496      */
02497     bool getRaster256Color() const;
02498 
02499     /**
02500      * Outputs 256 colors..<BR>
02501      * Effective only when outputting to image with Windows version
02502      *
02503      * @param newVal
02504      * If "true" is specified, convert images to 256 colors.
02505      */
02506     void setRaster256Color(bool newVal);
02507 
02508 #endif // defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
02509 
02510 
02511     /**
02512      * Get the compression method when outputting TIFF / MTIFF.
02513      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02514      *
02515      * @param   pVal
02516      *      Pointer to the buffer that will receive the text.
02517      *      If the string is as long or longer than the buffer,
02518      *      the string is truncated and terminated with a NULL character.
02519      * @param   size
02520      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02521      *      If the text exceeds this limit, it is truncated.
02522      * @return  Returns the 'pVal'.
02523      */
02524     char* getRasterCompression(char* pVal, int size) const;
02525 
02526     /**
02527      * Get the compression method when outputting TIFF / MTIFF.
02528      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02529      *
02530      * @param   pVal
02531      *      Pointer to the buffer that will receive the text.
02532      *      If the string is as long or longer than the buffer,
02533      *      the string is truncated and terminated with a NULL character.
02534      * @param   size
02535      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02536      *      If the text exceeds this limit, it is truncated.
02537      * @return  Returns the 'pVal'.
02538      */
02539     wchar_t* getRasterCompressionW(wchar_t* pVal, int size) const;
02540 
02541     /**
02542      * Specifies the compression method when outputting TIFF / MTIFF.<BR>
02543      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02544      * The compression method.<BR>
02545      * none : None<BR>
02546      * lzw : ZLIB compression(When this parameter is omitted, lzw is applied.)<BR>
02547      * dct : DCTDecode<BR>
02548      * flate : FlateDecode<BR>
02549      * runlength : Run Length compression<BR>
02550      * ccitt3 : CCITT Group3<BR>
02551      * ccitt4 : CCITT Group4<BR>
02552      *
02553      * @param   newVal
02554      *      Pointer to a null-terminated string.
02555      */
02556     void setRasterCompression(const char* newVal);
02557 
02558     /**
02559      * Specifies the compression method when outputting TIFF / MTIFF.<BR>
02560      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02561      * The compression method.<BR>
02562      * none : None<BR>
02563      * lzw : ZLIB compression(When this parameter is omitted, lzw is applied.)<BR>
02564      * dct : DCTDecode<BR>
02565      * flate : FlateDecode<BR>
02566      * runlength : Run Length compression<BR>
02567      * ccitt3 : CCITT Group3<BR>
02568      * ccitt4 : CCITT Group4<BR>
02569      *
02570      * @param   newVal
02571      *      Pointer to a null-terminated string.
02572      */
02573     void setRasterCompressionW(const wchar_t* newVal);
02574 
02575 
02576     /**
02577      * Specifies the height of the paper when inputting text.
02578      * Effective when inputting text. 
02579      *
02580      * @param   newVal      the height of paper 
02581      */
02582     void setTextPaperHeight(const char* newVal);
02583 
02584     /**
02585      * Specifies the height of the paper when inputting text.
02586      * Effective when inputting text. 
02587      *
02588      * @param   newVal      the height of paper 
02589      */
02590     void setTextPaperHeightW(const wchar_t* newVal);
02591 
02592     /**
02593      * Specifies the width of the paper when inputting text.
02594      * Effective when inputting text. 
02595      *
02596      * @param   newVal      the width of paper 
02597      */
02598     void setTextPaperWidth(const char* newVal);
02599 
02600     /**
02601      * Specifies the width of the paper when inputting text.
02602      * Effective when inputting text. 
02603      *
02604      * @param   newVal      the width of paper 
02605      */
02606     void setTextPaperWidthW(const wchar_t* newVal);
02607 
02608     /**
02609      * Specifies the left margin of the paper when inputting text.
02610      * Effective when inputting text. 
02611      *
02612      * @param   newVal       the left margin of the paper 
02613      */
02614     void setTextMarginLeft(const char* newVal);
02615 
02616     /**
02617      * Specifies the left margin of the paper when inputting text.
02618      * Effective when inputting text. 
02619      *
02620      * @param   newVal       the left margin of the paper 
02621      */
02622     void setTextMarginLeftW(const wchar_t* newVal);
02623 
02624     /**
02625      * Specifies the right margin of the paper when inputting text.
02626      * Effective when inputting text. 
02627      *
02628      * @param   newVal      the top margin of the paper 
02629      */
02630     void setTextMarginTop(const char* newVal);
02631 
02632     /**
02633      * Specifies the right margin of the paper when inputting text.
02634      * Effective when inputting text. 
02635      *
02636      * @param   newVal      the top margin of the paper 
02637      */
02638     void setTextMarginTopW(const wchar_t* newVal);
02639 
02640     /**
02641      * Specifies the right margin of the paper when inputting text.
02642      * Effective when inputting text. 
02643      *
02644      * @param   newVal      the right margin of the paper 
02645      */
02646     void setTextMarginRight(const char* newVal);
02647 
02648     /**
02649      * Specifies the right margin of the paper when inputting text.
02650      * Effective when inputting text. 
02651      *
02652      * @param   newVal      the right margin of the paper 
02653      */
02654     void setTextMarginRightW(const wchar_t* newVal);
02655 
02656     /**
02657      * Specifies the right margin of the paper when inputting text.
02658      * Effective when inputting text. 
02659      *
02660      * @param   newVal      the bottom margin of the paper 
02661      */
02662     void setTextMarginBottom(const char* newVal);
02663 
02664     /**
02665      * Specifies the right margin of the paper when inputting text.
02666      * Effective when inputting text. 
02667      *
02668      * @param   newVal      the bottom margin of the paper 
02669      */
02670     void setTextMarginBottomW(const wchar_t* newVal);
02671 
02672     /**
02673      * Specifies the font family name when inputting text.
02674      * Effective when inputting text. 
02675      *
02676      * @param   newVal      font family name 
02677      */
02678     void setTextFontFamily(const char* newVal);
02679 
02680     /**
02681      * Specifies the font family name when inputting text.
02682      * Effective when inputting text. 
02683      *
02684      * @param   newVal      font family name 
02685      */
02686     void setTextFontFamilyW(const wchar_t* newVal);
02687 
02688     /**
02689      * Specifies the font size when inputting text.
02690      * Effective when inputting text. 
02691      *
02692      * @param   newVal      font size 
02693      */
02694     void setTextFontSize(const char* newVal);
02695 
02696     /**
02697      * Specifies the font size when inputting text.
02698      * Effective when inputting text. 
02699      *
02700      * @param   newVal      font size 
02701      */
02702     void setTextFontSizeW(const wchar_t* newVal);
02703 
02704     /**
02705      * Specifies the value of whether show page number or not when inputting text.
02706      * Effective when inputting text. 
02707      * 
02708      * @param   newVal      the value of whether show page number or not 
02709      */
02710     void setTextShowPageNumber(bool newVal);
02711 
02712     /**
02713      * Specifies the value of whether show page number or not when inputting text.
02714      * Effective when inputting text. 
02715      * 
02716      * @param   newVal      the value of whether show page number or not    
02717      */
02718     void setTextShowLineNumber(bool newVal);
02719 
02720     /**
02721      * Specifies the offset value of range from body area when showing line number and inputting text.
02722      * Effective when inputting text. 
02723      * 
02724      * @param   newVal      the offset value
02725      */
02726     void setTextLineNumberOffset(const char* newVal);
02727 
02728     /**
02729      * Specifies the offset value of range from body area when showing line number and inputting text.
02730      * Effective when inputting text. 
02731      * 
02732      * @param   newVal      the offset value
02733      */
02734     void setTextLineNumberOffsetW(const wchar_t* newVal);
02735 
02736     /**
02737      * Specifies the line number format when showing line number and inputting text.
02738      * Effective when inputting text. 
02739      * 
02740      * @param   newVal      line number format  
02741      */
02742     void setTextLineNumberFormat(const char* newVal);
02743 
02744     /**
02745      * Specifies the line number format when showing line number and inputting text.
02746      * Effective when inputting text. 
02747      * 
02748      * @param   newVal      line number format  
02749      */
02750     void setTextLineNumberFormatW(const wchar_t* newVal);
02751 
02752 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
02753 
02754     /**
02755      * Acquires the setting of the smoothing processing to text.<BR>
02756      * This setting is effective only with Windows Vista or later / Windows Server 2003 or later.
02757      *
02758      * @return          
02759      * Specify whether to perform the smoothing processing to text.
02760      */
02761     bool getGdiTextAntialias() const;
02762 
02763     /**
02764      * Performs the smoothing processing to text.<BR>
02765      * Effective only when printing and outputting images.<BR>
02766      * This setting is effective only with Windows Vista or later / Windows Server 2003 or later.
02767      *
02768      * @param   newVal  
02769      * Performs the smoothing processing when true is specified.
02770      */
02771     void setGdiTextAntialias(bool newVal);
02772 
02773     /**
02774      * Acquires the setting of the smoothing processing to borders.<BR>
02775      * This setting is effective only with Windows Vista or later / Windows Server 2003 or later.
02776      *
02777      * @return          
02778      * Specify whether to perform the smoothing processing to borders.
02779      */
02780     bool getGdiLineartSmoothing() const;
02781 
02782     /**
02783      * Performs the smoothing processing to borders.<BR>
02784      * Effective only when printing and outputting images.<BR>
02785      * This setting is effective only with Windows Vista or later / Windows Server 2003 or later.
02786      *
02787      * @param   newVal  
02788      * Performs the smoothing processing when true is specified.
02789      */
02790     void setGdiLineartSmoothing(bool newVal);
02791 
02792     /**
02793      * Acquires the setting of the smoothing processing to images.<BR>
02794      * This setting is effective only with Windows Vista or later / Windows Server 2003 or later.
02795      *
02796      * @return          
02797      * Specify whether to perform the smoothing processing to images.
02798      */
02799     bool getGdiImageSmoothing() const;
02800 
02801     /**
02802      * Performs the smoothing processing to images.<BR>
02803      * Effective only when printing and outputting images.<BR>
02804      * This setting is effective only with Windows Vista or later / Windows Server 2003 or later.
02805      *
02806      * @param   newVal  
02807      * Performs the smoothing processing when true is specified.
02808      */
02809     void setGdiImageSmoothing(bool newVal);
02810 
02811 #endif // defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
02812 
02813     /**
02814      * Get the watermark text on each page. 
02815      *
02816      * @param   pVal
02817      *      Pointer to the buffer that will receive the text.
02818      *      If the string is as long or longer than the buffer,
02819      *      the string is truncated and terminated with a NULL character.
02820      * @param   size
02821      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02822      *      If the text exceeds this limit, it is truncated.
02823      * @return  Returns the 'pVal'.
02824      */
02825     char* getWatermarkText(char* pVal, int size) const;
02826 
02827     /**
02828      * Get watermark text on each page.
02829      *
02830      * @param   pVal
02831      *      Pointer to the buffer that will receive the text. 
02832      *      If the string is as long or longer than the buffer,
02833      *      the string is truncated and terminated with a NULL character.
02834      * @param   size
02835      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02836      *      If the text exceeds this limit, it is truncated.
02837      * @return  Returns the 'pVal'.
02838      */
02839     wchar_t* getWatermarkTextW(wchar_t* pVal, int size) const;
02840 
02841     /**
02842      * Displays the specified watermark text on each page. 
02843      * Possible to make it multiple lines by delimiting with the line feed \n. 
02844      * This setting is invalid with the evaluation version.  
02845      *
02846      * @param   newVal
02847      *      Pointer to a null-terminated string.
02848      */
02849     void setWatermarkText(const char* newVal);
02850 
02851     /**
02852      * Displays the specified watermark text on each page. 
02853      * Possible to make it multiple lines by delimiting with the line feed \n. 
02854      * This setting is invalid with the evaluation version.  
02855      *
02856      * @param   newVal
02857      *      Pointer to a null-terminated string.
02858      */
02859     void setWatermarkTextW(const wchar_t* newVal);
02860 
02861     /**
02862      * Get the font family of the watermark text. 
02863      *
02864      * @param   pVal
02865      *      Pointer to the buffer that will receive the text.
02866      *      If the string is as long or longer than the buffer,
02867      *      the string is truncated and terminated with a NULL character.
02868      * @param   size
02869      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02870      *      If the text exceeds this limit, it is truncated.
02871      * @return  Returns the 'pVal'.
02872      */
02873     char* getWatermarkFontFamily(char* pVal, int size) const;
02874 
02875     /**
02876      * Get the font family of the watermark text.
02877      *
02878      * @param   pVal
02879      *      Pointer to the buffer that will receive the text. 
02880      *      If the string is as long or longer than the buffer,
02881      *      the string is truncated and terminated with a NULL character.
02882      * @param   size
02883      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02884      *      If the text exceeds this limit, it is truncated.
02885      * @return  Returns the 'pVal'.
02886      */
02887     wchar_t* getWatermarkFontFamilyW(wchar_t* pVal, int size) const;
02888 
02889     /**
02890      * Specifies the font family to the character string which you set to watermark-text.  
02891      *
02892      * @param   newVal
02893      *      Pointer to a null-terminated string.
02894      */
02895     void setWatermarkFontFamily(const char* newVal);
02896 
02897     /**
02898      * Specifies the font family to the character string which you set to watermark-text.  
02899      *
02900      * @param   newVal
02901      *      Pointer to a null-terminated string.
02902      */
02903     void setWatermarkFontFamilyW(const wchar_t* newVal);
02904 
02905     /**
02906      * Get the font weight of the watermark text. 
02907      *
02908      * @param   pVal
02909      *      Pointer to the buffer that will receive the text.
02910      *      If the string is as long or longer than the buffer,
02911      *      the string is truncated and terminated with a NULL character.
02912      * @param   size
02913      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02914      *      If the text exceeds this limit, it is truncated.
02915      * @return  Returns the 'pVal'.
02916      */
02917     char* getWatermarkFontWeight(char* pVal, int size) const;
02918 
02919     /**
02920      * Get the font weight of the watermark text.  
02921      *
02922      * @param   pVal
02923      *      Pointer to the buffer that will receive the text. 
02924      *      If the string is as long or longer than the buffer,
02925      *      the string is truncated and terminated with a NULL character.
02926      * @param   size
02927      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02928      *      If the text exceeds this limit, it is truncated.
02929      * @return  Returns the 'pVal'.
02930      */
02931     wchar_t* getWatermarkFontWeightW(wchar_t* pVal, int size) const;
02932 
02933     /**
02934      * Specifies the font weight to the character string which you set to watermark-text. 
02935      * Possible to specify normal, bold or the numerical value from 100 to 900.  
02936      *
02937      * @param   newVal
02938      *      Pointer to a null-terminated string.
02939      */
02940     void setWatermarkFontWeight(const char* newVal);
02941 
02942     /**
02943      * Specifies the font weight to the character string which you set to watermark-text. 
02944      * Possible to specify normal, bold or the numerical value from 100 to 900.  
02945      *
02946      * @param   newVal
02947      *      Pointer to a null-terminated string.
02948      */
02949     void setWatermarkFontWeightW(const wchar_t* newVal);
02950 
02951     /**
02952      * Get the font style of the watermark text.
02953      *
02954      * @param   pVal
02955      *      Pointer to the buffer that will receive the text.
02956      *      If the string is as long or longer than the buffer,
02957      *      the string is truncated and terminated with a NULL character.
02958      * @param   size
02959      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02960      *      If the text exceeds this limit, it is truncated.
02961      * @return  Returns the 'pVal'.
02962      */
02963     char* getWatermarkFontStyle(char* pVal, int size) const;
02964 
02965     /**
02966      * Get the font style of the watermark text.  
02967      *
02968      * @param   pVal
02969      *      Pointer to the buffer that will receive the text. 
02970      *      If the string is as long or longer than the buffer,
02971      *      the string is truncated and terminated with a NULL character.
02972      * @param   size
02973      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02974      *      If the text exceeds this limit, it is truncated.
02975      * @return  Returns the 'pVal'.
02976      */
02977     wchar_t* getWatermarkFontStyleW(wchar_t* pVal, int size) const;
02978 
02979     /**
02980      * Specifies the font style to the character string which you set to watermark-text.  
02981      *
02982      * @param   newVal
02983      *      Pointer to a null-terminated string.
02984      */
02985     void setWatermarkFontStyle(const char* newVal);
02986 
02987     /**
02988      * Specifies the font style to the character string which you set to watermark-text.  
02989      *
02990      * @param   newVal
02991      *      Pointer to a null-terminated string.
02992      */
02993     void setWatermarkFontStyleW(const wchar_t* newVal);
02994 
02995     /**
02996      * Get the opacity of the watermark text.
02997      *
02998      * @param   pVal
02999      *      Pointer to the buffer that will receive the text.
03000      *      If the string is as long or longer than the buffer,
03001      *      the string is truncated and terminated with a NULL character.
03002      * @param   size
03003      *      Specifies the number of the 'pVal' buffer, including the NULL character.
03004      *      If the text exceeds this limit, it is truncated.
03005      * @return  Returns the 'pVal'.
03006      */
03007     char* getWatermarkOpacity(char* pVal, int size) const;
03008 
03009     /**
03010      * Get the opacity of the watermark text.   
03011      *
03012      * @param   pVal
03013      *      Pointer to the buffer that will receive the text. 
03014      *      If the string is as long or longer than the buffer,
03015      *      the string is truncated and terminated with a NULL character.
03016      * @param   size
03017      *      Specifies the number of the 'pVal' buffer, including the NULL character.
03018      *      If the text exceeds this limit, it is truncated.
03019      * @return  Returns the 'pVal'.
03020      */
03021     wchar_t* getWatermarkOpacityW(wchar_t* pVal, int size) const;
03022 
03023     /**
03024      * Specifies the opacity to the character string which you set to watermark-text.  
03025      *
03026      * @param   newVal
03027      *      Pointer to a null-terminated string.
03028      */
03029     void setWatermarkOpacity(const char* newVal);
03030 
03031     /**
03032      * Specifies the opacity to the character string which you set to watermark-text.  
03033      *
03034      * @param   newVal
03035      *      Pointer to a null-terminated string.
03036      */
03037     void setWatermarkOpacityW(const wchar_t* newVal);
03038 
03039     /**
03040      * Gets the setting of continuous page numbers across worksheets in Excel header footer/number of pages as a total of all worksheets.
03041      *
03042      * @return          
03043      * If true, inserts continuous page numbers across all worksheets/number of pages as a total of all worksheets.
03044      */
03045     bool getContinuePageNumber() const;
03046 
03047     /**
03048      * Sets continuous page numbers across worksheets in Excel header footer/number of pages as a total of all worksheets.
03049      *
03050      * @param   newVal  
03051      * If true, sets continuous page numbers across all worksheets/number of pages as a total of all worksheets.
03052      */
03053     void setContinuePageNumber(bool newVal);
03054 
03055     /**
03056      * Get the ICC profile file name.
03057      *
03058      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03059      *          the string is truncated and terminated with a NULL character.
03060      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03061      * @return  Returns the 'pVal'.
03062      */
03063     char* getPdfColorProfile(char* pVal, int size) const;
03064     /**
03065      * Get the ICC profile file name.
03066      *
03067      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03068      *          the string is truncated and terminated with a NULL character.
03069      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03070      * @return  Returns the 'pVal'.
03071      */
03072     wchar_t* getPdfColorProfileW(wchar_t* pVal, int size) const;
03073 
03074     /**
03075      * Set the ICC profile file name.
03076      * When PDF/A-1b:2005 or PDF/A-2b:2011 is specified for PdfVersion, the ICC profile must be specified. In that case, specify the full path of the ICC profile to this parameter. This parameter is invalid except for PDF/A-1b:2005 and PDF/A-2b:2011.
03077      *
03078      * @param   newVal  Pointer to a null-terminated string to be used as the ICC profile file name.
03079      */
03080     void setPdfColorProfile(const char* newVal);
03081 
03082     /**
03083      * Set the ICC profile file name.
03084      * When PDF/A-1b:2005 or PDF/A-2b:2011 is specified for PdfVersion, the ICC profile must be specified. In that case, specify the full path of the ICC profile to this parameter. This parameter is invalid except for PDF/A-1b:2005 and PDF/A-2b:2011.
03085      *
03086      * @param   newVal  Pointer to a null-terminated string to be used as the ICC profile file name.
03087      */
03088     void setPdfColorProfileW(const wchar_t* newVal);
03089 
03090     /**
03091      * Specifies the open password for document.
03092      *
03093      * @param   newVal
03094      *      Pointer to a null-terminated string.
03095      */
03096     void setOpenPassword(const char* newVal);
03097 
03098     /**
03099      * Specifies the open password for document.
03100      *
03101      * @param   newVal
03102      *      Pointer to a null-terminated string.
03103      */
03104     void setOpenPasswordW(const wchar_t* newVal);
03105 
03106     /**
03107      * Get the setting of Support for correct number of pages in Word.
03108      *
03109      * @return
03110      * If true, support for correct number of pages and dynamically updating table of contents in Word.
03111      */
03112     long getPageNumberCorrection() const;
03113 
03114     /**
03115      * Set the setting of Support for correct number of pages in Word.
03116      *
03117      * @param   newVal
03118      * If true, sets support for correct number of pages and dynamically updating table of contents in Word.
03119      */
03120     void setPageNumberCorrection(long newVal);
03121 
03122     /**
03123      * Gets the specified sheet first to output the active sheet when files are saved in MS Excel.
03124      *
03125      * @return Return to specify the active sheet to sheet top output when files are saved in MS Excel.
03126      */
03127     bool getSheetOrderActiveFirst() const;
03128     
03129     /**
03130      * Set to specify the active sheet to sheet top output when files are saved in MS Excel.
03131      *
03132      * @param   newVal      If the value is 'true' is specified, Set to specify the active sheet to sheet top output when files are saved in MS Excel
03133      */
03134     void setSheetOrderActiveFirst(bool newVal);
03135 
03136     /**
03137      * Get the sheet order and select.
03138      *
03139      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03140      *          the string is truncated and terminated with a NULL character.
03141      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03142      * @return  Returns the 'pVal'.
03143      */
03144     char* getSheetOrderSelect(char* pVal, int size) const;
03145     /**
03146      * Get the sheet order and select.
03147      *
03148      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03149      *          the string is truncated and terminated with a NULL character.
03150      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03151      * @return  Returns the 'pVal'.
03152      */
03153     wchar_t* getSheetOrderSelectW(wchar_t* pVal, int size) const;
03154 
03155     /**
03156      * Set the sheet order and select.
03157      *
03158      * @param   newVal  Pointer to a null-terminated string to be used as the sheet order and select.
03159      */
03160     void setSheetOrderSelect(const char* newVal);
03161 
03162     /**
03163      * Set the sheet order and select.
03164      *
03165      * @param   newVal  Pointer to a null-terminated string to be used as the sheet order and select.
03166      */
03167     void setSheetOrderSelectW(const wchar_t* newVal);
03168 
03169     /**
03170      * Get the locale.
03171      *
03172      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03173      *          the string is truncated and terminated with a NULL character.
03174      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03175      * @return  Returns the 'pVal'.
03176      */
03177     char* getLocale(char* pVal, int size) const;
03178     /**
03179      * Get the locale.
03180      *
03181      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03182      *          the string is truncated and terminated with a NULL character.
03183      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03184      * @return  Returns the 'pVal'.
03185      */
03186     wchar_t* getLocaleW(wchar_t* pVal, int size) const;
03187 
03188     /**
03189      * Set the locale.
03190      *
03191      * @param   newVal  Pointer to a null-terminated string to be used as the locale.
03192      */
03193     void setLocale(const char* newVal);
03194 
03195     /**
03196      * Set the locale.
03197      *
03198      * @param   newVal  Pointer to a null-terminated string to be used as the locale.
03199      */
03200     void setLocaleW(const wchar_t* newVal);
03201 
03202     /**
03203      * Get the RowColControl configuration file name.
03204      *
03205      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03206      *          the string is truncated and terminated with a NULL character.
03207      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03208      * @return  Returns the 'pVal'.
03209      */
03210     char* getRowColControlFileName(char* pVal, int size) const;
03211 
03212     /**
03213      * Get the RowColControl configuration file name.
03214      *
03215      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03216      *          the string is truncated and terminated with a NULL character.
03217      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03218      * @return  Returns the 'pVal'.
03219      */
03220     wchar_t* getRowColControlFileNameW(wchar_t* pVal, int size) const;
03221 
03222     /**
03223      * Set the RowColControl configuration file name.
03224      *
03225      * @param   newVal  Pointer to a null-terminated string to be used as the file name.
03226      */
03227     void setRowColControlFileName(const char* newVal);
03228 
03229     /**
03230      * Set the RowColControl configuration file name.
03231      *
03232      * @param   newVal  Pointer to a null-terminated string to be used as the file name.
03233      */
03234     void setRowColControlFileNameW(const wchar_t* newVal);
03235 
03236     /**
03237      * Get the RowColControl parameter row,col string.
03238      *
03239      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03240      *          the string is truncated and terminated with a NULL character.
03241      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03242      * @return  Returns the 'pVal'.
03243      */
03244     char* getRowColControlParameter(char* pVal, int size) const;
03245 
03246     /**
03247      * Get the RowColControl parameter row,col string.
03248      *
03249      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03250      *          the string is truncated and terminated with a NULL character.
03251      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03252      * @return  Returns the 'pVal'.
03253      */
03254     wchar_t* getRowColControlParameterW(wchar_t* pVal, int size) const;
03255 
03256     /**
03257      * Set the RowColControl parameter row,col.
03258      *
03259      * @param   newVal  Pointer to a null-terminated string to be used as the parameter row,col string.
03260      */
03261     void setRowColControlParameter(const char* newVal);
03262 
03263     /**
03264      * Set the RowColControl parameter row,col.
03265      *
03266      * @param   newVal  Pointer to a null-terminated string to be used as the parameter row,col string.
03267      */
03268     void setRowColControlParameterW(const wchar_t* newVal);
03269 
03270     /**
03271      * Gets the view information option.
03272      *   default font name/size in file & printer name in sheet and matched parameter.
03273      *
03274      * @return Return to this option.
03275      */
03276     bool getXlsInfoView() const;
03277     
03278     /**
03279      * Set the view information option.
03280      *   default font name/size in file & printer name in sheet and matched parameter.
03281      *
03282      * @param   newVal      If the value is 'true' is specified, Set to the view information option.
03283      */
03284     void setXlsInfoView(bool newVal);
03285 
03286     /**
03287      * Get the XlsPaperDefault parameter string.
03288      *
03289      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03290      *          the string is truncated and terminated with a NULL character.
03291      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03292      * @return  Returns the 'pVal'.
03293      */
03294     char* getXlsPaperDefault(char* pVal, int size) const;
03295 
03296     /**
03297      * Get the XlsPaperDefault parameter string.
03298      *
03299      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03300      *          the string is truncated and terminated with a NULL character.
03301      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03302      * @return  Returns the 'pVal'.
03303      */
03304     wchar_t* getXlsPaperDefaultW(wchar_t* pVal, int size) const;
03305 
03306     /**
03307      * Set the XlsPaperDefault parameter.
03308      *
03309      * @param   newVal  Pointer to a null-terminated string to be used as the parameter string.
03310      */
03311     void setXlsPaperDefault(const char* newVal);
03312 
03313     /**
03314      * Set the XlsPaperDefault parameter.
03315      *
03316      * @param   newVal  Pointer to a null-terminated string to be used as the parameter string.
03317      */
03318     void setXlsPaperDefaultW(const wchar_t* newVal);
03319 
03320     /**
03321      * Get the XlsPaper parameter string.
03322      *
03323      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03324      *          the string is truncated and terminated with a NULL character.
03325      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03326      * @return  Returns the 'pVal'.
03327      */
03328     char* getXlsPaper(char* pVal, int size) const;
03329 
03330     /**
03331      * Get the XlsPaper parameter string.
03332      *
03333      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03334      *          the string is truncated and terminated with a NULL character.
03335      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03336      * @return  Returns the 'pVal'.
03337      */
03338     wchar_t* getXlsPaperW(wchar_t* pVal, int size) const;
03339 
03340     /**
03341      * Set the XlsPaper parameter.
03342      *
03343      * @param   newVal  Pointer to a null-terminated string to be used as the parameter string.
03344      */
03345     void setXlsPaper(const char* newVal);
03346 
03347     /**
03348      * Set the XlsPaper parameter.
03349      *
03350      * @param   newVal  Pointer to a null-terminated string to be used as the parameter string.
03351      */
03352     void setXlsPaperW(const wchar_t* newVal);
03353 
03354 
03355     /**
03356      * Get whether Word outline level is reflected on PDF bookmark hierarchy.
03357      *
03358      * @return  If 1-9, Generates a hierarchy and folds it at the hierarchy value.
03359      *          If 0, Does not generate a hierarchy.
03360      */
03361     int getDocPdfBookmarkLevel() const;
03362 
03363     /**
03364      * Specifies whether Word outline level is reflected on PDF bookmark hierarchy.
03365      *
03366      * @param   newVal  If 1-9, Generates a hierarchy and folds it at the hierarchy value.
03367      *                  If 0, Does not generate a hierarchy.
03368      */
03369     void setDocPdfBookmarkLevel(int newVal);
03370 
03371 
03372     /**
03373      * Get specification to output only selected sheet when files are saved in MS Excel.
03374      *
03375      * @return Return to specify to output only selected sheet when files are saved in MS Excel.
03376      */
03377     bool getXlsSelectedSheet() const;
03378     
03379 
03380     /**
03381      * Set to output only the selected sheet when files are saved in MS Excel.
03382      *
03383      * @param   newVal      If the value is 'true' is specified, only the selected sheet is output when files are saved in MS Excel
03384      */
03385     void setXlsSelectedSheet(bool newVal);
03386 
03387     /**
03388      * Get whether to output Notes page in PowerPoint.
03389      *
03390      * @return Return If true is returened, Notes page is output.
03391      *                If false is returned, Slide (normal layout) is output.
03392      */
03393     bool getPptNotes() const;
03394 
03395     /**
03396      * Specifies whether to output Notes page in PowerPoint.
03397      *
03398      * @param newVal If true, Notes page is output.
03399      *                If false, Slide (normal layout) is output.
03400      */
03401     void setPptNotes(bool newVal);
03402 
03403 
03404     /**
03405      * Gets the output track change option in MS Word.
03406      * @return Return to this option.
03407      */
03408     bool getDocTrackChange() const;
03409     
03410 
03411     /**
03412      * Set the output track change option.
03413      *
03414      * @param   newVal      If the value is 'true' is specified, Set to the output track change option in MS Word.
03415      */
03416     void setDocTrackChange(bool newVal);
03417 
03418     /**
03419      * Gets the tagged-pdf output.
03420      * @return Return to this option.
03421      */
03422     long getPdfTag() const;
03423 
03424 
03425     /**
03426      * Set the tagged-pdf output.
03427      *
03428      * @param   newVal      If the value is 'true' is specified, Set to the output tagged-pdf.
03429      */
03430     void setPdfTag(long newVal);
03431     
03432     /**
03433      * Get the linkfile output.
03434      *
03435      * @return Return to this option.
03436      */
03437     bool getLinkfile() const;
03438 
03439     /**
03440      * Set the linkfile output.
03441      *
03442      * @param newVal If the value is 'true' is specified, Set to the output linkfile.
03443      */
03444     void setLinkfile(bool newVal);
03445 
03446     /**
03447      * Get whether to non-output property.
03448      *
03449      * @return Return If the value is 'true' is specified, Set to the non-output property.
03450      */
03451     bool getPropertyNonOutput() const;
03452 
03453     /**
03454      * Specifies whether to non-output property.
03455      *
03456      * @param newVal If the value is 'true' is specified, Set to the non-output property.
03457      */
03458     void setPropertyNonOutput(bool newVal);
03459 
03460     /**
03461      * Get the output cell-area parameter string.
03462      *
03463      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03464      *          the string is truncated and terminated with a NULL character.
03465      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03466      * @return  Returns the 'pVal'.
03467      */
03468     char* getXlsOutputArea(char* pVal, int size) const;
03469 
03470     /**
03471      * Get the output cell-area parameter string.
03472      *
03473      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03474      *          the string is truncated and terminated with a NULL character.
03475      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03476      * @return  Returns the 'pVal'.
03477      */
03478     wchar_t* getXlsOutputAreaW(wchar_t* pVal, int size) const;
03479 
03480     /**
03481      * Set the output cell-area parameter.
03482      *
03483      * @param   newVal  Pointer to a null-terminated string to be used as the parameter string.
03484      */
03485     void setXlsOutputArea(const char* newVal);
03486 
03487     /**
03488      * Set the output cell-area parameter.
03489      *
03490      * @param   newVal  Pointer to a null-terminated string to be used as the parameter string.
03491      */
03492     void setXlsOutputAreaW(const wchar_t* newVal);
03493 
03494 
03495 
03496     void setOutputSVGFilePath( const char* newVal);
03497     void setOutputSVGFilePathW( const wchar_t* newVal);
03498 
03499 
03500     /**
03501      * Gets the NonOutline option in MS Word.
03502      * @return Return to this option.
03503      */
03504     bool getDocNonOutline() const;
03505     
03506 
03507     /**
03508      * Set the NonOutline option.
03509      *
03510      * @param   newVal      If the value is 'true' is specified, Set to the Do not convert outlines to bookmarks.
03511      */
03512     void setDocNonOutline(bool newVal);
03513 
03514 
03515 
03516     /**
03517      * Gets the IndexHyperLink option in MS Word.
03518      *
03519      * @return Return to this option.
03520      */
03521     int getIndexHyperLink() const;
03522 
03523     /**
03524      * Set the IndexHyperLink option in MS Word.<BR>
03525      * Page number of the index page is hyperlinked to the term marked as index entries in the body text (index term) when converting from Word (docx) to PDF.
03526      * 
03527      * @param   newVal  0, Does not generate a Index Hyperlink.
03528      *                  1, Link to the index terms from the first page to the index page.
03529      *                  2, Link to the index terms on pages after the index page too (processing time will be doubled).
03530      */
03531     void setIndexHyperLink(int newVal);
03532 
03533 
03534     /**
03535      * Gets specification whether to use Direct2d .<BR>
03536      * Effective only when outputting to image with Windows version
03537      *
03538      * @return          Specification whether to use Direct2d.
03539      */
03540     bool getRasterUseDirect2d() const;
03541 
03542     /**
03543      * Direct2d is used when the file is converted to Raster image.<BR>
03544      * This setting is effective only with Windows Vista or later / Windows Server 2003.
03545      * Effective only when outputting to image with Windows version
03546      *
03547      * @param newVal Specifies whether to use Direct2d.
03548      */
03549     void setRasterUseDirect2d(bool newVal);
03550 
03551 };
03552 
03553 /***************************************************************
03554  * Exception class that returns the error information in the formatting process.
03555  */
03556 class DFVINTERFACE_API DfvException
03557 {
03558 public:
03559     /**
03560      * Constructor
03561      */
03562     DfvException(DfvIfErrorLevel errorLevel, DfvIfErrorCode errorCode, const wchar_t* errorMessage);
03563 
03564     /**
03565      * Copy constructor
03566      */
03567     DfvException(const DfvException &e);
03568 
03569     /**
03570      * Destructor
03571      */
03572     ~DfvException();
03573 
03574 private:
03575     DfvIfErrorLevel m_errorLevel;           /* Error level */
03576     DfvIfErrorCode  m_errorCode;            /* Error code */
03577     wchar_t*        m_errorMessage;         /* Error message */
03578 
03579 public:
03580     /**
03581      * Get the error level.
03582      *
03583      * @return  Returns the error level.
03584      */
03585     DfvIfErrorLevel getErrorLevel() const;
03586 
03587     /**
03588      * Get the error code.
03589      *
03590      * @return  Returns the error code.
03591      */
03592     DfvIfErrorCode getErrorCode() const;
03593 
03594     /**
03595      * Get the error message.
03596      *
03597      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03598      *          the string is truncated and terminated with a NULL character.
03599      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03600      * @return  Returns the 'pVal'.
03601      */
03602     char* getErrorMessage(char* pVal, int size) const;
03603 
03604     /**
03605      * Get the error message.
03606      *
03607      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03608      *          the string is truncated and terminated with a NULL character.
03609      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03610      * @return  Returns the 'pVal'.
03611      */
03612     wchar_t* getErrorMessageW(wchar_t* pVal, int size) const;
03613 
03614 };
03615 
03616 }
03617 
03618 #endif  /* DFVIFC_H__ */

Generated on 5 Sep 2025 for Office Server Document Converter C/C++ Interface by Doxygen 1.3-rc2