fs_portfolio.h

Go to the documentation of this file.

#ifndef FS_PORTFOLIO_H_
#define FS_PORTFOLIO_H_

#include "common/fs_common.h"
#include "pdf/fs_pdfdoc.h"
#include "pdf/fs_filespec.h"

namespace foxit {
namespace pdf {
namespace portfolio {
class PortfolioNode;
class PortfolioFolderNode;
class PortfolioFileNode;
class SchemaField;
class Portfolio;

class PortfolioNode : public Base {
 public:
  typedef enum _Type {
    e_TypeUnknown  = 0,
    e_TypeFolder  = 1,
    e_TypeFile    = 2
  } Type;
  
  PortfolioNode(const PortfolioNode& other);
  ~PortfolioNode();
  PortfolioNode& operator = (const PortfolioNode& other);

  bool operator == (const PortfolioNode& other) const;
  bool operator != (const PortfolioNode& other) const;

  bool IsEmpty() const;

  Type GetNodeType() const;

  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
  explicit PortfolioNode(FS_HANDLE handle = NULL);

};

FSDK_DEFINE_ARRAY(PortfolioNodeArray, PortfolioNode)

class PortfolioFileNode;

class PortfolioFolderNode FS_FINAL : public PortfolioNode {
 public:
  explicit PortfolioFolderNode(const PortfolioNode& other);

  ~PortfolioFolderNode() {}

  bool IsRoot() const;

  WString GetName() const;

  PortfolioFileNode AddFile(const wchar_t* file_path);
  PortfolioFileNode AddFile(foxit::common::file::StreamCallback* file_stream, const wchar_t* file_name);
  PortfolioFileNode AddPDFDoc(const PDFDoc& pdf_doc, const wchar_t* file_name);

  PortfolioFolderNode AddSubFolder(const wchar_t* folder_name);

  void RemoveSubNode(const PortfolioNode& sub_node);

  PortfolioNodeArray GetSortedSubNodes() const;

  DateTime GetModifiedDateTime() const;
  DateTime GetCreationDateTime() const;

  WString GetDescription() const;
  void SetDescription(const wchar_t* description);

  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
  explicit PortfolioFolderNode(FS_HANDLE handle = NULL);

};

class PortfolioFileNode FS_FINAL : public PortfolioNode {
 public:
  explicit PortfolioFileNode(const PortfolioNode& other);

  ~PortfolioFileNode() {}

  FileSpec GetFileSpec() const;

  WString GetKeyName() const;

  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
  explicit PortfolioFileNode(FS_HANDLE handle = NULL);

};

class SchemaField FS_FINAL : public Base {
 public:
  SchemaField();

  SchemaField(const SchemaField& other);
  SchemaField& operator = (const SchemaField& other); 

  bool operator == (const SchemaField& other) const;
  bool operator != (const SchemaField& other) const;

  bool IsEmpty() const;

  ~SchemaField();

  String GetKeyName() const;

  void SetKeyName(const char* key_name);

  String GetSubtypeName() const;
  void SetSubtypeName(const char* subtype_name);

  WString GetDisplayName() const;
  void SetDisplayName(const wchar_t* display_name);

  bool IsVisible() const;
  void SetVisibility(bool is_visible);

  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
  explicit SchemaField(FS_HANDLE handle);

};

FSDK_DEFINE_ARRAY(SchemaFieldArray, SchemaField)


class Portfolio FS_FINAL : public Base {
 public:
  typedef enum _InitialViewMode {
    e_InitialViewUnknownMode  = 0,
    e_InitialViewDetailMode  = 1,
    e_InitialViewTileMode    = 2,
    e_InitialViewHidden    = 3
  } InitialViewMode;
  

  static Portfolio CreatePortfolio();

  static Portfolio CreatePortfolio(const foxit::pdf::PDFDoc& portfolio_pdf_doc);

  Portfolio(const Portfolio& other);
  Portfolio& operator = (const Portfolio& other);

  bool operator == (const Portfolio& other) const;
  bool operator != (const Portfolio& other) const;

  bool IsEmpty() const; 

  ~Portfolio();

  PDFDoc GetPortfolioPDFDoc() const;

  PortfolioNode GetRootNode() const;

  InitialViewMode GetInitialViewMode() const;
  void SetInitialViewMode(InitialViewMode mode);

  bool IsSortedInAscending() const;
  void SetSortingOrder(bool use_ascending_order);
  String GetSortingFieldKeyName() const;
  void SetSortingFieldKeyName(const char* name);

  WString GetInitialFileSpecKeyName() const;
  void SetInitialFileSpecKeyName(const wchar_t* name);

  SchemaFieldArray GetSchemaFields() const;
  void SetSchemaFields(const SchemaFieldArray& field_array);

  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
  explicit Portfolio(FS_HANDLE handle =  NULL);

};

}  // namespace portfolio
}  // namespace pdf
}  // namespace foxit

#endif  // FS_PORTFOLIO_H_