Go to the documentation of this file.
15 #ifndef FS_PORTFOLIO_H_
16 #define FS_PORTFOLIO_H_
485 typedef enum _InitialViewMode {
487 e_InitialViewUnknownMode = 0,
492 e_InitialViewDetailMode = 1,
497 e_InitialViewTileMode = 2,
501 e_InitialViewHidden = 3
567 bool IsEmpty()
const;
577 PDFDoc GetPortfolioPDFDoc()
const;
594 InitialViewMode GetInitialViewMode()
const;
603 void SetInitialViewMode(InitialViewMode mode);
611 bool IsSortedInAscending()
const;
621 void SetSortingOrder(
bool use_ascending_order);
627 String GetSortingFieldKeyName()
const;
635 void SetSortingFieldKeyName(
const char* name);
645 WString GetInitialFileSpecKeyName()
const;
657 void SetInitialFileSpecKeyName(
const wchar_t* name);
688 #endif // FS_PORTFOLIO_H_
bool operator!=(const PortfolioNode &other) const
Not equal operator.
bool IsVisible() const
Check if current field is initially visible in application or not.
WString GetName() const
Get name of current folder node.
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
Definition: fs_filespec.h:38
~PortfolioFolderNode()
Destructor.
Definition: fs_portfolio.h:132
void SetSubtypeName(const char *subtype_name)
Set the subtype name string.
Definition: fs_basictypes.h:460
File stream interface, reading & writing.
Definition: fx_stream.h:675
DateTime GetModifiedDateTime() const
Get the last modified date time.
void SetDisplayName(const wchar_t *display_name)
Set the display name.
Header file for common definitions and classes.
Portfolio node type: folder.
Definition: fs_portfolio.h:50
Unknown portfolio node type.
Definition: fs_portfolio.h:48
PortfolioNodeArray GetSortedSubNodes() const
Get sub nodes array, which has been sorted according to sorting order and specified field name define...
WString GetDisplayName() const
Get the display name.
Definition: fs_portfolio.h:112
Definition: fs_portfolio.h:260
WString GetDescription() const
Get description.
bool IsRoot() const
Check if current folder node represents root node.
~SchemaField()
Destructor.
PortfolioFolderNode AddSubFolder(const wchar_t *folder_name)
Add a new sub folder.
Definition: fs_portfolio.h:122
String GetSubtypeName() const
Get the subtype name string.
bool operator==(const SchemaField &other) const
Equal operator.
FileSpec GetFileSpec() const
Get the related file specification object which is used to access an embedded file information and da...
BYTE STRING CLASS.
Definition: fx_string.h:317
Definition: fs_portfolio.h:478
PortfolioFolderNode(const PortfolioNode &other)
Constructor, with parent class object.
void SetKeyName(const char *key_name)
Set the key name string.
Definition: fs_portfolio.h:297
void RemoveSubNode(const PortfolioNode &sub_node)
Remove a sub node.
Definition: fs_portfolio.h:470
bool operator==(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are equal.
Definition: fs_basictypes.h:128
PortfolioNode & operator=(const PortfolioNode &other)
Assign operator.
void SetDescription(const wchar_t *description)
Set description.
void SetVisibility(bool is_visible)
Set the initial visibility of current field in application.
Foxit namespace.
Definition: fs_taggedpdf.h:27
Type
Enumeration for portfolio node type.
Definition: fs_portfolio.h:46
Header file for file specification related definitions and classes.
bool operator!=(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are not equal.
Definition: fs_basictypes.h:140
DateTime GetCreationDateTime() const
Get the creation date time.
~PortfolioNode()
Destructor.
Header file for PDF document related definitions and classes.
WString GetKeyName() const
Get the key name of the related file specification object.
bool IsEmpty() const
Check whether current object is empty or not.
PortfolioFileNode AddPDFDoc(const PDFDoc &pdf_doc, const wchar_t *file_name)
Add an loaded PDF document to be a sub node.
#define NULL
The null-pointer value.
Definition: fx_system.h:780
SchemaField()
Constructor.
SchemaField & operator=(const SchemaField &other)
Assign operator.
Definition: fs_pdfdoc.h:610
bool operator!=(const SchemaField &other) const
Not equal operator.
PortfolioFileNode AddFile(const wchar_t *file_path)
Add a file (specified by file path) to be a sub node.
Portfolio node type: file.
Definition: fs_portfolio.h:52
bool operator==(const PortfolioNode &other) const
Equal operator.
PortfolioNode(const PortfolioNode &other)
Constructor, with another portfolio node object.
Type GetNodeType() const
Get node type.
WIDE STRING CLASS.
Definition: fx_string.h:1452
PortfolioFileNode(const PortfolioNode &other)
Constructor, with parent class object.
Definition: fs_portfolio.h:39
bool IsEmpty() const
Check whether current object is empty or not.
Definition: fs_basictypes.h:427
~PortfolioFileNode()
Destructor.
Definition: fs_portfolio.h:270
String GetKeyName() const
Get the key name string.
@2024 Foxit Software Incorporated. All rights reserved.