NaturalDocs::Project::SourceFile

A simple information class about project files.

Summary

NaturalDocs::Project::SourceFile	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.
SetHasContent	Sets whether the file contains Natural Docs content or not.
LastModified	Returns the integer timestamp of when the file was last modified.
SetLastModified	Sets the file’s last modification timestamp.
Status	Returns the FileStatus since the last build.
SetStatus	Sets the FileStatus since the last build.
DefaultMenuTitle	Returns the file’s default title on the menu.
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	FileStatus since the last build.
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 FileStatus since the last build.
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 SetHasContent #( hasContent )

Sets whether the file contains Natural Docs content or not.

sub LastModified

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

sub SetLastModified #( lastModified )

Sets the file’s last modification timestamp.

sub Status

Returns the FileStatus since the last build.

sub SetStatus #( status )

Sets the FileStatus since the last build.

sub DefaultMenuTitle

Returns the file’s default title on the menu.

sub SetDefaultMenuTitle #( menuTitle )

Sets the file’s default title on the menu.