/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

#if _MSC_VER > 1000         // remove "PCH warning: cannot find a suitable header stop location"
#pragma once
#endif // _MSC_VER > 1000


#ifndef _OD_PDF_DB_WRAPPER_INCLUDED_
#define _OD_PDF_DB_WRAPPER_INCLUDED_

#include "PdfResultEx.h"
#include "../../Exports/PdfExport/Include/PdfExportDef.h"

/** \details 
  The namespace contains declarations related to working with PDF format.

  <group TD_Namespaces>
*/
namespace OdPDF
{

  /** \details
  This class implements a wrapper interface to work with the <exref target="../tkernel_api_cpp/OdDbBaseDatabase.html">database</exref> 
  during PDF export.
*/
  class PDFEXPORT_DLL OdDatabaseToPdfWrapperInterface : public OdRxObject
  {
  public:

    /** \details
      Starts a <exref target="../tkernel_api_cpp/OdDbBaseDatabase.html">database</exref> handling operation.
      \remarks
      Must be called to open the <exref target="../tkernel_api_cpp/OdDbBaseDatabase.html">database</exref> before handling its content.
    */
    virtual void startDatabaseHandling() = 0;

    /** \details
      Ends a <exref target="../tkernel_api_cpp/OdDbBaseDatabase.html">database</exref> handling operation.
      \param result [in] A result code.
      \remarks
      Must be called to close the <exref target="../tkernel_api_cpp/OdDbBaseDatabase.html">database</exref> after it is handled.
    */
    virtual void endDatabaseHandling(PDFResultEx result) = 0;

    /** \details
      Retrieves the <exref target="../tkernel_api_cpp/OdDbBaseDatabase.html">database</exref> object 
      associated with the <link OdPDF::OdDatabaseToPdfWrapperInterface, OdDatabaseToPdfWrapperInterface> object.
      \returns A pointer to the <exref target="../tkernel_api_cpp/OdDbBaseDatabase.html">database</exref><exref target="../tkernel_api_cpp/OdDbBaseDatabase.html">database</exref> object.
    */
    virtual OdDbBaseDatabase* getDatabase() = 0;
  };

  /** \details 
    A data type that represents a smart pointer to an <link OdPDF::OdDatabaseToPdfWrapperInterface, OdDatabaseToPdfWrapperInterface> object.
  */
  typedef OdSmartPtr<OdDatabaseToPdfWrapperInterface> OdDbToPdfWrapperIfacePtr;

}

#endif //_OD_PDF_DB_WRAPPER_INCLUDED_