##################
cmake.utils/option
##################

.. module:: cmake.utils/option


.. function:: __define_socmake_option(NAME TYPE DESCRIPTION DEFAULT ADVANCED **kwargs)

   


.. function:: option_enum(VARIABLE DESCRIPTION ENUM_VALUES DEFAULT **kwargs)

   Create a CMake integer option that can be modified through CLI.
   Option defined this way will be visible in `cmake-gui` interface as well as SoCMake `help_options()` help menu.
   To override the variable use `cmake -D<VARIABLE>=<VALUE>`
   
   :param VARIABLE: name of the variable.
   :type VARIABLE: string
   :param DESCRIPTION: short description string for the variable
   :type DESCRIPTION: string
   :param ENUM_VALUES: possible values variable can have 
   :type ENUM_VALUES: list[string]
   :param DEFAULT: default value of the variable
   :type DEFAULT: integer 
   :param ADVANCED: optional, mark options as advanced, it will not show in help menu
   :type DEFAULT: boolean
   


.. function:: option_string(VARIABLE DESCRIPTION DEFAULT **kwargs)

   Create a CMake integer option that can be modified through CLI.
   Option defined this way will be visible in `cmake-gui` interface as well as SoCMake `help_options()` help menu.
   To override the variable use `cmake -D<VARIABLE>=<VALUE>`
   
   :param VARIABLE: name of the variable.
   :type VARIABLE: string
   :param DESCRIPTION: short description string for the variable
   :type DESCRIPTION: string
   :param DEFAULT: default value of the variable
   :type DEFAULT: string 
   :param ADVANCED: optional, mark options as advanced, it will not show in help menu
   :type DEFAULT: boolean
   


.. function:: option_integer(VARIABLE DESCRIPTION DEFAULT **kwargs)

   Create a CMake integer option that can be modified through CLI.
   Option defined this way will be visible in `cmake-gui` interface as well as SoCMake `help_options()` help menu.
   To override the variable use `cmake -D<VARIABLE>=<VALUE>`
   
   :param VARIABLE: name of the variable.
   :type VARIABLE: string
   :param DESCRIPTION: short description string for the variable
   :type DESCRIPTION: string
   :param DEFAULT: default value of the variable
   :type DEFAULT: integer 
   :param ADVANCED: optional, mark options as advanced, it will not show in help menu
   :type DEFAULT: boolean
   


.. function:: option_boolean(VARIABLE DESCRIPTION DEFAULT **kwargs)

   Create a CMake boolean option that can be modified through CLI.
   Option defined this way will be visible in `cmake-gui` interface as well as SoCMake `help_options()` help menu.
   To override the variable use `cmake -D<VARIABLE>=<VALUE>`
   
   :param VARIABLE: name of the variable.
   :type VARIABLE: string
   :param DESCRIPTION: short description string for the variable
   :type DESCRIPTION: string
   :param DEFAULT: default value of the variable
   :type DEFAULT: boolean 
   :param ADVANCED: optional, mark options as advanced, it will not show in help menu
   :type DEFAULT: boolean
   


.. data:: ${VARIABLE}


   .. note:: 

      
      This variable is a user-editable option,
      meaning it appears within the cache and can be
      edited on the command line by the :code:`-D` flag.
      

   

   :Help text: ${DESCRIPTION}

   :Default value: ${DEFAULT}

   :type: bool