Foxit PDF SDK
foxit::pdf::portfolio::PortfolioNode Class Reference
Inheritance diagram for foxit::pdf::portfolio::PortfolioNode:
foxit::Base foxit::pdf::portfolio::PortfolioFileNode foxit::pdf::portfolio::PortfolioFolderNode

Public Types

enum  Type { e_TypeUnknown = 0, e_TypeFolder = 1, e_TypeFile = 2 }
 Enumeration for portfolio node type. More...
 

Public Member Functions

 PortfolioNode (const PortfolioNode &other)
 Constructor, with another portfolio node object. More...
 
 ~PortfolioNode ()
 Destructor.
 
Type GetNodeType () const
 Get node type. More...
 
bool IsEmpty () const
 Check whether current object is empty or not. More...
 
bool operator != (const PortfolioNode &other) const
 Not equal operator. More...
 
PortfolioNodeoperator= (const PortfolioNode &other)
 Assign operator. More...
 
bool operator== (const PortfolioNode &other) const
 Equal operator. More...
 
- Public Member Functions inherited from foxit::Base
FS_HANDLE Handle () const
 Get the handle of current object. More...
 

Detailed Description

Class PortfolioNode is the base class for all types of portfolio nodes.

Member Enumeration Documentation

◆ Type

Enumeration for portfolio node type.

Values of this enumeration should be used alone.

Enumerator
e_TypeUnknown 

Unknown portfolio node type.

e_TypeFolder 

Portfolio node type: folder.

e_TypeFile 

Portfolio node type: file.

Constructor & Destructor Documentation

◆ PortfolioNode()

foxit::pdf::portfolio::PortfolioNode::PortfolioNode ( const PortfolioNode other)

Constructor, with another portfolio node object.

Parameters
[in]otherAnother PDF portfolio folder object.

Member Function Documentation

◆ GetNodeType()

Type foxit::pdf::portfolio::PortfolioNode::GetNodeType ( ) const

Get node type.

Returns
Node type. Please refer to values starting from PortfolioNode::e_TypeFolder and this would be one of these values.

◆ IsEmpty()

bool foxit::pdf::portfolio::PortfolioNode::IsEmpty ( ) const

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ operator !=()

bool foxit::pdf::portfolio::PortfolioNode::operator != ( const PortfolioNode other) const

Not equal operator.

Parameters
[in]otherAnother portfolio node object. This function will check if current object is not equal to this one.
Returns
true means not equal, while false means equal.

◆ operator=()

PortfolioNode& foxit::pdf::portfolio::PortfolioNode::operator= ( const PortfolioNode other)

Assign operator.

Parameters
[in]otherAnother portfolio node object, whose value would be assigned to current object.
Returns
Reference to current object itself.

◆ operator==()

bool foxit::pdf::portfolio::PortfolioNode::operator== ( const PortfolioNode other) const

Equal operator.

Parameters
[in]otherAnother portfolio node object. This function will check if current object is equal to this one.
Returns
true means equal, while false means not equal.