IDPath Class Reference

#include <IDPath.h>

Inheritance diagram for IDPath:

Public Types
typedef APath	inherited
typedef object_type	data_type

Public Member Functions
	IDPath ()
	IDPath (const APathComponent &component)
	IDPath (const AString &pathStr, PathType typeHint=kDefaultOSPath)
	IDPath (const WideString &pathStr, PathType typeHint=kDefaultOSPath)
	IDPath (const IDPath &path)
	IDPath (const APath &path)
virtual	~IDPath ()
IDPath &	operator= (const IDPath &rhs)
	IDPath (IDPath &&rhs) noexcept
IDPath &	operator= (IDPath &&rhs) noexcept
IDPath &	operator= (const APath &rhs)
bool	operator== (const IDPath &rhs) const
bool	operator!= (const IDPath &rhs) const
IDPath &	operator+= (const IDPath &rhs)
IDPath &	operator+= (const APathComponent &rhs)
bool	SetPath (const WideString &pathStr, PathType typeHint=kDefaultOSPath)
IDPath &	Append (const IDPath &path)
IDPath &	Append (const APathComponent &component)

Friends
void	swap (IDPath &lhs, IDPath &rhs) noexcept

Detailed Description

InDesign class used to manipulate a file or directory specified by a path.

See Also

AFile

Constructor & Destructor Documentation

IDPath::IDPath

(

)

Default constructor. Constructs an empty APath object.

IDPath::IDPath

(

const APathComponent &

component

)

Constructor. Constructs an APath containing one path component.

Parameters

component

IN Component in the path. An empty path component is ignored.

IDPath::IDPath	(	const AString &	pathStr,
		PathType	typeHint = kDefaultOSPath
	)

Constructor. Constructs an APath object from the given path string.\ Call !IsEmpty() after construction to determine if the path was successfully set from the given string.

Parameters

pathStr	IN String containing the path.
typeHint	IN Type of path contained in the string. The hint is only used to optimize the parsing of the path, not to specify the actual path type. Default {kDefaultOSPath}.

IDPath::IDPath	(	const WideString &	pathStr,
		PathType	typeHint = kDefaultOSPath
	)

Constructor. Constructs an APath object from the given path string.\ Call !IsEmpty() after construction to determine if the path was successfully set from the given string.

Parameters

pathStr	IN String containing the path.
typeHint	IN Type of path contained in the string. The hint is only used to optimize the parsing of the path, not to specify the actual path type. Default {kDefaultOSPath}.

IDPath::IDPath

(

const IDPath &

path

)

Copy constructor. Constructs an IDPath object that is a copy of the given path.

Parameters

path	IN Path to copy.

IDPath::IDPath

(

const APath &

path

)

Copy constructor. Constructs an IDPath object that is a copy of the given path.

Parameters

path	IN Path to copy.

virtual IDPath::~IDPath ( )

virtual

Destructor. Destroys the IDPath object.

Member Function Documentation

IDPath& IDPath::Append

(

const IDPath &

path

)

Appends the given path to this path.

Parameters

path	IN Path to append to the end of this path.

Returns

Reference to the path.

IDPath& IDPath::Append

(

const APathComponent &

component

)

Appends the given path component to this path.

Parameters

path	IN Path component to append to the end of this path.

Returns

Reference to the path.

bool IDPath::operator!=

(

const IDPath &

rhs

)

const

Non-equality operator. Test whether this path is not equal to the given path.

Parameters

rhs	IN Path to test for non-equality against this path.

Returns

True if this path is not equal to the given path, else false.

IDPath& IDPath::operator+=

(

const IDPath &

rhs

)

Addition operator. Appends the given path to the end of this path.

Parameters

rhs	IN Path to append to this path.

Returns

Reference to this path.

IDPath& IDPath::operator+=

(

const APathComponent &

rhs

)

Addition operator. Appends the given path component to the end of this path.

Parameters

rhs	IN Path component to append to this path.

Returns

Reference to this path.

IDPath& IDPath::operator=

(

const IDPath &

rhs

)

Assignment operator. Assigns the given path to this path.

Parameters

rhs	IN Path to assign to this path.

Returns

Reference to the path.

IDPath& IDPath::operator=

(

const APath &

rhs

)

Assignment operator. Assigns the given path to this path.

Parameters

rhs	IN Path to assign to this path.

Returns

Reference to the path.

bool IDPath::operator==

(

const IDPath &

rhs

)

const

Equality operator. Test whether this path is equal to the given path.

Parameters

rhs	IN Path to test for equality against this path.

Returns

True if this path is equal to the given path, else false.

bool IDPath::SetPath	(	const WideString &	pathStr,
		PathType	typeHint = kDefaultOSPath
	)

Sets the path from the given path string.

Parameters

pathStr	IN String containing the path.
typeHint	IN Type of path contained in the string. The hint is only used to optimize the parsing of the path, not to specify the actual path type. Default {kDefaultOSPath}.

Returns

True if the path was set, else false.

Friends And Related Function Documentation

void swap ( IDPath &  lhs, IDPath &  rhs  )

friend

Swap function. Swaps this object with the passed in object.

Parameters

rhs	IN Path to swap with this path.