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

//
// PdfPublishCollectionFolder.h
//
 
#ifndef _PDF_PUBLISH_ATTACHED_FOLDER_INCLUDED_
#define _PDF_PUBLISH_ATTACHED_FOLDER_INCLUDED_
 
#include "PdfPublishBaseObject.h"
#include "PdfPublishImage.h"
#include "StringArray.h"
#include "DoubleArray.h"

namespace OdPdfPublish{
 
  class OdAttachedFolder;
  SMARTPTR(OdAttachedFolder);

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

  virtual ~OdAttachedFolder();

  void setName(const OdString& name);

  void setDescription(const OdString& description);

  void setCreationDate(const OdTimeStamp& creation_date);

  void setModDate(const OdTimeStamp& mod_date);

  void setThumb(const OdImagePtr& pImage);

  void addTextCollectionItem(const OdString& name, const OdString& item);

  void addDateCollectionItem(const OdString& name, const OdTimeStamp& date);

  void addNumberCollectionItem(const OdString& name, const double& number);

  void addChildFolder(const OdAttachedFolderPtr& folder);

  void addFile(const OdAttachedFilePtr& file);

  void getName(OdString& name) const;

  void getDescription(OdString& description) const;

  void getCreationDate(OdTimeStamp& creation_date) const;

  void getModDate(OdTimeStamp& mod_date) const;

  void getThumb(OdImagePtr& pOutImage) const;

  void getTextCollectionItems(OdStringArray& names, OdStringArray& items) const;

  void getDateCollectionItems(OdStringArray& names, OdArray<OdTimeStamp>& dates) const;

  void getNumberCollectionItems(OdStringArray& names, OdDoubleArray& numbers) const;

  void getChildFolders(OdAttachedFolderPtrArray& folders) const;

  void getFiles(OdAttachedFilePtrArray& files) const;
 
};
 
}
#endif // _PDF_PUBLISH_ATTACHED_FOLDER_INCLUDED_