mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-25 00:58:06 -05:00
d0b5a01729
QgsNumericFormat subclasses provide a means to format a numeric value as a string, applying various formatting options. E.g. a default string to value formatter (included here) includes settings for controlling the number of decimal places, whether a thousands separator should be shown, whether a leading + sign should be shown, whether trailing zeros should be shown. This PR also includes a formatter for bearings, allowing various formats of numeric bearings to be applied (e.g. control over decimal places, etc + control over whether direction E/W suffixes are shown, or whether values should be limited to either the +/- 180 range or 0-360 degree range) When formatting values, a QgsNumericFormatContext class is used to provide context. Currently, this includes the thousands and decimal separators to apply when formatting (which are taken by default from the user's locale). A registry of formatters is included to allow easy addition of other formats in future (e.g. currencies, percentages, scientific notation, etc...) and to allow plugin based formats. The intention is to follow this up with gui configuration widgets for the formats, and then expose them in various places through the qgis ui (e.g. in the range editor widget for fields, in scalebar numbers, as an option for formatting numeric labels, etc)
184 lines
6.6 KiB
CMake
184 lines
6.6 KiB
CMake
# include doxygen documentation
|
|
SET (WITH_APIDOC FALSE CACHE BOOL "Determines whether the QGIS API doxygen documentation should be built")
|
|
|
|
# include doxygen documentation
|
|
SET (WITH_TXT2TAGS_PDF FALSE CACHE BOOL "Determines whether PDF should be generate for the txt2tags documentation")
|
|
|
|
# include Qt documentation
|
|
SET (QT_DOC_URL "https://doc.qt.io/qt-5/" CACHE STRING "URL for Qt docs")
|
|
|
|
INCLUDE(Txt2Tags)
|
|
FIND_TXT2TAGS()
|
|
|
|
IF(TXT2TAGS_EXECUTABLE)
|
|
ADD_TXT2TAGS_FILES(QGIS_DOC_FILES INSTALL.t2t NEWS.t2t)
|
|
IF(WITH_TXT2TAGS_PDF)
|
|
ADD_TXT2TAGS_PDFS(QGIS_DOC_FILES INSTALL.t2t NEWS.t2t)
|
|
ENDIF(WITH_TXT2TAGS_PDF)
|
|
FILE(GLOB t2tfiles doc/*.t2t)
|
|
ADD_CUSTOM_TARGET (t2tdoc ALL DEPENDS ${QGIS_DOC_FILES} ${t2tfiles})
|
|
ELSE(TXT2TAGS_EXECUTABLE)
|
|
SET(QGIS_DOC_FILES
|
|
../INSTALL
|
|
../NEWS
|
|
INSTALL.html
|
|
NEWS.html
|
|
)
|
|
ENDIF(TXT2TAGS_EXECUTABLE)
|
|
|
|
SET(QGIS_DOC_FILES
|
|
${QGIS_DOC_FILES}
|
|
index.html
|
|
developersmap.html
|
|
nohelp.html
|
|
favicon.ico
|
|
style.css
|
|
AUTHORS
|
|
CONTRIBUTORS
|
|
SPONSORS
|
|
DONORS
|
|
TRANSLATORS
|
|
LICENSE
|
|
)
|
|
|
|
INSTALL(FILES ${QGIS_DOC_FILES} DESTINATION ${QGIS_DATA_DIR}/doc)
|
|
INSTALL(FILES ../images/icons/qgis-icon-60x60.png DESTINATION ${QGIS_DATA_DIR}/doc/images)
|
|
|
|
# Sponsor images
|
|
FILE (GLOB SPONSOR_IMAGES images/projects/thumbnails/* )
|
|
INSTALL (FILES ${SPONSOR_IMAGES} DESTINATION ${QGIS_DATA_DIR}/doc/images/projects/thumbnails/)
|
|
|
|
IF(WITH_APIDOC)
|
|
FIND_PACKAGE(Doxygen 1.8.2 REQUIRED)
|
|
IF(DOXYGEN_FOUND)
|
|
SET(QHP_FILES ${CMAKE_CURRENT_BINARY_DIR}/api/html/index.qhp)
|
|
|
|
# Whether to generate QHP file
|
|
SET (GENERATE_QHP FALSE CACHE BOOL "Determines whether to generate Qt QHP help from the QGIS API Docs")
|
|
IF (GENERATE_QHP)
|
|
SET(WITH_QHP YES)
|
|
SET(QHP_FILES ${QHP_FILES} ${CMAKE_CURRENT_BINARY_DIR}/api/qch/qgis.qch)
|
|
ELSE(GENERATE_QHP)
|
|
SET(WITH_QHP NO)
|
|
ENDIF(GENERATE_QHP)
|
|
|
|
SET(DOXYGEN_INCLUDE_PATH
|
|
${CMAKE_SOURCE_DIR}/src/core
|
|
)
|
|
STRING(REPLACE ";" " " DOXYGEN_INCLUDE_PATH "${DOXYGEN_INCLUDE_PATH}")
|
|
|
|
SET(DOXYGEN_INPUT
|
|
${CMAKE_SOURCE_DIR}/doc
|
|
${CMAKE_SOURCE_DIR}/src/core
|
|
${CMAKE_SOURCE_DIR}/src/core/3d
|
|
${CMAKE_SOURCE_DIR}/src/core/annotations
|
|
${CMAKE_SOURCE_DIR}/src/core/auth
|
|
${CMAKE_SOURCE_DIR}/src/core/callouts
|
|
${CMAKE_SOURCE_DIR}/src/core/classification
|
|
${CMAKE_SOURCE_DIR}/src/core/diagram
|
|
${CMAKE_SOURCE_DIR}/src/core/dxf
|
|
${CMAKE_SOURCE_DIR}/src/core/effects
|
|
${CMAKE_SOURCE_DIR}/src/core/expression
|
|
${CMAKE_SOURCE_DIR}/src/core/fieldformatter
|
|
${CMAKE_SOURCE_DIR}/src/core/geometry
|
|
${CMAKE_SOURCE_DIR}/src/core/geocms
|
|
${CMAKE_SOURCE_DIR}/src/core/geocms/geonode
|
|
${CMAKE_SOURCE_DIR}/src/core/gps
|
|
${CMAKE_SOURCE_DIR}/src/core/labeling
|
|
${CMAKE_SOURCE_DIR}/src/core/layertree
|
|
${CMAKE_SOURCE_DIR}/src/core/layout
|
|
${CMAKE_SOURCE_DIR}/src/core/locator
|
|
${CMAKE_SOURCE_DIR}/src/core/metadata
|
|
${CMAKE_SOURCE_DIR}/src/core/mesh
|
|
${CMAKE_SOURCE_DIR}/src/core/numericformats
|
|
${CMAKE_SOURCE_DIR}/src/core/pal
|
|
${CMAKE_SOURCE_DIR}/src/core/processing
|
|
${CMAKE_SOURCE_DIR}/src/core/providers
|
|
${CMAKE_SOURCE_DIR}/src/core/providers/memory
|
|
${CMAKE_SOURCE_DIR}/src/core/raster
|
|
${CMAKE_SOURCE_DIR}/src/core/scalebar
|
|
${CMAKE_SOURCE_DIR}/src/core/symbology
|
|
${CMAKE_SOURCE_DIR}/src/core/validity
|
|
${CMAKE_SOURCE_DIR}/src/gui
|
|
${CMAKE_SOURCE_DIR}/src/gui/auth
|
|
${CMAKE_SOURCE_DIR}/src/gui/attributetable
|
|
${CMAKE_SOURCE_DIR}/src/gui/callouts
|
|
${CMAKE_SOURCE_DIR}/src/gui/editorwidgets
|
|
${CMAKE_SOURCE_DIR}/src/gui/editorwidgets/core
|
|
${CMAKE_SOURCE_DIR}/src/gui/effects
|
|
${CMAKE_SOURCE_DIR}/src/gui/labeling
|
|
${CMAKE_SOURCE_DIR}/src/gui/layertree
|
|
${CMAKE_SOURCE_DIR}/src/gui/layout
|
|
${CMAKE_SOURCE_DIR}/src/gui/locator
|
|
${CMAKE_SOURCE_DIR}/src/gui/ogr
|
|
${CMAKE_SOURCE_DIR}/src/gui/processing
|
|
${CMAKE_SOURCE_DIR}/src/gui/raster
|
|
${CMAKE_SOURCE_DIR}/src/gui/symbology
|
|
${CMAKE_SOURCE_DIR}/src/analysis
|
|
${CMAKE_SOURCE_DIR}/src/analysis/mesh
|
|
${CMAKE_SOURCE_DIR}/src/analysis/interpolation
|
|
${CMAKE_SOURCE_DIR}/src/analysis/network
|
|
${CMAKE_SOURCE_DIR}/src/analysis/processing
|
|
${CMAKE_SOURCE_DIR}/src/analysis/raster
|
|
${CMAKE_SOURCE_DIR}/src/analysis/vector
|
|
${CMAKE_SOURCE_DIR}/src/analysis/vector/geometry_checker
|
|
${CMAKE_SOURCE_DIR}/src/3d
|
|
${CMAKE_SOURCE_DIR}/src/3d/chunks
|
|
${CMAKE_SOURCE_DIR}/src/3d/symbols
|
|
${CMAKE_SOURCE_DIR}/src/3d/terrain
|
|
${CMAKE_SOURCE_DIR}/src/plugins
|
|
${CMAKE_SOURCE_DIR}/src/quickgui
|
|
${CMAKE_SOURCE_DIR}/src/quickgui/plugin
|
|
)
|
|
|
|
IF(WITH_SERVER)
|
|
SET(DOXYGEN_INPUT
|
|
${DOXYGEN_INPUT}
|
|
${CMAKE_SOURCE_DIR}/src/server/
|
|
${CMAKE_SOURCE_DIR}/src/server/services/
|
|
${CMAKE_SOURCE_DIR}/src/server/services/wms
|
|
${CMAKE_SOURCE_DIR}/src/server/services/wfs
|
|
${CMAKE_SOURCE_DIR}/src/server/services/wcs
|
|
)
|
|
ENDIF(WITH_SERVER)
|
|
|
|
SET(DOXYGEN_FILE_PATTERNS *.h *.cpp *.dox)
|
|
|
|
SET(DOXYGEN_FILES)
|
|
FOREACH(_dir ${DOXYGEN_INPUT})
|
|
FOREACH(_pattern ${DOXYGEN_FILE_PATTERNS})
|
|
FILE(GLOB_RECURSE _files ${_dir}/${_pattern})
|
|
LIST(APPEND DOXYGEN_FILES ${_files})
|
|
ENDFOREACH(_pattern)
|
|
ENDFOREACH(_dir)
|
|
|
|
STRING(REPLACE ";" " " DOXYGEN_INPUT "${DOXYGEN_INPUT}")
|
|
|
|
CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/cmake_templates/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
|
|
|
|
SET (DOXYGEN_ON_DEMAND FALSE CACHE BOOL "Determines whether the QGIS API doxygen documentation should be build on demand only")
|
|
|
|
IF(DOXYGEN_ON_DEMAND)
|
|
ADD_CUSTOM_TARGET(apidoc DEPENDS ${QHP_FILES})
|
|
INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/api/html/ DESTINATION ${QGIS_DATA_DIR}/doc/api OPTIONAL)
|
|
ELSE(DOXYGEN_ON_DEMAND)
|
|
INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/api/html/ DESTINATION ${QGIS_DATA_DIR}/doc/api)
|
|
ADD_CUSTOM_TARGET(apidoc ALL DEPENDS ${QHP_FILES})
|
|
ENDIF(DOXYGEN_ON_DEMAND)
|
|
ADD_CUSTOM_COMMAND(
|
|
OUTPUT ${QHP_FILES}
|
|
DEPENDS ${DOXYGEN_FILES}
|
|
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
COMMENT "Generating API documentation" VERBATIM)
|
|
INSTALL(FILES ../images/icons/qgis-icon-60x60.png DESTINATION ${QGIS_DATA_DIR}/doc/api)
|
|
IF(GENERATE_QHP)
|
|
INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/api/qch/qgis.qch DESTINATION ${QGIS_DATA_DIR}/doc/api)
|
|
ENDIF(GENERATE_QHP)
|
|
ELSE(DOXYGEN_FOUND)
|
|
MESSAGE(STATUS "QGIS api documentation not built - Doxygen not found")
|
|
ENDIF(DOXYGEN_FOUND)
|
|
ENDIF(WITH_APIDOC)
|
|
|
|
#SUBDIRS (images plugins install_guide)
|