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

//
// PdfPublishCollection.h
//
 
#ifndef _PDF_PUBLISH_COLLECTION_INCLUDED_
#define _PDF_PUBLISH_COLLECTION_INCLUDED_
 
#include "PdfPublishBaseObject.h"
#include "PdfPublishAttachedFile.h"
#include "PdfPublishCollectionFolder.h"
#include "PdfPublishCollectionColumn.h"

namespace OdPdfPublish{

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

  virtual ~OdCollection();

  void addColumn(const OdCollectionColumnPtr& column);

  void setColumns(const OdCollectionColumnPtrArray& columns);

  void setInitialFile(const OdAttachedFilePtr& file);

  void setInitalViewType(const CollectionSchema::InitialView view_type);

  void setBackgroundColor(const ODCOLORREF color);

  void setCardBackgroundColor(const ODCOLORREF color);

  void setCardBorderColor(const ODCOLORREF color);

  void setPrimaryTextColor(const ODCOLORREF color);

  void setSecondaryTextColor(const ODCOLORREF color);

  void setRootFolder(const OdAttachedFolderPtr& folder);

  void getColumns(OdCollectionColumnPtrArray& columns) const;

  void getInitialFile(OdAttachedFilePtr& file) const;

  void getInitalViewType(CollectionSchema::InitialView view_type) const;

  void getBackgroundColor(ODCOLORREF& color) const;

  void getCardBackgroundColor(ODCOLORREF& color) const;

  void getCardBorderColor(ODCOLORREF& color) const;

  void getPrimaryTextColor(ODCOLORREF& color) const;

  void getSecondaryTextColor(ODCOLORREF& color) const;

  void getRootFolder(OdAttachedFolderPtr& folder) const;
};

SMARTPTR(OdCollection);
 
}
#endif // _PDF_PUBLISH_COLLECTION_INCLUDED_