CMake/Source/cmMessageCommand.h

72 lines
1.8 KiB
C
Raw Normal View History

2001-06-05 00:55:11 +04:00
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
2002-01-21 23:30:43 +03:00
Copyright (c) 2002 Insight Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
2001-06-05 00:55:11 +04:00
2002-01-21 23:30:43 +03:00
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
2001-06-05 00:55:11 +04:00
=========================================================================*/
#ifndef cmMessageCommand_h
#define cmMessageCommand_h
#include "cmStandardIncludes.h"
#include "cmCommand.h"
/** \class cmMessageCommand
* \brief Displays a message to the user
*
*/
class cmMessageCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmMessageCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args);
2001-06-05 00:55:11 +04:00
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "MESSAGE";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Display a message to the user.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
"MESSAGE(\"the message to display\" \"Title for dialog\")\n"
"The first argument is the message to display. The second argument is optional and is the title for the dialog box on windows.";
}
cmTypeMacro(cmMessageCommand, cmCommand);
};
#endif