PdfPublishPage.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, 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-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 

//
// PdfPublishPage.h
//
 
#ifndef _PDF_PUBLISH_PAGE_INCLUDED_
#define _PDF_PUBLISH_PAGE_INCLUDED_
 
#include "PdfPublishBaseObject.h"
#include "PdfPublishAnnotation.h"
#include "PdfPublishText.h"
#include "PdfPublishImage.h"
#include "PdfPublishTextField.h"
#include "PdfPublishSignatureField.h"
#include "PdfPublishDropDownList.h"
#include "PdfPublishListBox.h"
#include "PdfPublishRadioButton.h"
#include "PdfPublishCheckBox.h"
#include "PdfPublishLink.h"
#include "PdfPublishSlideTable.h"
#include "PdfPublishButton.h"
#include "PdfPublishTable.h"
#include "PdfPublishTableCreator.h"
#include "PdfPublish2dGeometryReference.h"
#include "PdfPublishCADReference.h"
#include "PdfPublishStickyNote.h"
#include "PdfPublishWatermark.h"

namespace OdPdfPublish{

class PDFPUBLISH_TOOLKIT OdPage : public OdObject
{
  //DOM-IGNORE-BEGIN
protected:
  OdPage();
  //DOM-IGNORE-END
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdPage);
  ODRX_HEAP_OPERATORS();
  //DOM-IGNORE-END
 
  virtual ~OdPage();

  void setFormat(Page::Format format);
  
  void setOrientation(Page::Orientation orientation);

  void setPaperSize(const Page::PaperUnits units, const double width, const double height);
  
  void addAnnotation(const OdAnnotationPtr& annotation, const OdRect& location);

  void addText(const OdTextPtr& text, const OdRect& location, const double rotation = 0.);

  void addImage(const OdImagePtr& image, const OdRect& location, const double rotation = 0.);

  void addTable(const OdTablePtr& table, const OdRect& location);

  void addLink(const OdLinkPtr& link, const OdRect& location);

  void addButton(const OdButtonPtr& button, const OdRect& location);

  void addTextField(const OdTextFieldPtr& text_field, const OdRect& location);

  void addSlideTable(const OdSlideTablePtr& slide_table, const OdRect& location);

  void addCheckBox(const OdCheckBoxPtr& check_box, const OdRect& location);

  void addRadioButton(const OdRadioButtonPtr& radio_button, const OdRect& location);

  void addListBox(const OdListBoxPtr& list_box, const OdRect& location);

  void addDropDownList(const OdDropDownListPtr& drop_down_list, const OdRect& location);

  void addSignatureField(const OdSignatureFieldPtr& signature_field, const OdRect& location);

  void add2dGeometry(const Od2dGeometryReferencePtr& geom, const OdRect& location);

  void add2dGeometry(const Od2dGeometryReferencePtr& geom);

  void addCADReference(const OdCADReferencePtr& CADreferense, const OdRect& location);

  void addCADReference(const OdCADReferencePtr& CADreferense);

  void addStickyNote(const OdStickyNotePtr& note, const OdRect& location);

  void addWatermark(const OdWatermarkPtr& watermark, const OdRect& location);
 
  void addJavaScriptActionByField(const OdString& field_name, const OdString& source, const Action::Type action_type, const Source::Type source_type = Source::kCode);

  void getFormat(Page::Format& format) const;
  
  void getOrientation(Page::Orientation& orientation) const;

  void getPaperSize(const Page::PaperUnits units, double& width, double& height) const;

  void getAnnotations(OdAnnotationPtrArray& annotations, OdRectArray& locations) const;

  void getTexts(OdTextPtrArray& texts, OdRectArray& locations, OdDoubleArray& rotations) const;

  void getImages(OdImagePtrArray& images, OdRectArray& locations, OdDoubleArray& rotations) const;

  void getTables(OdTablePtrArray& tables, OdRectArray& locations) const;

  void getLinks(OdLinkPtrArray& links, OdRectArray& locations) const;

  void getButtons(OdButtonPtrArray& buttons, OdRectArray& locations) const;

  void getCheckBoxes(OdCheckBoxPtrArray& check_boxes, OdRectArray& locations) const;

  void getRadioButtons(OdRadioButtonPtrArray& radio_buttons, OdRectArray& locations) const;

  void getListBoxes(OdListBoxPtrArray& list_boxes, OdRectArray& locations) const;

  void getDropDownLists(OdDropDownListPtrArray& drop_down_lists, OdRectArray& locations) const;
  
  void getSignatureFields(OdSignatureFieldPtrArray& signature_fields, OdRectArray& locations) const;

  void getTextFields(OdTextFieldPtrArray& text_fields, OdRectArray& locations) const;

  void getSlideTables(OdSlideTablePtrArray& slide_tables, OdRectArray& locations) const;

  void getJavaScriptActionsByField(const OdString& field_name, OdStringArray& sources, OdActionTypeArray& action_types, OdSourceTypeArray& source_types) const;

  void get2dGeoms(Od2dGeometryReferencePtrArray& geoms, OdRectArray& locations) const;
  
  void getCADReferences(OdCADReferencePtrArray& CADreferenses, OdRectArray& locations) const;
  
  void getStickyNotes(OdStickyNotePtrArray& notes, OdRectArray& locations) const;

  void getWatermarks(OdWatermarkPtrArray& watermarks, OdRectArray& locations) const;
};

SMARTPTR(OdPage);
 
}
#endif // _PDF_PUBLISH_PAGE_INCLUDED_