NaturalDocs:: Project:: File

A simple information class about project files.

Summary

NaturalDocs:: Project:: File	A simple information class about project files.
Implementation
Members	The class is implemented as a blessed arrayref.
Functions
New	Creates and returns a new file object.
HasContent	Returns whether the file contains Natural Docs content or not.
LastModified	Returns the integer timestamp of when the file was last modified.
Status	Returns the status of the file since the last build.
DefaultMenuTitle	Returns the file’s default title on the menu.
SetHasContent	Sets whether the file contains Natural Docs content or not.
SetLastModified	Sets the file’s last modification timestamp.
SetStatus	Sets the file’s status since the last build.
SetDefaultMenuTitle	Sets the file’s default title on the menu.

The class is implemented as a blessed arrayref. The following constants are used as indexes.

HAS_CONTENT	Whether the file contains Natural Docs content or not.
LAST_MODIFIED	The integer timestamp of when the file was last modified.
STATUS	Status since the last build. One of the File Status Constants.
DEFAULT_MENU_TITLE	The file’s default title in the menu.

sub New #(hasContent, lastModified, status, defaultMenuTitle)

Creates and returns a new file object.

hasContent	Whether the file contains Natural Docs content or not.
lastModified	The integer timestamp of when the file was last modified.
status	The file’s status since the last build. One of the File Status Constants.
defaultMenuTitle	The file’s title in the menu.

A reference to the new object.

sub HasContent

Returns whether the file contains Natural Docs content or not.

sub LastModified

Returns the integer timestamp of when the file was last modified.

sub Status

Returns the status of the file since the last build. Will be one of the File Status Constants.

sub DefaultMenuTitle

Returns the file’s default title on the menu.

sub SetHasContent #(hasContent)

Sets whether the file contains Natural Docs content or not.

sub SetLastModified #(lastModified)

Sets the file’s last modification timestamp.

sub SetStatus #(status)

Sets the file’s status since the last build.

sub SetDefaultMenuTitle #(menuTitle)

Sets the file’s default title on the menu.