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

dfvifc.h

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

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