File: TYPE.rst

package info (click to toggle)
cmake 4.2.1-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 152,348 kB
  • sloc: ansic: 403,894; cpp: 303,807; sh: 4,097; python: 3,582; yacc: 3,106; lex: 1,279; f90: 538; asm: 471; lisp: 375; cs: 270; java: 266; fortran: 239; objc: 215; perl: 213; xml: 198; makefile: 108; javascript: 83; pascal: 63; tcl: 55; php: 25; ruby: 22
file content (24 lines) | stat: -rw-r--r-- 863 bytes parent folder | download | duplicates (2) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
TYPE
----

Widget type for entry in GUIs.

Cache entry values are always strings, but CMake GUIs present widgets
to help users set values.  The GUIs use this property as a hint to
determine the widget type.  Valid ``TYPE`` values are:

.. table::
  :align: left

  =================  ========================================
  ``BOOL``           Boolean ON/OFF value.
  ``PATH``           Path to a directory.
  ``FILEPATH``       Path to a file.
  ``STRING``         Generic string value.
  ``INTERNAL``       Do not present in GUI at all.
  ``STATIC``         Value managed by CMake, do not change.
  ``UNINITIALIZED``  Type not yet specified.
  =================  ========================================

Generally the ``TYPE`` of a cache entry should be set by the command which
creates it (:command:`set`, :command:`option`, :command:`find_library`, etc.).