Struct GeneralDocumentInfo

• Defined in File libCZI_Metadata.h

Struct Documentation

struct GeneralDocumentInfo

General document information - corresponding to Information/Document.

Public Functions

inline GeneralDocumentInfo()

Default constructor - all fields are intially marked “invalid”.

inline void SetName(const wchar_t *sz)

Sets the name and marks it valid if the specified string is non-null and non-empty. Otherwise, the name is set to invalid.

Parameters:

sz – The string to set as name.

inline void SetName(const std::wstring &str)

Sets the name and marks it valid if the specified string is non-empty. Otherwise, the name is set to invalid.

Parameters:

str – The string to set as name.

inline void SetTitle(const wchar_t *sz)

Sets the title and marks it valid if the specified string is non-null and non-empty. Otherwise, the title is set to invalid.

Parameters:

sz – The string to set as title.

inline void SetTitle(const std::wstring &str)

Sets the title and marks it valid if the specified string is non-empty. Otherwise, the title is set to invalid.

Parameters:

str – The string to set as title.

inline void SetUserName(const wchar_t *sz)

Sets the username and marks it valid if the specified string is non-null and non-empty. Otherwise, the username is set to invalid.

Parameters:

sz – The string to set as username.

inline void SetUserName(const std::wstring &str)

Sets the username and marks it valid if the specified string is non-empty. Otherwise, the username is set to invalid.

Parameters:

str – The string to set as username.

inline void SetDescription(const wchar_t *sz)

Sets the description and marks it valid if the specified string is non-null and non-empty. Otherwise, the description is set to invalid.

Parameters:

sz – The string to set as description.

inline void SetDescription(const std::wstring &str)

Sets the description and marks it valid if the specified string is non-empty. Otherwise, the description is set to invalid.

Parameters:

str – The string to set as description.

inline void SetComment(const wchar_t *sz)

Sets the comment and marks it valid if the specified string is non-null and non-empty. Otherwise, the comment is set to invalid.

Parameters:

sz – The string to set as comment.

inline void SetComment(const std::wstring &str)

Sets the comment and marks it valid if the specified string is non-empty. Otherwise, the comment is set to invalid.

Parameters:

str – The string to set as comment.

inline void SetKeywords(const wchar_t *sz)

Sets the keywords and marks it valid if the specified string is non-null and non-empty. Otherwise, the keywords is set to invalid.

Parameters:

sz – The string to set as keywords.

inline void SetKeywords(const std::wstring &str)

Sets the keywords and marks it valid if the specified string is non-empty. Otherwise, the keywords is set to invalid.

Parameters:

str – The string to set as keywords.

inline void SetRating(int rating)

Sets the rating and marks it as valid if the specified rating is non-negative. Otherwise, the rating is set to invalid.

Parameters:

rating – The rating.

inline void SetCreationDate(const wchar_t *sz)

Sets the creationDateTime and marks it valid if the specified string is non-null and non-empty. Otherwise, the creationDateTime is set to invalid.

Parameters:

sz – The string to set as creationDateTime.

inline void SetCreationDate(const std::wstring &str)

Sets the creationDateTime and marks it valid if the specified string is non-empty. Otherwise, the creationDateTime is set to invalid.

Parameters:

str – The string to set as creationDateTime.

inline void SetCreationDate(const XmlDateTime *dateTime)

Sets the creationDateTime and marks it valid if the specified XmlDateTime-struct pointer is non-null and valid. Otherwise, the creationDateTime is set to invalid.

Parameters:

dateTime – The XmlDateTime-struct to set as creationDateTime.

inline void Clear()

Sets all fields to “invalid”.

Public Members

bool name_valid

Whether the field name is valid.

std::wstring name

Name of the document.

bool title_valid

Whether the field title is valid.

std::wstring title

Title of the document.

bool userName_valid

Whether the field userName is valid.

std::wstring userName

Name of the user who created the document.

bool description_valid

Whether the field description is valid.

std::wstring description

A text describing the document.

bool comment_valid

Whether the field comment is valid.

std::wstring comment

A text with comments on the document.

bool keywords_valid

Whether the field keywords is valid.

std::wstring keywords

List of keywords (should be separated by semicolons)

bool rating_valid

Whether the field rating is valid.

int rating

An integer specifying a “five-star-rating” (should be between 0 and 5).

bool creationDateTime_valid

Whether the field creationDateTime is valid.

std::wstring creationDateTime

The creation date of the document (formatted as xml-datatype “dateTime”).