Source/cmQTWrapUICommand.h

   1 /*============================================================================
   2   CMake - Cross Platform Makefile Generator
   3   Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
   4
   5   Distributed under the OSI-approved BSD License (the "License");
   6   see accompanying file Copyright.txt for details.
   7
   8   This software is distributed WITHOUT ANY WARRANTY; without even the
   9   implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10   See the License for more information.
  11 ============================================================================*/
  12 #ifndef cmQTWrapUICommand_h
  13 #define cmQTWrapUICommand_h
  14
  15 #include "cmCommand.h"
  16
  17 #include "cmSourceFile.h"
  18
  19 /** \class cmQTWrapUICommand
  20  * \brief Create .h and .cxx files rules for Qt user interfaces files
  21  *
  22  * cmQTWrapUICommand is used to create wrappers for Qt classes into normal C++
  23  */
  24 class cmQTWrapUICommand : public cmCommand
  25 {
  26 public:
  27   cmTypeMacro(cmQTWrapUICommand, cmCommand);
  28   /**
  29    * This is a virtual constructor for the command.
  30    */
  31   virtual cmCommand* Clone()
  32     {
  33     return new cmQTWrapUICommand;
  34     }
  35
  36   /**
  37    * This is called when the command is first encountered in
  38    * the CMakeLists.txt file.
  39    */
  40   virtual bool InitialPass(std::vector<std::string> const& args,
  41                            cmExecutionStatus &status);
  42
  43   /**
  44    * The name of the command as specified in CMakeList.txt.
  45    */
  46   virtual const char* GetName() const { return "qt_wrap_ui";}
  47
  48   /**
  49    * Succinct documentation.
  50    */
  51   virtual const char* GetTerseDocumentation() const
  52     {
  53     return "Create Qt user interfaces Wrappers.";
  54     }
  55
  56   /**
  57    * More documentation.
  58    */
  59   virtual const char* GetFullDocumentation() const
  60     {
  61     return
  62       "  qt_wrap_ui(resultingLibraryName HeadersDestName\n"
  63       "             SourcesDestName SourceLists ...)\n"
  64       "Produce .h and .cxx files for all the .ui files listed "
  65       "in the SourceLists.  "
  66       "The .h files will be added to the library using the HeadersDestName"
  67       "source list.  "
  68       "The .cxx files will be added to the library using the SourcesDestName"
  69       "source list.";
  70     }
  71 };
  72
  73
  74
  75 #endif