PdfPublishAnnotation.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.
 

//
// PdfPublishAnnotation.h
//
 
#ifndef _PDF_PUBLISH_ANNOTATION_INCLUDED_
#define _PDF_PUBLISH_ANNOTATION_INCLUDED_
 
#include "PdfPublishBaseObject.h"
#include "PdfPublishArtwork.h"
#include "PdfPublishImage.h"
#include "PdfPublishModel.h"
#include "PdfPublishListBox.h"
#include "PdfPublishTextField.h"
#include "UInt32Array.h"
#include "StringArray.h"
#include "DoubleArray.h"
 

namespace OdPdfPublish{

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

  void setSource(const OdCADModelPtr& cad_model);
    
  void setName(const OdString& name);
    
  void setArtwork(const OdArtworkPtr& artwork);
  
  void setToolbarVisibility(bool state);
  
  void setModelTreeVisibility(bool state);
  
  void setInteractivity(bool state);
  
  void setBorderWidth(OdUInt16 width);
  
  void setTransparentBackground(bool state);
  
  void setPosterImage(const OdImagePtr& image);

  void setActivation(Activation::When when);
  
  void setDeactivation(Deactivation::When when);

  void setCarouselButtons(const OdStringArray& button_names, const OdString& previous_button_name, const OdString& next_button_name, OdUInt16 scroll_size);
  
  void setCarouselViews(const OdUInt32Array& indices, const OdImagePtrArray& images);
  
  void setCarouselScrollButtonsImages(const OdImagePtr& previous_button, const OdImagePtr& next_button);

  void setCarouselButtonsFillColor(const ODCOLORREF color);

  void setCarouselButtonsOffset(const OdUInt32 value);

  void setCarouselButtonsFont(const OdString& fontName, Text::FontStyle fontStyle = Text::kRegular, Text::Language language = Text::kDefault, bool embed = false);

  void setCarouselButtonsFont(const Text::StandardFontsType fontType);

  void setCarouselButtonsFontSize(OdUInt16 size);

  void setCarouselButtonsAlignment(CarouselButtons::Alignment alignment);

  void setViewListByField(const OdString& field);
  
  void setViewList(const OdRect& location, const OdListBoxPtr& list);
    
  void setPartsList(const OdStringArray node_names, const OdRect& location, const OdStringArray& headers, const OdDoubleArray& columns, 
    const OdTextFieldPtr text_style = OdTextFieldPtr(), const OdTextFieldPtr header_style = OdTextFieldPtr());

  void setPropertyList(const OdRect& location);

  void setPropertyToTextField(const OdString& property_name, const OdTextFieldPtr text_fields);

  void getSource(OdCADModelPtr& cad_model) const;
  
  void getName(OdString& name) const;
  
  void getArtwork(OdArtworkPtr& artwork) const;
  
  void getToolbarVisibility(bool& state) const;
  
  void getModelTreeVisibility(bool& state) const;
  
  void getInteractivity(bool& state) const;
  
  void getBorderWidth(OdUInt16& width) const;
  
  void getTransparentBackground(bool& state) const;
  
  void getPosterImage(OdImagePtr& image) const;

  void getActivation(Activation::When& when) const;
  
  void getDeactivation(Deactivation::When& when) const;

  void getCarouselButtons(OdStringArray& button_names, OdString& previous_button_name, OdString& next_button_name, OdUInt16& scroll_size) const;
  
  void getCarouselViews(OdUInt32Array& indices, OdImagePtrArray& images) const;
  
  void getCarouselScrollButtonsImages(OdImagePtr& previous_button, OdImagePtr& next_button) const;

  void getCarouselButtonsFillColor(ODCOLORREF& color) const;

  void getCarouselButtonsOffset(OdUInt32& value) const;

  void getCarouselButtonsFont(Text::StorageType& storageType, Text::StandardFontsType& fontType, OdString& fontName, Text::FontStyle& fontStyle, Text::Language& language, bool& embed) const;

  void getCarouselButtonsFontSize(OdUInt16& size) const;

  void getCarouselButtonsAlignment(CarouselButtons::Alignment& alignment) const;

  void getViewListField(OdString& field) const;

  void getViewList(OdRect& location, OdListBoxPtr& list) const;
  
  void getPartsList(OdStringArray& node_names, OdRect& location, OdStringArray& headers, OdDoubleArray& columns, 
    OdTextFieldPtr& text_style, OdTextFieldPtr& header_style) const;

  void getPropertyList(OdRect& location) const;

  void getPropertyToTextField(const OdString& property_name, OdTextFieldPtrArray& text_field) const;
};

SMARTPTR(OdAnnotation);
 
}
#endif // _PDF_PUBLISH_ANNOTATION_INCLUDED_