Source/cmQTWrapUICommand.h

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