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


///////////////////////////////////////////////////////////////////////////////
//
// PdfPublishAnnotationBorderStyle.h
//
///////////////////////////////////////////////////////////////////////////////

#ifndef _PDF_PUBLISH_ANNOTATION_BS_INCLUDED_
#define _PDF_PUBLISH_ANNOTATION_BS_INCLUDED_

#include "PdfPublishBaseObject.h"
#include "DoubleArray.h"

/** \details
  Contains declarations for Publish SDK.
  <group TD_Namespaces>
*/
namespace OdPdfPublish {

/** \details
  A class that implements an annotation border style in .pdf documents created with PDF Publish SDK.
*/
class PDFPUBLISH_TOOLKIT OdAnnotationBorderStyle : public OdObject
{
  //DOM-IGNORE-BEGIN
protected:
  OdAnnotationBorderStyle();
  //DOM-IGNORE-END
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdAnnotationBorderStyle);
  ODRX_HEAP_OPERATORS();
  //DOM-IGNORE-END

  /** \details
    Destroys the stamp annotation object.
  */
  virtual ~OdAnnotationBorderStyle();

  /** \details
    Sets the border width.
    \param width [in] A border width.
  */
  void setWidth(double width);

  /** \details
    Sets the border style.
    \param style [in] A border style value.

    \remarks
    style must be one of the following: Border::Style::kSolid or Border::Style::kDashed.
    if the style is Border::Style::kDashed, then a dash pattern must be set.
  */
  void setStyle(Border::Style style);

  /** \details
    Sets the border dash pattern.
    This property is used only when the border style is set to Border_Dashed.
    \param pattern [in] An array of double values that represent the dash pattern.
  */
  void setDashPattern(const OdDoubleArray& pattern);

  /** \details
    Returns the current border width.
    \param width [out] A placeholder for the border width.
  */
  void getWidth(double& width) const;

  /** \details
    Returns the current border style.
    \param style [out] A placeholder for the border style.
  */
  void getStyle(Border::Style& style) const;

  /** \details
    Returns the current border dash pattern.
    \param pattern [out] A placeholder for the dash pattern.
  */
  void getDashPattern(OdDoubleArray& pattern) const;

};

/** \details
  A data type that represents a smart pointer to an <link OdPdfPublish::OdAnnotationBorderStyle, OdAnnotationBorderStyle> object.
*/
SMARTPTR(OdAnnotationBorderStyle);

}
#endif // _PDF_PUBLISH_ANNOTATION_BS_INCLUDED_