Home · Overviews · Reference · Classes

Project Class Reference

The Project class represents a single project. More...

    #include <Project>

Inherits QMakeObject.

• List of all members, including inherited members

Public Types

• enum LoadMode { ProjectMode, FileMode }

Public Functions

• QString buildDir () const
• QString disabledReason () const
• bool do_if ( const QByteArray & data, const QString & filename, bool & rv )
• SolutionFile file () const
• bool includeFile ( const SolutionFile & fileName )
• bool isActiveConfig ( const QString & option ) const
• QString name () const
• QString nodePath () const
• void reset ( const QString & reason, const QString & value = QString() )
• QMakeObject * resetReason ()
• bool run ( const QByteArray & data, const QString & filename )
• void setDisabled ( const QString & reason )
• QStringList value ( const QString & property ) const

• 16 public functions inherited from QMakeObject

Static Public Members

• void addMkspecPath ( const QString & path )
• QStringList mkspecPaths ()

• 1 static public member inherited from QMakeObject

Detailed Description

The Project class represents a single project.

Following finalization, all methods are thread safe (the object has become read-only)

See also qbuild.pro.

Member Type Documentation

enum Project::LoadMode

Member Function Documentation

void Project::addMkspecPath ( const QString & path )   [static]

Add path to the list of paths in which QBuild looks for mkspecs.

QString Project::buildDir () const

Returns the path of this project as a generated filesystem path.

This is equivalent to solution()->findFile(nodePath(), Solution::Generated).fsPath().

QString Project::disabledReason () const

Returns a string with the reason that the project was disabled.

bool Project::do_if ( const QByteArray & data, const QString & filename, bool & rv )

Parse and run data as a scope using filename to report parsing errors. The return value of the scope is set in rv. Returns true if everything was parsed correctly, false otherwise.

SolutionFile Project::file () const

Returns a solution file that represents the project.

bool Project::includeFile ( const SolutionFile & fileName )

Include the file represented by fileName. Returns true if the file could be parsed, else false.

bool Project::isActiveConfig ( const QString & option ) const

Returns true if option is contained in the CONFIG variable.

QStringList Project::mkspecPaths ()   [static]

Returns the list of paths in which QBuild looks for mkspecs.

QString Project::name () const

Returns the name of the project.

QString Project::nodePath () const

Returns the path of the project.

void Project::reset ( const QString & reason, const QString & value = QString() )

Reset the project because of reason. Note that a project can only be reset once per reason. The value is stored and can be retrieved from the property reason in the object returned by Project::resetReason().

QMakeObject * Project::resetReason ()

Returns the reasons that have caused the project to be reset.

See also reset().

bool Project::run ( const QByteArray & data, const QString & filename )

Parse and run data using filename to report parsing errors. Returns true if the data could be parsed, false otherwise.

void Project::setDisabled ( const QString & reason )

Disable the project and report the reason.

QStringList Project::value ( const QString & property ) const

Returns the value of the object specified by property.