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


///////////////////////////////////////////////////////////////////////////////
//
// PdfPublishCollectionColumn.h
//
///////////////////////////////////////////////////////////////////////////////

#ifndef _PDF_PUBLISH_COLLECTION_COLUMN_INCLUDED_
#define _PDF_PUBLISH_COLLECTION_COLUMN_INCLUDED_

#include "PdfPublishBaseObject.h"
#include "PdfPublishAttachedFile.h"
#include "PdfPublishCollectionFolder.h"

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

/** \details
   This class implements a collection column entity in PDF documents created with Publish SDK.
*/
class PDFPUBLISH_TOOLKIT OdCollectionColumn : public OdObject
{
protected:
  OdCollectionColumn();
public:
  ODRX_DECLARE_MEMBERS(OdCollectionColumn);
  ODRX_HEAP_OPERATORS();

  /** \details
    Destroys the collection column object.
  */
  ~OdCollectionColumn() override;

  /** \details
    Sets a new name of the collection column object.
    Call the <link OdPdfPublish::OdObject::isValid@const, isValid()> method inherited from the <link OdPdfPublish::OdObject, OdObject> 
    class to check the status of the operation.

    \param name [in] A <exref target="../tkernel_api_cpp/OdString.html">string</exref> that contains the new name.
    
    \remarks
    * The name cannot contain any special characters or spaces. 
    * To display the collection items, the collection must contain a column with the same name.
  */
  void setName(const OdString& name);

  /** \details
    Sets a new caption for the collection column object.

    \param caption [in] A <exref target="../tkernel_api_cpp/OdString.html">string</exref> that contains the new caption.
  */
  void setCaption(const OdString& caption);

  /** \details
    Sets the type for the collection column. 
    The type is represented with one of the <link OdPdfPublish::CollectionSchema::ColumnType, column types>.

    \param type [in] A new column type value.

    \sa
    <link OdPdfPublish::CollectionSchema::ColumnType, CollectionSchema::ColumnType enumeration>.
  */
  void setColumnType(const CollectionSchema::ColumnType& type);

  /** \details
    Sets the value of the &quot;visibility on start&quot; flag for the collection column.

    \param val [in] A new value of the visibility flag.
  */
  void setVisibleOnStart(const bool val);

  /** \details
    Sets a new value of the &quot;editability&quot; flag for the collection column.
    The &quot;editability&quot; flag determines whether the collection column can be edited (when it is equal to true) or not (when it is equal to false).

    \param val [in] A Boolean value that contains the new &quot;editability&quot; flag value.
  */
  void setEnableEdit(const bool val);

  /** \details
    Sets the <link OdPdfPublish::CollectionSchema::SortOrder, sort type> for the collection column. 
    The type is represented with a value of the <link OdPdfPublish::CollectionSchema::SortOrder, enumeration>.

    \param sort [in] A new column <link OdPdfPublish::CollectionSchema::SortOrder, sort type> value.

    \sa
    <link OdPdfPublish::CollectionSchema::SortOrder, CollectionSchema::SortOrder enumeration>.
  */
  void setSortOrder(const CollectionSchema::SortOrder& sort);

  /** \details
    Returns the current name of the collection column.
    The method fills a passed <exref target="../tkernel_api_cpp/OdString.html">string</exref> object and returns it to the calling subroutine.

    \param name [out] A placeholder for the name.
  */
  void getName(OdString& name) const;

  /** \details
    Returns the current caption of the collection column.
    The method fills a passed <exref target="../tkernel_api_cpp/OdString.html">string</exref> object and returns it to the calling subroutine.

    \param caption [out] A placeholder for the caption.
  */
  void getCaption(OdString& caption) const;

  /** \details
    Returns the <link OdPdfPublish::CollectionSchema::ColumnType, collection column type>.
    The method fills a passed <link OdPdfPublish::CollectionSchema::ColumnType, collection column type> value and returns it to a calling subroutine.

    \param type [out] A placeholder for the <link OdPdfPublish::CollectionSchema::ColumnType, collection column type> value.

    \sa
    <link OdPdfPublish::CollectionSchema::ColumnType, CollectionSchema::ColumnType enumeration>.
  */
  void getColumnType(CollectionSchema::ColumnType& type) const;

  /** \details
    Returns the current value of the visibility flag from the collection column.

    \param val [out] A placeholder for a Boolean value that contains the visibility flag value.
  */
  void getVisibleOnStart(bool& val) const;

  /** \details
    Returns the current value of the &quot;editability&quot; flag from the collection column.
    The &quot;editability&quot; flag determines whether the collection column can be edited (when it is equal to true) or not (when it is equal to false).
    
    \param val [out] A placeholder for a Boolean value that contains the &quot;editability&quot; flag value.
  */
  void getEnableEdit(bool& val) const;

  /** \details
    Returns the <link OdPdfPublish::CollectionSchema::SortOrder, sort type> for the collection column type.
    The method fills a passed <link OdPdfPublish::CollectionSchema::SortOrder, sort type> value and returns it to a calling subroutine.

    \param sort [out] A placeholder for the <link OdPdfPublish::CollectionSchema::SortOrder, sort type> value.

    \sa
    <link OdPdfPublish::CollectionSchema::SortOrder, CollectionSchema::SortOrder enumeration>.
  */
  void getSortOrder(CollectionSchema::SortOrder& sort) const;

};

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

}
#endif // _PDF_PUBLISH_COLLECTION_COLUMN_INCLUDED_