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  * Server Based 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 Server Based 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 Server Based 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 Server Based 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 Server Based 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 Server Based 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 Server Based 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 Server Based 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 xfo_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 embed all embeddable fonts
00769      * 
00770      *
00771      * <table border="0" cellspacing="0" cellpadding="0">
00772      *  <tr><td>EMBALLFONT_PART </td><td>= 0 Specified fonts </td></tr>
00773      *  <tr><td>EMBALLFONT_ALL  </td><td>= 1 All fonts except Base14 fonts</td></tr>
00774      *  <tr><td>EMBALLFONT_BASE14   </td><td>= 2 All fonts</td></tr>
00775      * </table>
00776      *
00777      * @return  the value of whether to embed all embeddable fonts
00778      */
00779     DfvEMBEDALLFONT getPdfEmbedAllFontsEx(void) const;
00780 
00781     /**
00782      * Effective when outputting to PDF.
00783      * 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.
00784      * 
00785      *
00786      * <table border="0" cellspacing="0" cellpadding="0">
00787      *  <tr><td>EMBALLFONT_PART </td><td>= 0 Specified fonts </td></tr>
00788      *  <tr><td>EMBALLFONT_ALL  </td><td>= 1 All fonts except Base14 fonts</td></tr>
00789      *  <tr><td>EMBALLFONT_BASE14   </td><td>= 2 All fonts</td></tr>
00790      * </table>
00791      *
00792      *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.
00793      *
00794      * @param   newVal  the value of whether to embed all embeddable fonts
00795      */
00796     void setPdfEmbedAllFontsEx(DfvEMBEDALLFONT newVal);
00797 
00798     /**
00799      * Effective when outputting to PDF.
00800      * Gets the value of method to downsample the color image
00801      * 
00802      *
00803      * @return  the value of method to downsample the color image
00804      */
00805     DfvIMAGEDOWNSAMPLING getPdfImageDownSampling(void) const;
00806 
00807     /**
00808      * Effective when outputting to PDF.
00809      * Specifies the following either of method to downsample the color image that is put into PDF.
00810      * 
00811      *
00812      * <table border="0" cellspacing="0" cellpadding="0">
00813      *  <tr><td>IMGDOWNSAMPLING_NONE    </td><td>= 0 No downsampling </td></tr>
00814      *  <tr><td>IMGDOWNSAMPLING_AVERAGE </td><td>= 1 Average downsamplin</td></tr>
00815      *  <tr><td>IMGDOWNSAMPLING_BICUBIC </td><td>= 2 Bicubic downsampling</td></tr>
00816      *  <tr><td>IMGDOWNSAMPLING_SUBSAMPLING </td><td>= 3 Subsampling</td></tr>
00817      * </table>
00818      *
00819      * 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.
00820 This is the setting for the color image. Spesify setPdfGrayscaleImageDownSampling for the grayscale image, and setPdfMonochromeImageDownSampling for the monochrome image.
00821      *
00822      * @param   newVal  the value of method to downsample the color image
00823      */
00824     void setPdfImageDownSampling(DfvIMAGEDOWNSAMPLING newVal);
00825 
00826     /**
00827      * Effective when outputting to PDF.
00828      * Gets resolution when the color image is downsampled.
00829      * 
00830      *
00831      * @return  the value of resolution.
00832      */
00833     int getPdfImageDownSamplingTarget(void) const;
00834 
00835     /**
00836      * Effective when outputting to PDF.
00837      * Set resolution when the color image is downsampled.
00838      * 
00839      *
00840      * @param   newVal  the value of resolution.
00841      */
00842     void setPdfImageDownSamplingTarget(int newVal);
00843 
00844     /**
00845      * Effective when outputting to PDF.
00846      * Gets resolution of the color image which performs a downsampling.
00847      * 
00848      *
00849      * @return  the value of resolution.
00850      */
00851     int getPdfImageDownSamplingDPI(void) const;
00852 
00853     /**
00854      * Effective when outputting to PDF.
00855      * Set resolution of the color image which performs a downsampling.
00856      * 
00857      *
00858      * @param   newVal  the value of resolution.
00859      */
00860     void setPdfImageDownSamplingDPI(int newVal);
00861 
00862     /**
00863      * Effective when outputting to PDF.
00864      * Gets specification whether to embed to PDF the ICC profile of the color image that will be embedded to PDF.
00865      * 
00866      *
00867      * @return  If nonezero is specified, it is embedded. If zero is specified, it is not embedded.
00868      */
00869     long getPdfPutImageColorProfile(void) const;
00870 
00871     /**
00872      * Effective when outputting to PDF.
00873      * Specifies whether to embed to PDF the ICC profile of the color image that will be embedded to PDF.
00874      * 
00875      *
00876      * @param   newVal  If nonezero is specified, it is embedded. If zero is specified, it is not embedded.
00877      */
00878     void setPdfPutImageColorProfile(long newVal);
00879 
00880     /**
00881      * Effective when outputting to PDF.
00882      * Gets the value of how to compress the grayscale images embedded in PDF.
00883      * 
00884      *
00885      * <table border="0" cellspacing="0" cellpadding="0">
00886      *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto</td></tr>
00887      *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG compression</td></tr>
00888      *  <tr><td>IMGCMPR_ZLIB    </td><td>= 2 ZLIB compression</td></tr>
00889      *  <tr><td>IMGCMPR_JPEG2K  </td><td>= 3 JPEG2000 compression</td></tr>
00890      * </table>
00891      *
00892      * @return  the value of how raster graphics are compressed and stored
00893      */
00894     DfvPDFIMAGECOMPRESSION getPdfGrayscaleImageCompression(void) const;
00895 
00896     /**
00897      * Effective when outputting to PDF.
00898      * 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>
00899      * 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>
00900 This is the setting for the grayscale image. Spesify setPdfImageCompression for the color image, and setPdfMonochromeImageCompression for the monochrome image.
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      * @param   newVal  the value of how raster graphics are compressed and stored
00911      */
00912     void setPdfGrayscaleImageCompression(DfvPDFIMAGECOMPRESSION newVal);
00913 
00914     /**
00915      * Effective when outputting to PDF.
00916      * Gets the value of the quality of JPEG format that is specified by xfo_setPdfGrayscaleImageCompression stored in PDF.
00917      * 
00918      *
00919      * @return  the value of the quality of JPEG format
00920      */
00921     int getPdfGrayscaleJPEGQuality(void) const;
00922 
00923     /**
00924      * Effective when outputting to PDF.
00925      * 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>
00926      * CAUTION: It is not for changing the quality of a JPEG format image.<BR>
00927      * This is the setting for the grayscale image. Spesify setPdfJPEGQuality for the color image.
00928      * 
00929      *
00930      * @param   newVal  the value of the quality of JPEG format
00931      */
00932     void setPdfGrayscaleJPEGQuality(int newVal);
00933 
00934     /**
00935      * Effective when outputting to PDF.
00936      * Gets the value of method to downsample the grayscale image
00937      * 
00938      *
00939      * @return  the value of method to downsample the grayscale image
00940      */
00941     DfvIMAGEDOWNSAMPLING getPdfGrayscaleImageDownSampling(void) const;
00942 
00943     /**
00944      * Effective when outputting to PDF.
00945      * Specifies the following either of method to downsample the grayscale image that is put into PDF.
00946      * 
00947      *
00948      * <table border="0" cellspacing="0" cellpadding="0">
00949      *  <tr><td>IMGDOWNSAMPLING_NONE    </td><td>= 0 No downsampling </td></tr>
00950      *  <tr><td>IMGDOWNSAMPLING_AVERAGE </td><td>= 1 Average downsamplin</td></tr>
00951      *  <tr><td>IMGDOWNSAMPLING_BICUBIC </td><td>= 2 Bicubic downsampling</td></tr>
00952      *  <tr><td>IMGDOWNSAMPLING_SUBSAMPLING </td><td>= 3 Subsampling</td></tr>
00953      * </table>
00954      *
00955      * 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.
00956 This is the setting for the grayscale image. Spesify setPdfImageDownSampling for the color image, and setPdfMonochromeImageDownSampling for the monochrome image.
00957      *
00958      * @param   newVal  the value of method to downsample the grayscale image
00959      */
00960     void setPdfGrayscaleImageDownSampling(DfvIMAGEDOWNSAMPLING newVal);
00961 
00962     /**
00963      * Effective when outputting to PDF.
00964      * Gets resolution when the grayscale image is downsampled.
00965      * 
00966      *
00967      * @return  the value of resolution.
00968      */
00969     int getPdfGrayscaleImageDownSamplingTarget(void) const;
00970 
00971     /**
00972      * Effective when outputting to PDF.
00973      * Set resolution when the grayscale image is downsampled.
00974      * 
00975      *
00976      * @param   newVal  the value of resolution.
00977      */
00978     void setPdfGrayscaleImageDownSamplingTarget(int newVal);
00979 
00980     /**
00981      * Effective when outputting to PDF.
00982      * Gets resolution of the grayscale image which performs a downsampling.
00983      * 
00984      *
00985      * @return  the value of resolution.
00986      */
00987     int getPdfGrayscaleImageDownSamplingDPI(void) const;
00988 
00989     /**
00990      * Effective when outputting to PDF.
00991      * Set resolution of the grayscale image which performs a downsampling.
00992      * 
00993      *
00994      * @param   newVal  the value of resolution.
00995      */
00996     void setPdfGrayscaleImageDownSamplingDPI(int newVal);
00997 
00998     /**
00999      * Effective when outputting to PDF.
01000      * Gets the value of how to compress the monochrome images embedded in PDF.
01001      * 
01002      *
01003      * <table border="0" cellspacing="0" cellpadding="0">
01004      *  <tr><td>MONOCMPR_CCITT4     </td><td>= 0 CCITTFaxDecode group 4 filter,default value</td></tr>
01005      *  <tr><td>MONOCMPR_CCITT3     </td><td>= 1 CCITTFaxDecode group 3 filter</td></tr>
01006      *  <tr><td>MONOCMPR_RUNLENGTH  </td><td>= 2 RunLengthDecode filter</td></tr>
01007      *  <tr><td>MONOCMPR_ZLIB       </td><td>= 3 FlateDecode filter</td></tr>
01008      *  <tr><td>MONOCMPR_OFF        </td><td>= 4 no filter</td></tr>
01009      * </table>
01010      *
01011      * @return  the value of how raster graphics are compressed and stored
01012      */
01013     DfvMONOCHROMECOMPRESSION getPdfMonochromeImageCompression(void) const;
01014 
01015     /**
01016      * Effective when outputting to PDF.
01017      * 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>
01018 This is the setting for the monochrome image. Spesify setPdfGrayscaleImageCompression for the grayscale image, and setPdfImageCompression for the color image.
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      * @param   newVal  the value of how raster graphics are compressed and stored
01030      */
01031     void setPdfMonochromeImageCompression(DfvMONOCHROMECOMPRESSION newVal);
01032 
01033     /**
01034      * Effective when outputting to PDF.
01035      * Gets the value of method to downsample the monochrome image
01036      * 
01037      *
01038      * @return  the value of method to downsample the monochrome image
01039      */
01040     DfvIMAGEDOWNSAMPLING getPdfMonochromeImageDownSampling(void) const;
01041 
01042     /**
01043      * Effective when outputting to PDF.
01044      * Specifies the following either of method to downsample the monochrome image that is put into PDF.
01045      * 
01046      *
01047      * <table border="0" cellspacing="0" cellpadding="0">
01048      *  <tr><td>IMGDOWNSAMPLING_NONE    </td><td>= 0 No downsampling </td></tr>
01049      *  <tr><td>IMGDOWNSAMPLING_AVERAGE </td><td>= 1 Average downsamplin</td></tr>
01050      *  <tr><td>IMGDOWNSAMPLING_BICUBIC </td><td>= 2 Bicubic downsampling</td></tr>
01051      *  <tr><td>IMGDOWNSAMPLING_SUBSAMPLING </td><td>= 3 Subsampling</td></tr>
01052      * </table>
01053      *
01054      * 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.
01055 This is the setting for the monochrome image. Spesify setPdfImageDownSampling for the color image, and setPdfGrayscaleImageDownSampling for the grayscale image.
01056      *
01057      * @param   newVal  the value of method to downsample the monochrome image
01058      */
01059     void setPdfMonochromeImageDownSampling(DfvIMAGEDOWNSAMPLING newVal);
01060 
01061     /**
01062      * Effective when outputting to PDF.
01063      * Gets resolution when the monochrome image is downsampled.
01064      * 
01065      *
01066      * @return  the value of resolution.
01067      */
01068     int getPdfMonochromeImageDownSamplingTarget(void) const;
01069 
01070     /**
01071      * Effective when outputting to PDF.
01072      * Set resolution when the monochrome image is downsampled.
01073      * 
01074      *
01075      * @param   newVal  the value of resolution.
01076      */
01077     void setPdfMonochromeImageDownSamplingTarget(int newVal);
01078 
01079     /**
01080      * Effective when outputting to PDF.
01081      * Gets resolution of the monochrome image which performs a downsampling.
01082      * 
01083      *
01084      * @return  the value of resolution.
01085      */
01086     int getPdfMonochromeImageDownSamplingDPI(void) const;
01087 
01088     /**
01089      * Effective when outputting to PDF.
01090      * Set resolution of the monochrome image which performs a downsampling.
01091      * 
01092      *
01093      * @param   newVal  the value of resolution.
01094      */
01095     void setPdfMonochromeImageDownSamplingDPI(int newVal);
01096 
01097     /**
01098      * Effective when outputting to PDF.
01099      * Gets the width of PDF to output.
01100      * 
01101      *
01102      * @param   pVal        Pointer to the buffer that will receive the width of PDF. If the string is as long or longer than the buffer,
01103      *          the string is truncated and terminated with a NULL character.
01104      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01105      * @return  Returns the 'pVal'.
01106      */
01107     char* getPdfOutputWidth(char* pVal, int size) const;
01108 
01109     /**
01110      * Effective when outputting to PDF.
01111      * Gets the width of PDF to output.
01112      * 
01113      *
01114      * @param   pVal        Pointer to the buffer that will receive the width of PDF. If the string is as long or longer than the buffer,
01115      *          the string is truncated and terminated with a NULL character.
01116      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01117      * @return  Returns the 'pVal'.
01118      */
01119     wchar_t* getPdfOutputWidthW(wchar_t* pVal, int size) const;
01120 
01121     /**
01122      * Effective when outputting to PDF.
01123      * Scales the width of PDF to output. A value with a unit or % value can be specified as length.
01124      * 
01125      *
01126      * @param   newVal  Pointer to a null-terminated string to be used as the width of PDF to output.
01127      */
01128     void setPdfOutputWidth(const char* newVal);
01129 
01130     /**
01131      * Effective when outputting to PDF.
01132      * Scales the width of PDF to output. A value with a unit or % value can be specified as length.
01133      * 
01134      *
01135      * @param   newVal  Pointer to a null-terminated string to be used as the width of PDF to output.
01136      */
01137     void setPdfOutputWidthW(const wchar_t* newVal);
01138 
01139     /**
01140      * Effective when outputting to PDF.
01141      * Gets the height of PDF to output.
01142      * 
01143      *
01144      * @param   pVal        Pointer to the buffer that will receive the height of PDF. If the string is as long or longer than the buffer,
01145      *          the string is truncated and terminated with a NULL character.
01146      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01147      * @return  Returns the 'pVal'.
01148      */
01149     char* getPdfOutputHeight(char* pVal, int size) const;
01150 
01151     /**
01152      * Effective when outputting to PDF.
01153      * Gets the height of PDF to output.
01154      * 
01155      *
01156      * @param   pVal        Pointer to the buffer that will receive the height of PDF. If the string is as long or longer than the buffer,
01157      *          the string is truncated and terminated with a NULL character.
01158      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01159      * @return  Returns the 'pVal'.
01160      */
01161     wchar_t* getPdfOutputHeightW(wchar_t* pVal, int size) const;
01162 
01163     /**
01164      * Effective when outputting to PDF.
01165      * Scales the height of PDF to output. A value with a unit or % value can be specified as length.
01166      * 
01167      *
01168      * @param   newVal  Pointer to a null-terminated string to be used as the width of PDF to output.
01169      */
01170     void setPdfOutputHeight(const char* newVal);
01171 
01172     /**
01173      * Effective when outputting to PDF.
01174      * Scales the height of PDF to output. A value with a unit or % value can be specified as length.
01175      * 
01176      *
01177      * @param   newVal  Pointer to a null-terminated string to be used as the width of PDF to output.
01178      */
01179     void setPdfOutputHeightW(const wchar_t* newVal);
01180 
01181     /**
01182     * Specifies the scaling ratio of the PDF to output.
01183     * A value with a unit or % value can be specified as length.
01184     * Effective when outputting to PDF.
01185     *
01186     * @param    newVal      the scaling ratio of the PDF
01187     */
01188     void setPdfOutputScale(const char* newVal);
01189 
01190     /**
01191     * Specifies the scaling ratio of the PDF to output.
01192     * A value with a unit or % value can be specified as length.
01193     * Effective when outputting to PDF.
01194     *
01195     * @param    newVal      the scaling ratio of the PDF
01196     */
01197     void setPdfOutputScaleW(const wchar_t* newVal);
01198 
01199     /**
01200      * Effective when outputting to PDF.
01201      * Gets the value of whether to issue error or not when PDF/X is generating.
01202      * 
01203      *
01204      * @return  the value of whether to issue error.
01205      */
01206     long getPdfErrorOnPDFXFault();
01207 
01208     /**
01209      * Effective when outputting to PDF.
01210      * An error is not issued when PDF/X is generating.
01211      * 
01212      *
01213      * @param   newVal  If the value is 'true' is specified, no error is issued.
01214      */
01215     void setPdfErrorOnPDFXFault(long newVal);
01216 
01217     /**
01218      * Effective when inputting from PDF.
01219      * Specifies whether to output PDF Annotation.
01220      * 
01221      *
01222      * @return  If true is returned, Annotation is output.
01223      *          If false is returned, Annotation is not output.
01224      */
01225     bool getPdfAnnotation() const;
01226 
01227     /**
01228      * Effective when inputting from PDF.
01229      * Gets the setting indicating whether to output PDF Annotation.
01230      * 
01231      *
01232      * @param   newVal  If true is specified, Annotation is output.
01233      */
01234     void setPdfAnnotation(bool newVal);
01235 
01236     /**
01237      * Effective when outputting to SVG.
01238      * Get the version of SVG.
01239      * 
01240      *
01241      * @return  the version of SVG.
01242      */
01243     DfvSVGVERSION   getSvgVersion() const;
01244 
01245     /**
01246      * Effective when outputting to SVG.
01247      * Enables specifying whether the version of SVG is 1.1, Basic or Tiny.
01248      * 
01249      *
01250      * @param   newVal  Specifies the version of SVG.
01251      */
01252     void setSvgVersion(DfvSVGVERSION newVal);
01253 
01254     /**
01255      * Effective when outputting to SVG.
01256      * Gets the setting indicating whether to compress the outputted SVG into gzip format or not.
01257      * 
01258      *
01259      * @return  whether gzip compression or not.
01260      */
01261     long getSvgGzipCompression() const;
01262 
01263     /**
01264      * Effective when outputting to SVG.
01265      * Specifies whether to compress the outputted SVG into gzip format or not.
01266      * 
01267      *
01268      * @param   newVal      If the value is 'true' is specified, enables to compress data into gzip format.
01269      */
01270     void setSvgGzipCompression(long newVal);
01271 
01272     /**
01273      * Effective when outputting to SVG.
01274      * Gets the setting indicating whether to embed fonts in the outputted SVG.
01275      * 
01276      *
01277      * @return  whether embeds fonts or not.
01278      */
01279     long getSvgEmbedAllFonts() const;
01280 
01281     /**
01282      * Effective when outputting to SVG.
01283      * Specifies whether to embed fonts in the outputted SVG.
01284      * 
01285      *
01286      * @param   newVal      If the value is 'true' is specified, embeds fonts.
01287      */
01288     void setSvgEmbedAllFonts(long newVal);
01289 
01290     /**
01291      * Effective when outputting to SVG.
01292      * Gets the format for naming files when the outputted SVG becomes multiple.
01293      * 
01294      *
01295      * @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.
01296      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01297      * @return  Returns the 'pVal'.
01298      */
01299     char* getSvgFormat(char* pVal, int size) const;
01300 
01301     /**
01302      * Effective when outputting to SVG.
01303      * Gets the format for naming files when the outputted SVG becomes multiple.
01304      * 
01305      *
01306      * @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.
01307      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01308      * @return  Returns the 'pVal'.
01309      */
01310     wchar_t* getSvgFormatW(wchar_t* pVal, int size) const;
01311 
01312     /**
01313      * Effective when outputting to SVG.
01314      * Specifies the format for naming files when the outputted SVG becomes multiple.
01315      * 
01316      *
01317      * @param   newVal  Pointer to a null-terminated string to be used as the SVG file name format.
01318      */
01319     void setSvgFormat(const char* newVal);
01320 
01321     /**
01322      * Effective when outputting to SVG.
01323      * Specifies the format for naming files when the outputted SVG becomes multiple.
01324      * 
01325      *
01326      * @param   newVal  Pointer to a null-terminated string to be used as the SVG file name format.
01327      */
01328     void setSvgFormatW(const wchar_t* newVal);
01329 
01330     /**
01331      * Effective when outputting to SVG.
01332      * Gets the font specified to be embedded in SVG.
01333      * 
01334      *
01335      * @param   pVal        Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer,
01336      *          the string is truncated and terminated with a NULL character.
01337      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01338      * @return  Returns the 'pVal'.
01339      */
01340     char* getSvgEmbedFonts(char* pVal, int size) const;
01341 
01342     /**
01343      * Effective when outputting to SVG.
01344      * Gets the font specified to be embedded in SVG.
01345      * 
01346      *
01347      * @param   pVal        Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer,
01348      *          the string is truncated and terminated with a NULL character.
01349      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01350      * @return  Returns the 'pVal'.
01351      */
01352     wchar_t* getSvgEmbedFontsW(wchar_t* pVal, int size) const;
01353 
01354     /**
01355      * Effective when outputting to SVG.
01356      * Embeds the specified font in SVG to create. If you want to specify plural fonts, put commas between fonts.
01357      * 
01358      *
01359      * @param   newVal  fonts specified to embed
01360      */
01361     void setSvgEmbedFonts(const char* newVal);
01362 
01363     /**
01364      * Effective when outputting to SVG.
01365      * Embeds the specified font in SVG to create. If you want to specify plural fonts, put commas between fonts.
01366      * 
01367      *
01368      * @param   newVal  fonts specified to embed
01369      */
01370     void setSvgEmbedFontsW(const wchar_t* newVal);
01371 
01372     /**
01373      * Effective when outputting to SVG.
01374      * Gets the value of whether to issues the error when failing to embed fonts.
01375      * 
01376      *
01377      * @return  the value of whether to issues the error
01378      */
01379     long getSvgErrorOnEmbedFault() const;
01380 
01381     /**
01382      * Effective when outputting to SVG.
01383      * An error is issued in case of failing to embed fonts.
01384      * 
01385      *
01386      * @param   newVal  If the value is 'true' is specified, an error is issued.
01387      */
01388     void setSvgErrorOnEmbedFault(long newVal);
01389 
01390     /**
01391      * Effective when outputting to SVG.
01392      * Gets the value of how to compress the images embedded in SVG.
01393      * 
01394      *
01395      * <table border="0" cellspacing="0" cellpadding="0">
01396      *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto conversion</td></tr>
01397      *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG conversion</td></tr>
01398      *  <tr><td>IMGCMPR_PNG     </td><td>= 2 PNG conversion</td></tr>
01399      * </table>
01400      *
01401      * @return  the value of how raster graphics are compressed and stored
01402      */
01403     DfvIMAGECONVERSION getSvgImageConversion() const;
01404 
01405     /**
01406      * Effective when outputting to SVG.
01407      * Selects how to compress the images embedded in SVG to create from the following.
01408      * 
01409      *
01410      * <table border="0" cellspacing="0" cellpadding="0">
01411      *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto conversion</td></tr>
01412      *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG conversion</td></tr>
01413      *  <tr><td>IMGCMPR_PNG     </td><td>= 2 PNG conversion</td></tr>
01414      * </table>
01415      *
01416      * @param   newVal  the value of how raster graphics are compressed and stored
01417      */
01418     void setSvgImageConversion(DfvIMAGECONVERSION newVal);
01419 
01420     /**
01421      * Gets the value of the quality of JPEG format that is specified by setSvgImageConversion() stored in SVG.
01422      * 
01423      *
01424      * @return  the value of the quality
01425      */
01426     int getSvgJPEGQuality() const;
01427 
01428     /**
01429      * Effective when outputting to SVG.
01430      * Specifies the quality of the Raster graphics when stored in JPEG format using the range of 1-100.
01431      * The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger.
01432      * The initial value is 80.
01433      * 
01434      *
01435      * @param   newVal  JPEG quality (1 to 100)
01436      */
01437     void setSvgJPEGQuality(int newVal);
01438 
01439     /**
01440      * Effective when outputting to SVG.
01441      * Gets specification how to treat the referred image.
01442      * 
01443      *
01444      * <table border="0" cellspacing="0" cellpadding="0">
01445      *  <tr><td>IMGPT_EMBED_ALL </td><td>= 0 Embeds all images to SVG.</td></tr>
01446      *  <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>
01447      *  <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>
01448      *  <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>
01449      * </table>
01450      *
01451      * @return  specification how to treat the referred image.
01452      */
01453     DfvIMAGEPROCTYPE getSvgImageProcessingType() const;
01454 
01455     /**
01456      * Effective when outputting to SVG.
01457      * Specifies how to treat the referred image.
01458      * 
01459      *
01460      * <table border="0" cellspacing="0" cellpadding="0">
01461      *  <tr><td>IMGPT_EMBED_ALL </td><td>= 0 Embeds all images to SVG.</td></tr>
01462      *  <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>
01463      *  <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>
01464      *  <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>
01465      * </table>
01466      *
01467      * @param   newVal  specification how to treat the referred image.
01468      */
01469     void setSvgImageProcessingType(DfvIMAGEPROCTYPE newVal);
01470 
01471     /**
01472      * Effective when outputting to SVG.
01473      * Gets the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by setSvgImageProcessingType.
01474      * 
01475      *
01476      * @param   pVal        Pointer to the buffer that will receive the image copy path. If the string is as long or longer than the buffer,
01477      *          the string is truncated and terminated with a NULL character.
01478      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01479      * @return  Returns the 'pVal'.
01480      */
01481     char* getSvgImageCopyPath(char* pVal, int size) const;
01482 
01483     /**
01484      * Effective when outputting to SVG.
01485      * Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by setSvgImageProcessingType.
01486      * 
01487      *
01488      * @param   newVal  Pointer to a null-terminated string to be used as image copy path
01489      */
01490     void setSvgImageCopyPath(const char* 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     wchar_t* getSvgImageCopyPathW(wchar_t* 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 setSvgImageCopyPathW(const wchar_t* newVal);
01512 
01513     /**
01514      * Effective when outputting to SVG.
01515      * Gets specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages. <BR>
01516      * 
01517      *
01518      * @return  specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.
01519      */
01520     long getSvgSingleFile() const;
01521 
01522     /**
01523      * Effective when outputting to SVG.
01524      * Specifies whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages. <BR>
01525      * 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>
01526      * Effective only when outputting to the file. It is invalid in the output without the file name like the stream etc.
01527      * 
01528      *
01529      * @param   newVal  specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.
01530      */
01531     void setSvgSingleFile(long newVal);
01532 
01533 #if !defined(_DOXYGEN)
01534     /**
01535      * Gets the value specified by setSvgSingleFileMaxPages.
01536      * Effective when outputting to SVG. 
01537      *
01538      * @return  the value specified by setSvgSingleFileMaxPages.
01539      */
01540     int getSvgSingleFileMaxPages() const;
01541 
01542     /**
01543      * Specifies the maximum number of pages outputted when setSvgSingleFile = True is specified. .
01544      * When this parameter is omitted If this parameter is omitted, "5000" is considered as specified.
01545      * 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. 
01546      * 
01547      * @param   newVal  maximum number of pages 
01548      */
01549     void setSvgSingleFileMaxPages(int newVal);
01550 
01551     /**
01552      * Gets the value specified by setSvgImageDownsamplingDPI.
01553      * Effective when outputting to SVG. 
01554      * 
01555      * @return  the value specified by setSvgImageDownsamplingDPI. 
01556      */
01557     int getSvgImageDownsamplingDPI() const;
01558 
01559     /**
01560      * Specifies the resolution of the down sampling when embedding an image with 1 or more integers. .
01561      * When the resolution of the original image is lower than specification, it's embedded with the lower resolution. Effective when outputting to SVG. 
01562      * 
01563      * @return  newVal  the resolution of the down sampling 
01564      */
01565     void setSvgImageDownsamplingDPI(int dpi);
01566 
01567     /**
01568      * Gets the value specified by setSvgImageDownsamplingMethod.
01569      * Effective when outputting to SVG. 
01570      * 
01571      * @return  the value specified by setSvgImageDownsamplingMethod
01572      */
01573     int getSvgImageDownsamplingMethod() const;
01574 
01575     /**
01576      * Specifies the way of compression when down sampled.
01577      * 
01578      * S_SVG_IMGDOWNSAMPLING_AVERAGE : biliner 
01579      * S_SVG_IMGDOWNSAMPLING_BICUBIC : bicubic 
01580      * S_SVG_IMGDOWNSAMPLING_SUBSAMPLING : nearest neighbor
01581      * If this parameter is omitted, "IMGDOWNSAMPLING_AVERAGE" is considered as specified. Effective when outputting to SVG. 
01582      * 
01583      * @param   type    the way of compression when down sampled 
01584      */
01585     void setSvgImageDownsamplingMethod(int type);
01586 #endif
01587 
01588     /**
01589      * Effective when outputting to SVG.
01590      * Gets specification whether to rename all file name to prefix specified by setSvgImagePrefix, or use original name.
01591      * 
01592      *
01593      * @return  specification whether to rename all file name to prefix specified by setSvgImagePrefix, or use original name.
01594      */
01595     long getSvgImageRename() const;
01596 
01597     /**
01598      * Effective when outputting to SVG.
01599      * 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.
01600      * 
01601      *
01602      * @param   newVal  specification whether to rename all file name to prefix specified by xfo_setSvgImagePrefix, or use original nam
01603      */
01604     void setSvgImageRename(long newVal);
01605 
01606     /**
01607      * Effective when outputting to SVG.
01608      * Gets the prefix of the file name when images are copied to the directory specified by setSvgImageCopyPath and processed.
01609      * 
01610      *
01611      * @param   pVal        Pointer to the buffer that will receive the prefix. If the string is as long or longer than the buffer,
01612      *          the string is truncated and terminated with a NULL character.
01613      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01614      * @return  Returns the 'pVal'.
01615      */
01616     char* getSvgImagePrefix(char* pVal, int size) const;
01617 
01618     /**
01619      * Effective when outputting to SVG.
01620      * 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.
01621      * 
01622      *
01623      * @param   newVal  the prefix of the file name.
01624      */
01625     void setSvgImagePrefix(const char* 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     wchar_t* getSvgImagePrefixW(wchar_t* 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 setSvgImagePrefixW(const wchar_t* newVal);
01647 
01648     /**
01649      * Effective when outputting to SVG.
01650      * Gets specification whether to add sequential number to the output SVG even if it has only one-page.
01651      * 
01652      *
01653      * @return  specification whether to add sequential number to the output SVG even if it has only one-page.
01654      */
01655     long getSvgSinglePageNumber() const;
01656 
01657     /**
01658      * Effective when outputting to SVG.
01659      * When xfo_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.
01660      * 
01661      *
01662      * @param   newVal  specification whether to add sequential number to the output SVG even if it has only one-page.
01663      */
01664     void setSvgSinglePageNumber(long newVal);
01665 
01666 
01667 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
01668     /**
01669      * Effective when outputting to SVG.
01670      * Gets the value of the rasterised-resolution of the transformed raster images.
01671      * 
01672      *
01673      * @return  Rasterised-resolution
01674      */
01675     int getSvgRasterizeResolution() const;
01676 
01677     /**
01678      * Effective when outputting to SVG.
01679      * 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.
01680      * This setting is effective only with Windows version.
01681      * 
01682      *
01683      * @param   newVal  Rasterised-resolution (70 to 500)
01684      */
01685     void setSvgRasterizeResolution(int newVal);
01686 #endif
01687 
01688     /**
01689      * Get the error level to abort formatting process.
01690      *
01691      * @return  Returns the error level.
01692      */
01693     DfvIfErrorLevel getExitLevel() const;
01694 
01695     /**
01696      * Error level to abort formatting process. Server Based Converter will stop formatting when the detected
01697      * error level is equal to ExitLevel property or higher. The default value is 2 (Warning).
01698      * Thus if an error occurred and error level is 2 (Warning) or higher, formatting process will be
01699      * aborted. Please use the value from 1 to 4. When the value of 5 or more specified, it is considered
01700      * to be the value of 4. If a error-level:4 (fatal error) occurs, the formatting process will be
01701      * aborted unconditionally.
01702      * BTW : An error is not displayed no matter what value may be specified to be this property.
01703      *
01704      * <table border="0" cellspacing="0" cellpadding="0">
01705      *  <tr><td>ELVL_INFORMATION    </td><td>= 1 Information</td></tr>
01706      *  <tr><td>ELVL_WARNING        </td><td>= 2 Warning</td></tr>
01707      *  <tr><td>ELVL_RECOVERABLE    </td><td>= 3 Recoveable Error</td></tr>
01708      *  <tr><td>ELVL_FATAL          </td><td>= 4 Fatal Error</td></tr>
01709      * </table>
01710      *
01711      * @param   newVal  error level to abort formatting process.
01712      */
01713     void setExitLevel(DfvIfErrorLevel newVal);
01714 
01715     /**
01716      * Returns the error level of the error that occurred during the formatting process.
01717      *
01718      * <table border="0" cellspacing="0" cellpadding="0">
01719      *  <tr><td>ELVL_INFORMATION    </td><td>= 1 Information</td></tr>
01720      *  <tr><td>ELVL_WARNING        </td><td>= 2 Warning</td></tr>
01721      *  <tr><td>ELVL_RECOVERABLE    </td><td>= 3 Recoveable Error</td></tr>
01722      *  <tr><td>ELVL_FATAL          </td><td>= 4 Fatal Error</td></tr>
01723      * </table>
01724      *
01725      * @return  Returns the error level.
01726      */
01727     DfvIfErrorLevel getErrorLevel() const;
01728 
01729     /**
01730      * Returns the error code of the error that occurred during the formatting process.
01731      * Zero means no error. Non-zero indicates any error occurred.
01732      *
01733      * @return  Returns the error code.
01734      */
01735     DfvIfErrorCode getErrorCode() const;
01736 
01737     /**
01738      * Returns the error message of the error that occurred during the formatting process.
01739      *
01740      * @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.
01741      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01742      * @return  Returns the 'pVal'.
01743      */
01744     char* getErrorMessage(char* pVal, int size) const;
01745     /**
01746      * Returns the error message of the error that occurred during the formatting process.
01747      *
01748      * @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.
01749      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01750      * @return  Returns the 'pVal'.
01751      */
01752     wchar_t* getErrorMessageW(wchar_t* pVal, int size) const;
01753 
01754     /**
01755      * Sets the substitution of font name. This substitution acts on the font names existing in FO.
01756      * The font name 'fontName' is replaced to 'aliasName'.
01757      *
01758      * @param   src     Specifies the font name which is replaced.
01759      * @param   dst     Specifies the aliasName.
01760      */
01761     void setFontAlias(const char* src, const char* dst);
01762     /**
01763      * Sets the substitution of font name. This substitution acts on the font names existing in FO.
01764      * The font name 'fontName' is replaced to 'aliasName'.
01765      *
01766      * @param   src     Specifies the font name which is replaced.
01767      * @param   dst     Specifies the aliasName.
01768      */
01769     void setFontAliasW(const wchar_t* src, const wchar_t* dst);
01770 
01771     /**
01772      * Clear all substitutions of font name.
01773      *
01774      */
01775     void clearFontAlias();
01776 
01777     /**
01778      * Erase the substitution of font name 'fontName'.
01779      *
01780      * @param   src Specifies the font name which is replaced.
01781      */
01782     void eraseFontAlias(const char* src);
01783     /**
01784      * Erase the substitution of font name 'fontName'.
01785      *
01786      * @param   src Specifies the font name which is replaced.
01787      */
01788     void eraseFontAliasW(const wchar_t* newVal);
01789 
01790     /**
01791      * Execute formatting and output to a PDF specified in OutputFilePath or printer specified in PrinterName.
01792      *
01793      * @param   bNoThrow
01794      * If the value of 'false' is specified, throws XfoException.<BR>
01795      * If the value of 'true' is specified, returns the error code.
01796      * @return  Returns the error code. Zero means no error. Non-zero indicates any error occurred.
01797      */
01798     DfvIfErrorCode execute(bool bNoThrow=false);
01799 
01800     /**
01801      * Executes the formatting of document specified for inputStream, and outputs it to outputStream in the output form specified for setPrinterName.
01802      * @since 4.0
01803      *
01804      * @param   src Specifies document.
01805      * @param   out the output destination of the formatting result.
01806      */
01807     void render(std::istream& src, std::ostream& out);
01808 
01809     /**
01810      * Initialize formatting engine.
01811      *
01812      */
01813     void clear();
01814 
01815     /**
01816      * Register the MessageListener interface to the instance of implemented class
01817      * The error that occurred during the formatting process can be received as the event.
01818      *
01819      * @param   listener Pointer of the MessageListener instance.
01820      */
01821     void setMessageListener(MessageListener* listener);
01822 
01823     /**
01824      * Register the DfvFormatPageListener interface to the instance of implemented class
01825      * The page number that formatted during the formatting process can be received as the event.
01826      *
01827      * @param   listener Pointer of the DfvFormatPageListener instance.
01828      */
01829     void setFormatPageListener(DfvFormatPageListener* listener);
01830 
01831     /**
01832      * Get the printer name where the formatted result is outputted.
01833      *
01834      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
01835      *          the string is truncated and terminated with a NULL character.
01836      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01837      * @return  Returns the 'pVal'.
01838      */
01839     char* getPrinterName(char* pVal, int size) const;
01840     /**
01841      * Get the printer name where the formatted result is outputted.
01842      *
01843      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
01844      *          the string is truncated and terminated with a NULL character.
01845      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01846      * @return  Returns the 'pVal'.
01847      */
01848     wchar_t* getPrinterNameW(wchar_t* pVal, int size) const;
01849 
01850     /**
01851      * Specifies the output format or the printer name to output.
01852      * When a printer name is specified, the formatted result is outputted to that printer.
01853      * When "\@STDPRN" is specified, the formatted result is outputted to the currently used printer.
01854      * When "\@PDF" is specified, the formatted result is outputted to PDF.
01855      * When "\@SVG" is specified, the formatted result is outputted to SVG.
01856      * When "\@PS" is specified, the formatted result is outputted to PostScript.
01857      * When "\@INX" is specified, the formatted result is outputted to INX.
01858      * When "\@MIF" is specified, the formatted result is outputted to MIF.
01859      * When "\@TEXT" is specified, the formatted result is outputted to a text format file.
01860      * When "\@AreaTree" is specified, the AreaTree will be outputted.
01861      * When omitted, it is considered as "\@PDF" was specified.
01862      * It's impossible to output to the printer with any OS's other than Windows.
01863      *
01864      * @param   newVal  Pointer to a null-terminated string to be used as the printer name.
01865      */
01866     void setPrinterName(const char* newVal);
01867     /**
01868      * Specifies the output format or the printer name to output.
01869      * When a printer name is specified, the formatted result is outputted to that printer.
01870      * When "\@STDPRN" is specified, the formatted result is outputted to the currently used printer.
01871      * When "\@PDF" is specified, the formatted result is outputted to PDF.
01872      * When "\@SVG" is specified, the formatted result is outputted to SVG.
01873      * When "\@PS" is specified, the formatted result is outputted to PostScript.
01874      * When "\@INX" is specified, the formatted result is outputted to INX.
01875      * When "\@MIF" is specified, the formatted result is outputted to MIF.
01876      * When "\@TEXT" is specified, the formatted result is outputted to a text format file.
01877      * When "\@AreaTree" is specified, the AreaTree will be outputted.
01878      * When omitted, it is considered as "\@PDF" was specified.
01879      * It's impossible to output to the printer with any OS's other than Windows.
01880      *
01881      * @param   newVal  Pointer to a null-terminated string to be used as the printer name.
01882      */
01883     void setPrinterNameW(const wchar_t* newVal);
01884 
01885 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
01886 
01887     /**
01888      * Get the number of copies. Effective when outputting to printer.
01889      * This setting is effective only with Windows version.
01890      *
01891      * @return  Returns the number of copies.
01892      */
01893     long getPrnCopies() const;
01894 
01895     /**
01896      * Specifies the number of copies. Effective when outputting to printer.
01897      * If nothing is specified, the value is considered as 1.
01898      * This setting is effective only with Windows version.
01899      *
01900      * @param   newVal  the number of copies.
01901      */
01902     void setPrnCopies(long newVal);
01903 
01904     /**
01905      * Get collation of multiple copies.
01906      * This setting is effective only with Windows version.
01907      *
01908      * @return  If zero is returned, the same page is multi-copied continuously.
01909      *          If nonezero is returned, the pages specified from start to end are printed repeatedly.
01910      */
01911     long getPrnCollate() const;
01912 
01913     /**
01914      * Specifies collation of multiple copies. Effective when outputting to printer and the number of
01915      * copies is plural. If it is not specified or the value zero is specified, the same page is
01916      * multi-copied continuously.
01917      * If nonezero is specified, the pages specified from start to end are printed repeatedly.
01918      * This setting is effective only with Windows version.
01919      *
01920      * @param   newVal  Zpecifies zero or nonzero.
01921      */
01922     void setPrnCollate(long newVal);
01923 
01924     /**
01925      * Get the setting of whether print dialog box is displayed or not when printing
01926      * This setting is effective only with Windows version.
01927      *
01928      * @return  If zero, the print dialog box is displayed. If nonezero, the print dialog box is not displayed.
01929      */
01930     long getBatchPrint() const;
01931 
01932     /**
01933      * When the value 'false' is specified, the print dialog box is displayed when printing.
01934      * If the setting is omitted or the value 'true' is specified, the print dialog is not displayed.
01935      * This setting is effective only with Windows version.
01936      *
01937      * @param   newVal  If zero, the print dialog box is displayed. If nonezero, the print dialog box is not displayed.
01938      */
01939     void setBatchPrint(long newVal);
01940 
01941 #endif // defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))   /* WIN32 */
01942 
01943     /**
01944      * Get the version string of Server Based Converter.
01945      * 
01946      *
01947      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
01948      *          the string is truncated and terminated with a NULL character.
01949      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01950      * @return  Returns the 'pVal'.
01951      */
01952     char* getVersion(char* pVal, int size) const;
01953 
01954     /**
01955      * Get the version string of Server Based Converter.
01956      * 
01957      *
01958      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
01959      *          the string is truncated and terminated with a NULL character.
01960      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01961      * @return  Returns the 'pVal'.
01962      */
01963     wchar_t* getVersionW(wchar_t* pVal, int size) const;
01964 
01965     /**
01966      * Get INX output mode.
01967      *
01968      * @return  output mode of INX.
01969      */
01970     DfvINXOUTPUTMODE getInxOutputMode() const;
01971 
01972     /**
01973      * Set INX output mode.
01974      *
01975      * @param   newVal mode of INX.
01976      */
01977     void setInxOutputMode(DfvINXOUTPUTMODE newVal);
01978 
01979     /**
01980      * Get the specification that omit blank pages. return Specification that omit blank pages 
01981      */
01982     bool getOmitBlankPages();
01983     
01984     /**
01985      * Disregard any empty pages.
01986      * Effective only when the original file is MS Word or MS Excel. 
01987      * Specifies to disregard any empty pages at the beginning of document. 
01988      * By using this parameter with setEndPage = 1 parameter,
01989      * it is possible to acquire the output of the first page which has actual contents.
01990      * Other operation is not guaranteed. 
01991      *
01992      * @param   newVal      If the value is 'true' is specified, omit blank pages 
01993      */
01994     void setOmitBlankPages(bool newVal);
01995 
01996     /**
01997      * Get specifies of the FlashPartiallyOutput.
01998      * @since 2.1
01999      *
02000      * @return  specifies of FlashPartiallyOutput.
02001      */
02002     long getFlashPartiallyOutput() const;
02003 
02004     /**
02005      * When an error occurs within the document, the flash file in process will be outputted.
02006      * Effective when outputting to Flash.
02007      * @since 2.1
02008      *
02009      * @param   newVal  Specifies zero or nonzero.
02010      */
02011     void setFlashPartiallyOutput(long newVal);
02012 
02013     /**
02014      * Get specifies of the FlashHidePageButton.
02015      * @since 3.0
02016      *
02017      * @return  specifies of FlashHidePageButton.
02018      */
02019     long getFlashHidePageButton() const;
02020 
02021     /**
02022      * Output a no page button. Effective when outputting to Flash.
02023      * @since 3.0
02024      *
02025      * @param   newVal  If the value is 'true' is specified, output a no page button.
02026      */
02027     void setFlashHidePageButton(long newVal);
02028 
02029     /**
02030      * Get the setting of the FlashSplitPage.
02031      *
02032      * @return
02033      * Specify FlashSplitPage.
02034      */
02035     bool getFlashSplitPage() const;
02036 
02037     /**
02038      * Outputs Flash file per page and saves as every single file..<BR>
02039      * Effective when outputting to Flash.
02040      *
02041      * @param newVal
02042      * If 'true' is specified, do not output Flash file per page.
02043      */
02044     void setFlashSplitPage(bool newVal);
02045 
02046     /**
02047      * Get the setting of FlashOutputAction.
02048      *
02049      * @return
02050      * Specify FlashOutputAction.
02051      */
02052     bool getFlashOutputAction() const;
02053 
02054     /**
02055      * Do not output features of ActionScript1.0, such as stop action per page, the page navigation button, linking, etc..<BR>
02056      * Effective when outputting to Flash.
02057      *
02058      * @param newVal
02059      * If 'true' is specified, do not output Flash file per page.
02060      */
02061     void setFlashOutputAction(bool newVal);
02062 
02063     /**
02064      * Get the setting of FlashImageLimitSize.
02065      *
02066      * @return
02067      * Specify FlashImageLimitSize.
02068      */
02069     int getFlashImageLimitSize() const;
02070 
02071     /**
02072      * Specifies the number of maximum pixels of images outputted to the Flash file by the integral value. 
02073      * When the width or the height of the output image exceeds the specified value, 
02074      * it is reduced to the specified value when outputting the flash file. 
02075      * When this parameter is omitted, 1000 is applied.  <BR>
02076      * 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) 
02077      * by the number of pixels. Please note that when embedded image exceeds this size, 
02078      it may not be displayed with Flash Player.<BR>
02079      * Effective when outputting to Flash.
02080      *
02081      * @param newVal
02082      * If 'true' is specified, do not output Flash file per page.
02083      */
02084     void setFlashImageLimitSize(int newVal);
02085 
02086 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
02087 
02088     /**
02089      * It print at size of paper.
02090      * Default is false.
02091      * Effective only when outputting to image with Windows version. 
02092      * 
02093      * @param   newVal      If the value is 'true' is specified, print at size of paper. 
02094      */
02095     void setPrnFitPaper(bool newVal);
02096 
02097 #endif  // #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
02098 
02099 
02100     /**
02101      * Get the image resolution when outputting JPEG and PNG.
02102      * Effective only when outputting to image with Windows version and Linux version 6.0 or later. 
02103      *
02104      * @return      Image resolution
02105      */
02106     int getRasterDPI(void) const;
02107 
02108     /**
02109     * Sets the image resolution when outputting JPEG and PNG.
02110     * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02111      *
02112      * @param   newVal      Image resolution (1 to 1440) 
02113      */
02114     void setRasterDPI(int newVal);
02115 
02116     /**
02117      * Get the image scale when outputting JPEG and PNG.
02118      * Effective only when outputting to image with Windows version and Linux version 6.0 or later. 
02119      *
02120      * @param   pVal
02121      *      Pointer to the buffer that will receive the text.
02122      *      If the string is as long or longer than the buffer,
02123      *      the string is truncated and terminated with a NULL character.
02124      * @param   size
02125      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02126      *      If the text exceeds this limit, it is truncated.
02127      * @return  Returns the 'pVal'.
02128      */
02129     char* getRasterScale(char* pVal, int size) const;
02130 
02131     /**
02132      * Get the image scale when outputting JPEG and PNG.
02133      * Effective only when outputting to image with Windows version and Linux version 6.0 or later. 
02134      *
02135      * @param   pVal
02136      *      Pointer to the buffer that will receive the text.
02137      *      If the string is as long or longer than the buffer,
02138      *      the string is truncated and terminated with a NULL character.
02139      * @param   size
02140      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02141      *      If the text exceeds this limit, it is truncated.
02142      * @return  Returns the 'pVal'.
02143      */
02144     wchar_t* getRasterScaleW(wchar_t* pVal, int size) const;
02145 
02146     /**
02147      * Sets the image scale when outputting JPEG and PNG.
02148      * A numerical value, "%", or "px" (pixel) is available as the unit.
02149      * Specify the percentage for a numerical value and "%", and specify the width of image for pixel.
02150      * Effective only when outputting to image with Windows version and Linux version 6.0 or later. 
02151      *
02152      * @param   newVal      Image scale 
02153      */
02154     void setRasterScale(const char* newVal);
02155 
02156     /**
02157      * Sets the image scale when outputting JPEG and PNG.
02158      * A numerical value, "%", or "px" (pixel) is available as the unit.
02159      * Specify the percentage for a numerical value and "%", and specify the width of image for pixel.
02160      * Effective only when outputting to image with Windows version and Linux version 6.0 or later. 
02161      *
02162      * @param   newVal      Image scale 
02163      */
02164     void setRasterScaleW(const wchar_t* newVal);
02165 
02166     /**
02167      * Get the maximum image height when outputting JPEG and PNG.<BR>
02168      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02169      *
02170      * @return          Maximum image height
02171      */
02172     int getRasterHeight() const;
02173 
02174     /**
02175      * Sets the maximum image height decided by setRasterScale when outputting JPEG and PNG.<BR>
02176      * "px" (pixel) is available as the unit. 
02177      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02178      *
02179      * @param   newVal  Maximum image height
02180      */
02181     void setRasterHeight(int newVal);
02182 
02183     /**
02184      * Get the file name naming format when outputting PNG and JPEG.<BR>
02185      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02186      *
02187      * @param   pVal
02188      *      Pointer to the buffer that will receive the text.
02189      *      If the string is as long or longer than the buffer,
02190      *      the string is truncated and terminated with a NULL character.
02191      * @param   size
02192      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02193      *      If the text exceeds this limit, it is truncated.
02194      * @return  Returns the 'pVal'.
02195      */
02196     char* getRasterFormat(char* pVal, int size) const;
02197 
02198     /**
02199      * Get the file name naming format when outputting PNG and JPEG.<BR>
02200      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02201      *
02202      * @param   pVal
02203      *      Pointer to the buffer that will receive the text.
02204      *      If the string is as long or longer than the buffer,
02205      *      the string is truncated and terminated with a NULL character.
02206      * @param   size
02207      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02208      *      If the text exceeds this limit, it is truncated.
02209      * @return  Returns the 'pVal'.
02210      */
02211     wchar_t* getRasterFormatW(wchar_t* pVal, int size) const;
02212 
02213     /**
02214      * Specifies the file name naming format when outputting PNG and JPEG.<BR>
02215      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02216      *
02217      * @param   newVal  format for naming files
02218      */
02219     void setRasterFormat(const char* newVal);
02220 
02221     /**
02222      * Specifies the file name naming format when outputting PNG and JPEG.<BR>
02223      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02224      *
02225      * @param   newVal  format for naming files
02226      */
02227     void setRasterFormatW(const wchar_t* newVal);
02228 
02229     /**
02230      * Get the conversion accuracy when outputting JPEG.<BR>
02231      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02232      *
02233      * @return          JPEG quality
02234      */
02235     int getRasterJpegQuality() const;
02236 
02237     /**
02238      * Specifies the conversion accuracy by the value with the range of 1-100(%) when outputting JPEG.<BR>
02239      * When this parameter is omitted, it is regarded as 80%.
02240      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02241      *
02242      * @param   newVal  JPEG quality
02243      */
02244     void setRasterJpegQuality(int newVal);
02245 
02246 
02247 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
02248 
02249     /**
02250      * Gets specification whether to use GdiPlus .<BR>
02251      * Effective only when outputting to image with Windows version
02252      *
02253      * @return          Specification whether to use GdiPlus.
02254      */
02255     bool getRasterUseGdiPlus() const;
02256 
02257     /**
02258      * GdiPlus is used when the file is converted to Jpeg or PNG.<BR>
02259      * This setting is effective only with Windows Vista or later / Windows Server 2003.
02260      * Effective only when outputting to image with Windows version
02261      *
02262      * @param newVal Specifies whether to use GdiPlus.
02263      */
02264     void setRasterUseGdiPlus(bool newVal);
02265 
02266     /**
02267      * Gets specification whether to convert to monochrome image, when outputting JPEG and PNG.<BR>
02268      * Effective only when outputting to image with Windows version
02269      *
02270      * @return          Specification whether to convert to monochrome.
02271      */
02272     bool getRasterMonochrome() const;
02273 
02274     /**
02275      * Specifies whether to convert to monochrome image, when outputting JPEG and PNG.<BR>
02276      * Effective only when outputting to image with Windows version
02277      *
02278      * @param newVal Specifies whether to convert to monochrome.
02279      */
02280     void setRasterMonochrome(bool newVal);
02281 
02282 #endif // defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
02283 
02284 
02285     /**
02286      * Get the path name of RGB ICC profile for input when outputting CMYK TIFF.
02287      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02288      *
02289      * @param   pVal
02290      *      Pointer to the buffer that will receive the text.
02291      *      If the string is as long or longer than the buffer,
02292      *      the string is truncated and terminated with a NULL character.
02293      * @param   size
02294      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02295      *      If the text exceeds this limit, it is truncated.
02296      * @return  Returns the 'pVal'.
02297      */
02298     char* getRasterRGBProfile(char* pVal, int size) const;
02299 
02300     /**
02301      * Get the path name of RGB ICC profile for input when outputting CMYK TIFF.
02302      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02303      *
02304      * @param   pVal
02305      *      Pointer to the buffer that will receive the text. 
02306      *      If the string is as long or longer than the buffer,
02307      *      the string is truncated and terminated with a NULL character.
02308      * @param   size
02309      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02310      *      If the text exceeds this limit, it is truncated.
02311      * @return  Returns the 'pVal'.
02312      */
02313     wchar_t* getRasterRGBProfileW(wchar_t* pVal, int size) const;
02314 
02315     /**
02316      * Set the path name of RGB ICC profile for input when outputting CMYK TIFF.
02317      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02318      *
02319      * @param   newVal
02320      *      Pointer to a null-terminated string.
02321      */
02322     void setRasterRGBProfile(const char* newVal);
02323 
02324     /**
02325      * Set the path name of RGB ICC profile for input when outputting CMYK TIFF.
02326      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02327      *
02328      * @param   newVal
02329      *      Pointer to a null-terminated string.
02330      */
02331     void setRasterRGBProfileW(const wchar_t* newVal);
02332 
02333     /**
02334      * Get the path name of CMYK ICC profile for output when outputting CMYK TIFF.
02335      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02336      *
02337      * @param   pVal
02338      *      Pointer to the buffer that will receive the text.
02339      *      If the string is as long or longer than the buffer,
02340      *      the string is truncated and terminated with a NULL character.
02341      * @param   size
02342      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02343      *      If the text exceeds this limit, it is truncated.
02344      * @return  Returns the 'pVal'.
02345      */
02346     char* getRasterCMYKProfile(char* pVal, int size) const;
02347 
02348     /**
02349      * Get the path name of CMYK ICC profile for output when outputting CMYK TIFF.
02350      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02351      *
02352      * @param   pVal
02353      *      Pointer to the buffer that will receive the text. 
02354      *      If the string is as long or longer than the buffer,
02355      *      the string is truncated and terminated with a NULL character.
02356      * @param   size
02357      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02358      *      If the text exceeds this limit, it is truncated.
02359      * @return  Returns the 'pVal'.
02360      */
02361     wchar_t* getRasterCMYKProfileW(wchar_t* pVal, int size) const;
02362 
02363     /**
02364      * Set the path name of CMYK ICC profile for output when outputting CMYK TIFF.
02365      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02366      *
02367      * @param   newVal
02368      *      Pointer to a null-terminated string.
02369      */
02370     void setRasterCMYKProfile(const char* newVal);
02371 
02372     /**
02373      * Set the path name of CMYK ICC profile for output when outputting CMYK TIFF.
02374      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02375      *
02376      * @param   newVal
02377      *      Pointer to a null-terminated string.
02378      */
02379     void setRasterCMYKProfileW(const wchar_t* newVal);
02380 
02381     /**
02382      * Get the setting of whether to convert images to grayscale 256 tones.
02383      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02384      *
02385      * @return 
02386      * Specify whether to convert images to grayscale 256 tones.
02387      */
02388     bool getRasterGrayscale() const;
02389 
02390     /**
02391      * Outputs grayscale 256 tones..<BR>
02392      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02393      *
02394      * @param newVal
02395      * If "true" is specified, convert images to grayscale 256 tones.
02396      */
02397     void setRasterGrayscale(bool newVal);
02398 
02399 
02400 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
02401 
02402     /**
02403      * Get the setting of whether to convert images to 256 colors, and only Windows version.
02404      * Effective only when outputting to image with Windows version
02405      *
02406      * @return
02407      * Specify whether to convert images to 256 colors.
02408      */
02409     bool getRaster256Color() const;
02410 
02411     /**
02412      * Outputs 256 colors..<BR>
02413      * Effective only when outputting to image with Windows version
02414      *
02415      * @param newVal
02416      * If "true" is specified, convert images to 256 colors.
02417      */
02418     void setRaster256Color(bool newVal);
02419 
02420 #endif // defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
02421 
02422 
02423     /**
02424      * Get the compression method when outputting TIFF / MTIFF.
02425      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02426      *
02427      * @param   pVal
02428      *      Pointer to the buffer that will receive the text.
02429      *      If the string is as long or longer than the buffer,
02430      *      the string is truncated and terminated with a NULL character.
02431      * @param   size
02432      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02433      *      If the text exceeds this limit, it is truncated.
02434      * @return  Returns the 'pVal'.
02435      */
02436     char* getRasterCompression(char* pVal, int size) const;
02437 
02438     /**
02439      * Get the compression method when outputting TIFF / MTIFF.
02440      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02441      *
02442      * @param   pVal
02443      *      Pointer to the buffer that will receive the text.
02444      *      If the string is as long or longer than the buffer,
02445      *      the string is truncated and terminated with a NULL character.
02446      * @param   size
02447      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02448      *      If the text exceeds this limit, it is truncated.
02449      * @return  Returns the 'pVal'.
02450      */
02451     wchar_t* getRasterCompressionW(wchar_t* pVal, int size) const;
02452 
02453     /**
02454      * Specifies the compression method when outputting TIFF / MTIFF.<BR>
02455      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02456      * The compression method.<BR>
02457      * none : None<BR>
02458      * lzw : ZLIB compression(When this parameter is omitted, lzw is applied.)<BR>
02459      * dct : DCTDecode<BR>
02460      * flate : FlateDecode<BR>
02461      * runlength : Run Length compression<BR>
02462      * ccitt3 : CCITT Group3<BR>
02463      * ccitt4 : CCITT Group4<BR>
02464      *
02465      * @param   newVal
02466      *      Pointer to a null-terminated string.
02467      */
02468     void setRasterCompression(const char* newVal);
02469 
02470     /**
02471      * Specifies the compression method when outputting TIFF / MTIFF.<BR>
02472      * Effective only when outputting to image with Windows version and Linux version 6.0 or later.
02473      * The compression method.<BR>
02474      * none : None<BR>
02475      * lzw : ZLIB compression(When this parameter is omitted, lzw is applied.)<BR>
02476      * dct : DCTDecode<BR>
02477      * flate : FlateDecode<BR>
02478      * runlength : Run Length compression<BR>
02479      * ccitt3 : CCITT Group3<BR>
02480      * ccitt4 : CCITT Group4<BR>
02481      *
02482      * @param   newVal
02483      *      Pointer to a null-terminated string.
02484      */
02485     void setRasterCompressionW(const wchar_t* newVal);
02486 
02487 
02488     /**
02489      * Specifies the height of the paper when inputting text.
02490      * Effective when inputting text. 
02491      *
02492      * @param   newVal      the height of paper 
02493      */
02494     void setTextPaperHeight(const char* newVal);
02495 
02496     /**
02497      * Specifies the height of the paper when inputting text.
02498      * Effective when inputting text. 
02499      *
02500      * @param   newVal      the height of paper 
02501      */
02502     void setTextPaperHeightW(const wchar_t* newVal);
02503 
02504     /**
02505      * Specifies the width of the paper when inputting text.
02506      * Effective when inputting text. 
02507      *
02508      * @param   newVal      the width of paper 
02509      */
02510     void setTextPaperWidth(const char* newVal);
02511 
02512     /**
02513      * Specifies the width of the paper when inputting text.
02514      * Effective when inputting text. 
02515      *
02516      * @param   newVal      the width of paper 
02517      */
02518     void setTextPaperWidthW(const wchar_t* newVal);
02519 
02520     /**
02521      * Specifies the left margin of the paper when inputting text.
02522      * Effective when inputting text. 
02523      *
02524      * @param   newVal       the left margin of the paper 
02525      */
02526     void setTextMarginLeft(const char* newVal);
02527 
02528     /**
02529      * Specifies the left margin of the paper when inputting text.
02530      * Effective when inputting text. 
02531      *
02532      * @param   newVal       the left margin of the paper 
02533      */
02534     void setTextMarginLeftW(const wchar_t* newVal);
02535 
02536     /**
02537      * Specifies the right margin of the paper when inputting text.
02538      * Effective when inputting text. 
02539      *
02540      * @param   newVal      the top margin of the paper 
02541      */
02542     void setTextMarginTop(const char* newVal);
02543 
02544     /**
02545      * Specifies the right margin of the paper when inputting text.
02546      * Effective when inputting text. 
02547      *
02548      * @param   newVal      the top margin of the paper 
02549      */
02550     void setTextMarginTopW(const wchar_t* newVal);
02551 
02552     /**
02553      * Specifies the right margin of the paper when inputting text.
02554      * Effective when inputting text. 
02555      *
02556      * @param   newVal      the right margin of the paper 
02557      */
02558     void setTextMarginRight(const char* newVal);
02559 
02560     /**
02561      * Specifies the right margin of the paper when inputting text.
02562      * Effective when inputting text. 
02563      *
02564      * @param   newVal      the right margin of the paper 
02565      */
02566     void setTextMarginRightW(const wchar_t* newVal);
02567 
02568     /**
02569      * Specifies the right margin of the paper when inputting text.
02570      * Effective when inputting text. 
02571      *
02572      * @param   newVal      the bottom margin of the paper 
02573      */
02574     void setTextMarginBottom(const char* newVal);
02575 
02576     /**
02577      * Specifies the right margin of the paper when inputting text.
02578      * Effective when inputting text. 
02579      *
02580      * @param   newVal      the bottom margin of the paper 
02581      */
02582     void setTextMarginBottomW(const wchar_t* newVal);
02583 
02584     /**
02585      * Specifies the font family name when inputting text.
02586      * Effective when inputting text. 
02587      *
02588      * @param   newVal      font family name 
02589      */
02590     void setTextFontFamily(const char* newVal);
02591 
02592     /**
02593      * Specifies the font family name when inputting text.
02594      * Effective when inputting text. 
02595      *
02596      * @param   newVal      font family name 
02597      */
02598     void setTextFontFamilyW(const wchar_t* newVal);
02599 
02600     /**
02601      * Specifies the font size when inputting text.
02602      * Effective when inputting text. 
02603      *
02604      * @param   newVal      font size 
02605      */
02606     void setTextFontSize(const char* newVal);
02607 
02608     /**
02609      * Specifies the font size when inputting text.
02610      * Effective when inputting text. 
02611      *
02612      * @param   newVal      font size 
02613      */
02614     void setTextFontSizeW(const wchar_t* newVal);
02615 
02616     /**
02617      * Specifies the value of whether show page number or not when inputting text.
02618      * Effective when inputting text. 
02619      * 
02620      * @param   newVal      the value of whether show page number or not 
02621      */
02622     void setTextShowPageNumber(bool newVal);
02623 
02624     /**
02625      * Specifies the value of whether show page number or not when inputting text.
02626      * Effective when inputting text. 
02627      * 
02628      * @param   newVal      the value of whether show page number or not    
02629      */
02630     void setTextShowLineNumber(bool newVal);
02631 
02632     /**
02633      * Specifies the offset value of range from body area when showing line number and inputting text.
02634      * Effective when inputting text. 
02635      * 
02636      * @param   newVal      the offset value
02637      */
02638     void setTextLineNumberOffset(const char* newVal);
02639 
02640     /**
02641      * Specifies the offset value of range from body area when showing line number and inputting text.
02642      * Effective when inputting text. 
02643      * 
02644      * @param   newVal      the offset value
02645      */
02646     void setTextLineNumberOffsetW(const wchar_t* newVal);
02647 
02648     /**
02649      * Specifies the line number format when showing line number and inputting text.
02650      * Effective when inputting text. 
02651      * 
02652      * @param   newVal      line number format  
02653      */
02654     void setTextLineNumberFormat(const char* newVal);
02655 
02656     /**
02657      * Specifies the line number format when showing line number and inputting text.
02658      * Effective when inputting text. 
02659      * 
02660      * @param   newVal      line number format  
02661      */
02662     void setTextLineNumberFormatW(const wchar_t* newVal);
02663 
02664 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
02665 
02666     /**
02667      * Acquires the setting of the smoothing processing to text.<BR>
02668      * This setting is effective only with Windows Vista or later / Windows Server 2003 or later.
02669      *
02670      * @return          
02671      * Specify whether to perform the smoothing processing to text.
02672      */
02673     bool getGdiTextAntialias() const;
02674 
02675     /**
02676      * Performs the smoothing processing to text.<BR>
02677      * Effective only when printing and outputting images.<BR>
02678      * This setting is effective only with Windows Vista or later / Windows Server 2003 or later.
02679      *
02680      * @param   newVal  
02681      * Performs the smoothing processing when true is specified.
02682      */
02683     void setGdiTextAntialias(bool newVal);
02684 
02685     /**
02686      * Acquires the setting of the smoothing processing to borders.<BR>
02687      * This setting is effective only with Windows Vista or later / Windows Server 2003 or later.
02688      *
02689      * @return          
02690      * Specify whether to perform the smoothing processing to borders.
02691      */
02692     bool getGdiLineartSmoothing() const;
02693 
02694     /**
02695      * Performs the smoothing processing to borders.<BR>
02696      * Effective only when printing and outputting images.<BR>
02697      * This setting is effective only with Windows Vista or later / Windows Server 2003 or later.
02698      *
02699      * @param   newVal  
02700      * Performs the smoothing processing when true is specified.
02701      */
02702     void setGdiLineartSmoothing(bool newVal);
02703 
02704     /**
02705      * Acquires the setting of the smoothing processing to images.<BR>
02706      * This setting is effective only with Windows Vista or later / Windows Server 2003 or later.
02707      *
02708      * @return          
02709      * Specify whether to perform the smoothing processing to images.
02710      */
02711     bool getGdiImageSmoothing() const;
02712 
02713     /**
02714      * Performs the smoothing processing to images.<BR>
02715      * Effective only when printing and outputting images.<BR>
02716      * This setting is effective only with Windows Vista or later / Windows Server 2003 or later.
02717      *
02718      * @param   newVal  
02719      * Performs the smoothing processing when true is specified.
02720      */
02721     void setGdiImageSmoothing(bool newVal);
02722 
02723 #endif // defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
02724 
02725     /**
02726      * Get the watermark text on each page. 
02727      *
02728      * @param   pVal
02729      *      Pointer to the buffer that will receive the text.
02730      *      If the string is as long or longer than the buffer,
02731      *      the string is truncated and terminated with a NULL character.
02732      * @param   size
02733      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02734      *      If the text exceeds this limit, it is truncated.
02735      * @return  Returns the 'pVal'.
02736      */
02737     char* getWatermarkText(char* pVal, int size) const;
02738 
02739     /**
02740      * Get watermark text on each page.
02741      *
02742      * @param   pVal
02743      *      Pointer to the buffer that will receive the text. 
02744      *      If the string is as long or longer than the buffer,
02745      *      the string is truncated and terminated with a NULL character.
02746      * @param   size
02747      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02748      *      If the text exceeds this limit, it is truncated.
02749      * @return  Returns the 'pVal'.
02750      */
02751     wchar_t* getWatermarkTextW(wchar_t* pVal, int size) const;
02752 
02753     /**
02754      * Displays the specified watermark text on each page. 
02755      * Possible to make it multiple lines by delimiting with the line feed \n. 
02756      * This setting is invalid with the evaluation version.  
02757      *
02758      * @param   newVal
02759      *      Pointer to a null-terminated string.
02760      */
02761     void setWatermarkText(const char* newVal);
02762 
02763     /**
02764      * Displays the specified watermark text on each page. 
02765      * Possible to make it multiple lines by delimiting with the line feed \n. 
02766      * This setting is invalid with the evaluation version.  
02767      *
02768      * @param   newVal
02769      *      Pointer to a null-terminated string.
02770      */
02771     void setWatermarkTextW(const wchar_t* newVal);
02772 
02773     /**
02774      * Get the font family of the watermark text. 
02775      *
02776      * @param   pVal
02777      *      Pointer to the buffer that will receive the text.
02778      *      If the string is as long or longer than the buffer,
02779      *      the string is truncated and terminated with a NULL character.
02780      * @param   size
02781      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02782      *      If the text exceeds this limit, it is truncated.
02783      * @return  Returns the 'pVal'.
02784      */
02785     char* getWatermarkFontFamily(char* pVal, int size) const;
02786 
02787     /**
02788      * Get the font family of the watermark text.
02789      *
02790      * @param   pVal
02791      *      Pointer to the buffer that will receive the text. 
02792      *      If the string is as long or longer than the buffer,
02793      *      the string is truncated and terminated with a NULL character.
02794      * @param   size
02795      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02796      *      If the text exceeds this limit, it is truncated.
02797      * @return  Returns the 'pVal'.
02798      */
02799     wchar_t* getWatermarkFontFamilyW(wchar_t* pVal, int size) const;
02800 
02801     /**
02802      * Specifies the font family to the character string which you set to watermark-text.  
02803      *
02804      * @param   newVal
02805      *      Pointer to a null-terminated string.
02806      */
02807     void setWatermarkFontFamily(const char* newVal);
02808 
02809     /**
02810      * Specifies the font family to the character string which you set to watermark-text.  
02811      *
02812      * @param   newVal
02813      *      Pointer to a null-terminated string.
02814      */
02815     void setWatermarkFontFamilyW(const wchar_t* newVal);
02816 
02817     /**
02818      * Get the font weight of the watermark text. 
02819      *
02820      * @param   pVal
02821      *      Pointer to the buffer that will receive the text.
02822      *      If the string is as long or longer than the buffer,
02823      *      the string is truncated and terminated with a NULL character.
02824      * @param   size
02825      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02826      *      If the text exceeds this limit, it is truncated.
02827      * @return  Returns the 'pVal'.
02828      */
02829     char* getWatermarkFontWeight(char* pVal, int size) const;
02830 
02831     /**
02832      * Get the font weight of the watermark text.  
02833      *
02834      * @param   pVal
02835      *      Pointer to the buffer that will receive the text. 
02836      *      If the string is as long or longer than the buffer,
02837      *      the string is truncated and terminated with a NULL character.
02838      * @param   size
02839      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02840      *      If the text exceeds this limit, it is truncated.
02841      * @return  Returns the 'pVal'.
02842      */
02843     wchar_t* getWatermarkFontWeightW(wchar_t* pVal, int size) const;
02844 
02845     /**
02846      * Specifies the font weight to the character string which you set to watermark-text. 
02847      * Possible to specify normal, bold or the numerical value from 100 to 900.  
02848      *
02849      * @param   newVal
02850      *      Pointer to a null-terminated string.
02851      */
02852     void setWatermarkFontWeight(const char* newVal);
02853 
02854     /**
02855      * Specifies the font weight to the character string which you set to watermark-text. 
02856      * Possible to specify normal, bold or the numerical value from 100 to 900.  
02857      *
02858      * @param   newVal
02859      *      Pointer to a null-terminated string.
02860      */
02861     void setWatermarkFontWeightW(const wchar_t* newVal);
02862 
02863     /**
02864      * Get the font style of the watermark text.
02865      *
02866      * @param   pVal
02867      *      Pointer to the buffer that will receive the text.
02868      *      If the string is as long or longer than the buffer,
02869      *      the string is truncated and terminated with a NULL character.
02870      * @param   size
02871      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02872      *      If the text exceeds this limit, it is truncated.
02873      * @return  Returns the 'pVal'.
02874      */
02875     char* getWatermarkFontStyle(char* pVal, int size) const;
02876 
02877     /**
02878      * Get the font style of the watermark text.  
02879      *
02880      * @param   pVal
02881      *      Pointer to the buffer that will receive the text. 
02882      *      If the string is as long or longer than the buffer,
02883      *      the string is truncated and terminated with a NULL character.
02884      * @param   size
02885      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02886      *      If the text exceeds this limit, it is truncated.
02887      * @return  Returns the 'pVal'.
02888      */
02889     wchar_t* getWatermarkFontStyleW(wchar_t* pVal, int size) const;
02890 
02891     /**
02892      * Specifies the font style to the character string which you set to watermark-text.  
02893      *
02894      * @param   newVal
02895      *      Pointer to a null-terminated string.
02896      */
02897     void setWatermarkFontStyle(const char* newVal);
02898 
02899     /**
02900      * Specifies the font style to the character string which you set to watermark-text.  
02901      *
02902      * @param   newVal
02903      *      Pointer to a null-terminated string.
02904      */
02905     void setWatermarkFontStyleW(const wchar_t* newVal);
02906 
02907     /**
02908      * Get the opacity of the watermark text.
02909      *
02910      * @param   pVal
02911      *      Pointer to the buffer that will receive the text.
02912      *      If the string is as long or longer than the buffer,
02913      *      the string is truncated and terminated with a NULL character.
02914      * @param   size
02915      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02916      *      If the text exceeds this limit, it is truncated.
02917      * @return  Returns the 'pVal'.
02918      */
02919     char* getWatermarkOpacity(char* pVal, int size) const;
02920 
02921     /**
02922      * Get the opacity of the watermark text.   
02923      *
02924      * @param   pVal
02925      *      Pointer to the buffer that will receive the text. 
02926      *      If the string is as long or longer than the buffer,
02927      *      the string is truncated and terminated with a NULL character.
02928      * @param   size
02929      *      Specifies the number of the 'pVal' buffer, including the NULL character.
02930      *      If the text exceeds this limit, it is truncated.
02931      * @return  Returns the 'pVal'.
02932      */
02933     wchar_t* getWatermarkOpacityW(wchar_t* pVal, int size) const;
02934 
02935     /**
02936      * Specifies the opacity to the character string which you set to watermark-text.  
02937      *
02938      * @param   newVal
02939      *      Pointer to a null-terminated string.
02940      */
02941     void setWatermarkOpacity(const char* newVal);
02942 
02943     /**
02944      * Specifies the opacity to the character string which you set to watermark-text.  
02945      *
02946      * @param   newVal
02947      *      Pointer to a null-terminated string.
02948      */
02949     void setWatermarkOpacityW(const wchar_t* newVal);
02950 
02951     /**
02952      * Gets the setting of continuous page numbers across worksheets in Excel header footer/number of pages as a total of all worksheets.
02953      *
02954      * @return          
02955      * If true, inserts continuous page numbers across all worksheets/number of pages as a total of all worksheets.
02956      */
02957     bool getContinuePageNumber() const;
02958 
02959     /**
02960      * Sets continuous page numbers across worksheets in Excel header footer/number of pages as a total of all worksheets.
02961      *
02962      * @param   newVal  
02963      * If true, sets continuous page numbers across all worksheets/number of pages as a total of all worksheets.
02964      */
02965     void setContinuePageNumber(bool newVal);
02966 
02967     /**
02968      * Get the ICC profile file name.
02969      *
02970      * @param   pVal        Pointer to the buffer that will receive the text. 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        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
02973      * @return  Returns the 'pVal'.
02974      */
02975     char* getPdfColorProfile(char* pVal, int size) const;
02976     /**
02977      * Get the ICC profile file name.
02978      *
02979      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
02980      *          the string is truncated and terminated with a NULL character.
02981      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
02982      * @return  Returns the 'pVal'.
02983      */
02984     wchar_t* getPdfColorProfileW(wchar_t* pVal, int size) const;
02985 
02986     /**
02987      * Set the ICC profile file name.
02988      * When PDF/A-1b:2005 is specified to PdfVersion, the specification of the ICC profile is indispensable. Specify the ICC profile with its full path. This parameter is invalid with any PDF other than PDF/A-1b:2005. 
02989      *
02990      * @param   newVal  Pointer to a null-terminated string to be used as the ICC profile file name.
02991      */
02992     void setPdfColorProfile(const char* newVal);
02993 
02994     /**
02995      * Set the ICC profile file name.
02996      * When PDF/A-1b:2005 is specified to PdfVersion, the specification of the ICC profile is indispensable. Specify the ICC profile with its full path. This parameter is invalid with any PDF other than PDF/A-1b:2005. 
02997      *
02998      * @param   newVal  Pointer to a null-terminated string to be used as the ICC profile file name.
02999      */
03000     void setPdfColorProfileW(const wchar_t* newVal);
03001 
03002     /**
03003      * Specifies the open password for document.
03004      *
03005      * @param   newVal
03006      *      Pointer to a null-terminated string.
03007      */
03008     void setOpenPassword(const char* newVal);
03009 
03010     /**
03011      * Specifies the open password for document.
03012      *
03013      * @param   newVal
03014      *      Pointer to a null-terminated string.
03015      */
03016     void setOpenPasswordW(const wchar_t* newVal);
03017 
03018     /**
03019      * Get the setting of Support for correct number of pages in Word.
03020      *
03021      * @return
03022      * If true, support for correct number of pages and dynamically updating table of contents in Word.
03023      */
03024     long getPageNumberCorrection() const;
03025 
03026     /**
03027      * Set the setting of Support for correct number of pages in Word.
03028      *
03029      * @param   newVal
03030      * If true, sets support for correct number of pages and dynamically updating table of contents in Word.
03031      */
03032     void setPageNumberCorrection(long newVal);
03033 
03034     /**
03035      * Gets the specified sheet first to output the active sheet when files are saved in MS Excel.
03036      *
03037      * @return Return to specify the active sheet to sheet top output when files are saved in MS Excel.
03038      */
03039     bool getSheetOrderActiveFirst() const;
03040     
03041     /**
03042      * Set to specify the active sheet to sheet top output when files are saved in MS Excel.
03043      *
03044      * @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
03045      */
03046     void setSheetOrderActiveFirst(bool newVal);
03047 
03048     /**
03049      * Get the sheet order and select.
03050      *
03051      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03052      *          the string is truncated and terminated with a NULL character.
03053      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03054      * @return  Returns the 'pVal'.
03055      */
03056     char* getSheetOrderSelect(char* pVal, int size) const;
03057     /**
03058      * Get the sheet order and select.
03059      *
03060      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03061      *          the string is truncated and terminated with a NULL character.
03062      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03063      * @return  Returns the 'pVal'.
03064      */
03065     wchar_t* getSheetOrderSelectW(wchar_t* pVal, int size) const;
03066 
03067     /**
03068      * Set the sheet order and select.
03069      *
03070      * @param   newVal  Pointer to a null-terminated string to be used as the sheet order and select.
03071      */
03072     void setSheetOrderSelect(const char* newVal);
03073 
03074     /**
03075      * Set the sheet order and select.
03076      *
03077      * @param   newVal  Pointer to a null-terminated string to be used as the sheet order and select.
03078      */
03079     void setSheetOrderSelectW(const wchar_t* newVal);
03080 
03081     /**
03082      * Get the locale.
03083      *
03084      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03085      *          the string is truncated and terminated with a NULL character.
03086      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03087      * @return  Returns the 'pVal'.
03088      */
03089     char* getLocale(char* pVal, int size) const;
03090     /**
03091      * Get the locale.
03092      *
03093      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03094      *          the string is truncated and terminated with a NULL character.
03095      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03096      * @return  Returns the 'pVal'.
03097      */
03098     wchar_t* getLocaleW(wchar_t* pVal, int size) const;
03099 
03100     /**
03101      * Set the locale.
03102      *
03103      * @param   newVal  Pointer to a null-terminated string to be used as the locale.
03104      */
03105     void setLocale(const char* newVal);
03106 
03107     /**
03108      * Set the locale.
03109      *
03110      * @param   newVal  Pointer to a null-terminated string to be used as the locale.
03111      */
03112     void setLocaleW(const wchar_t* newVal);
03113 
03114     /**
03115      * Get the RowColControl configuration file name.
03116      *
03117      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03118      *          the string is truncated and terminated with a NULL character.
03119      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03120      * @return  Returns the 'pVal'.
03121      */
03122     char* getRowColControlFileName(char* pVal, int size) const;
03123 
03124     /**
03125      * Get the RowColControl configuration file name.
03126      *
03127      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03128      *          the string is truncated and terminated with a NULL character.
03129      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03130      * @return  Returns the 'pVal'.
03131      */
03132     wchar_t* getRowColControlFileNameW(wchar_t* pVal, int size) const;
03133 
03134     /**
03135      * Set the RowColControl configuration file name.
03136      *
03137      * @param   newVal  Pointer to a null-terminated string to be used as the file name.
03138      */
03139     void setRowColControlFileName(const char* newVal);
03140 
03141     /**
03142      * Set the RowColControl configuration file name.
03143      *
03144      * @param   newVal  Pointer to a null-terminated string to be used as the file name.
03145      */
03146     void setRowColControlFileNameW(const wchar_t* newVal);
03147 
03148     /**
03149      * Get the RowColControl parameter row,col string.
03150      *
03151      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03152      *          the string is truncated and terminated with a NULL character.
03153      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03154      * @return  Returns the 'pVal'.
03155      */
03156     char* getRowColControlParameter(char* pVal, int size) const;
03157 
03158     /**
03159      * Get the RowColControl parameter row,col string.
03160      *
03161      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03162      *          the string is truncated and terminated with a NULL character.
03163      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03164      * @return  Returns the 'pVal'.
03165      */
03166     wchar_t* getRowColControlParameterW(wchar_t* pVal, int size) const;
03167 
03168     /**
03169      * Set the RowColControl parameter row,col.
03170      *
03171      * @param   newVal  Pointer to a null-terminated string to be used as the parameter row,col string.
03172      */
03173     void setRowColControlParameter(const char* newVal);
03174 
03175     /**
03176      * Set the RowColControl parameter row,col.
03177      *
03178      * @param   newVal  Pointer to a null-terminated string to be used as the parameter row,col string.
03179      */
03180     void setRowColControlParameterW(const wchar_t* newVal);
03181 
03182     /**
03183      * Gets the view information option.
03184      *   default font name/size in file & printer name in sheet and matched parameter.
03185      *
03186      * @return Return to this option.
03187      */
03188     bool getXlsInfoView() const;
03189     
03190     /**
03191      * Set the view information option.
03192      *   default font name/size in file & printer name in sheet and matched parameter.
03193      *
03194      * @param   newVal      If the value is 'true' is specified, Set to the view information option.
03195      */
03196     void setXlsInfoView(bool newVal);
03197 
03198     /**
03199      * Get the XlsPaperDefault parameter string.
03200      *
03201      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03202      *          the string is truncated and terminated with a NULL character.
03203      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03204      * @return  Returns the 'pVal'.
03205      */
03206     char* getXlsPaperDefault(char* pVal, int size) const;
03207 
03208     /**
03209      * Get the XlsPaperDefault parameter string.
03210      *
03211      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03212      *          the string is truncated and terminated with a NULL character.
03213      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03214      * @return  Returns the 'pVal'.
03215      */
03216     wchar_t* getXlsPaperDefaultW(wchar_t* pVal, int size) const;
03217 
03218     /**
03219      * Set the XlsPaperDefault parameter.
03220      *
03221      * @param   newVal  Pointer to a null-terminated string to be used as the parameter string.
03222      */
03223     void setXlsPaperDefault(const char* newVal);
03224 
03225     /**
03226      * Set the XlsPaperDefault parameter.
03227      *
03228      * @param   newVal  Pointer to a null-terminated string to be used as the parameter string.
03229      */
03230     void setXlsPaperDefaultW(const wchar_t* newVal);
03231 
03232     /**
03233      * Get the XlsPaper parameter string.
03234      *
03235      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03236      *          the string is truncated and terminated with a NULL character.
03237      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03238      * @return  Returns the 'pVal'.
03239      */
03240     char* getXlsPaper(char* pVal, int size) const;
03241 
03242     /**
03243      * Get the XlsPaper parameter string.
03244      *
03245      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03246      *          the string is truncated and terminated with a NULL character.
03247      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03248      * @return  Returns the 'pVal'.
03249      */
03250     wchar_t* getXlsPaperW(wchar_t* pVal, int size) const;
03251 
03252     /**
03253      * Set the XlsPaper parameter.
03254      *
03255      * @param   newVal  Pointer to a null-terminated string to be used as the parameter string.
03256      */
03257     void setXlsPaper(const char* newVal);
03258 
03259     /**
03260      * Set the XlsPaper parameter.
03261      *
03262      * @param   newVal  Pointer to a null-terminated string to be used as the parameter string.
03263      */
03264     void setXlsPaperW(const wchar_t* newVal);
03265 
03266 
03267 };
03268 
03269 /***************************************************************
03270  * Exception class that returns the error information in the formatting process.
03271  */
03272 class DFVINTERFACE_API DfvException
03273 {
03274 public:
03275     /**
03276      * Constructor
03277      */
03278     DfvException(DfvIfErrorLevel errorLevel, DfvIfErrorCode errorCode, const wchar_t* errorMessage);
03279 
03280     /**
03281      * Copy constructor
03282      */
03283     DfvException(const DfvException &e);
03284 
03285     /**
03286      * Destructor
03287      */
03288     ~DfvException();
03289 
03290 private:
03291     DfvIfErrorLevel m_errorLevel;           /* Error level */
03292     DfvIfErrorCode  m_errorCode;            /* Error code */
03293     wchar_t*        m_errorMessage;         /* Error message */
03294 
03295 public:
03296     /**
03297      * Get the error level.
03298      *
03299      * @return  Returns the error level.
03300      */
03301     DfvIfErrorLevel getErrorLevel() const;
03302 
03303     /**
03304      * Get the error code.
03305      *
03306      * @return  Returns the error code.
03307      */
03308     DfvIfErrorCode getErrorCode() const;
03309 
03310     /**
03311      * Get the error message.
03312      *
03313      * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03314      *          the string is truncated and terminated with a NULL character.
03315      * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03316      * @return  Returns the 'pVal'.
03317      */
03318     char* getErrorMessage(char* pVal, int size) const;
03319 
03320     /**
03321      * Get the error message.
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     wchar_t* getErrorMessageW(wchar_t* pVal, int size) const;
03329 
03330 };
03331 
03332 }
03333 
03334 #endif  /* DFVIFC_H__ */

Generated on 13 Jul 2017 for Server Based Converter C/C++ Interface by Doxygen 1.3-rc2