TYPE.rst 863 B

123456789101112131415161718192021222324
  1. TYPE
  2. ----
  3. Widget type for entry in GUIs.
  4. Cache entry values are always strings, but CMake GUIs present widgets
  5. to help users set values. The GUIs use this property as a hint to
  6. determine the widget type. Valid ``TYPE`` values are:
  7. .. table::
  8. :align: left
  9. ================= ========================================
  10. ``BOOL`` Boolean ON/OFF value.
  11. ``PATH`` Path to a directory.
  12. ``FILEPATH`` Path to a file.
  13. ``STRING`` Generic string value.
  14. ``INTERNAL`` Do not present in GUI at all.
  15. ``STATIC`` Value managed by CMake, do not change.
  16. ``UNINITIALIZED`` Type not yet specified.
  17. ================= ========================================
  18. Generally the ``TYPE`` of a cache entry should be set by the command which
  19. creates it (:command:`set`, :command:`option`, :command:`find_library`, etc.).