Salome HOME
Allow setting / getting QByteArray preference item in Python modules.
[modules/gui.git] / adm_local / cmake_files / FindSalomeGUI.cmake
index 59a621a8841590d9023306af0457a322b7310615..66d5b9f543987a764503469c8d1c69cc93e62152 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (C) 2007-2015  CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -65,12 +65,20 @@ ENDMACRO(SALOME_GUI_WITH_CORBA)
 #   _options [input] List - The list of CMake options given to SALOME GUI
 #
 # Notes:
-# The arguments list can include "OPTIONAL" keywords:
-#  * All arguments preceded by "OPTIONAL" keyword are mandatory for current module.
-#    If GUI module was compiled without this functionality, further installation 
-#    of the current module becomes impossible.
-#  * All arguments following "OPTIONAL" keyword are optional for current module, which
-#    uses this functionality, but can be installed without it.
+# - The arguments list can include "OPTIONAL" keywords:
+#   * All arguments preceded by "OPTIONAL" keyword are mandatory for current module.
+#     If GUI module was compiled without this functionality, further installation 
+#     of the current module becomes impossible.
+#   * All arguments following "OPTIONAL" keyword are optional for current module, which
+#     uses this functionality, but can be installed without it.
+#
+# - At present there are next options in the GUI module:
+#   SALOME_USE_OCCVIEWER, SALOME_USE_VTKVIEWER, SALOME_USE_GLVIEWER, SALOME_USE_PLOT2DVIEWER,
+#   SALOME_USE_GRAPHICSVIEW, SALOME_USE_QXGRAPHVIEWER, SALOME_USE_PVVIEWER, SALOME_USE_PYVIEWER,
+#   SALOME_USE_PYCONSOLE, SALOME_USE_SALOMEOBJECT
+#
+# Example of usage:
+#   SALOME_GUI_MODE(SALOME_USE_OCCVIEWER SALOME_USE_SALOMEOBJECT OPTIONAL SALOME_USE_PYCONSOLE)
 #
 MACRO(SALOME_GUI_MODE)
   MESSAGE(STATUS "")