Crate kde_frameworks

Source
Expand description

§Introduction

This crate serves as the base for all the KDE Frameworks Crate written by me. It sets important environment variables and provides helpful methods required in most KDE Frameworks.

Currently, mostly supposed to be used as a build dependency.

§Install kf5-config

§Ubuntu

sudo apt install libkf5kdelibs4support5-bin

§Fedroa

sudo dnf install kf5-kdelibs4support

§Environment Variables Read By this Crate

  • It is optional to provide these variables. If these variables are not present, then kf5-config must be present in the path.
  1. KF_LIBRARY_PATH : Path for KDE Frameworks Library Location.
  2. KF_INCLUDE_PATH : Path for KDE Frameworks Header Files Location.
  3. KF_VERSION : KDE Frameworks Version. Format <major>.<minor>.<patch>.

§Environment Variables Set By this Crate

  1. KF_LIBRARY_PATH : Path for KDE Frameworks Library Location.
  2. KF_INCLUDE_PATH : Path for KDE Frameworks Header Files Location.
  3. KF_VERSION : KDE Frameworks Version Detected.
  4. KF_FOUND : Flag to specify if KDE Frameworks is found or not.

Modules§

helpers
Helper Functions.
kf5_config

Functions§

check_env_variables
Function to check if Version, Include Path and Library Path Environment variables have been set
check_kf5_config
Function to probe KDE using kf5-config tool.
get_lib_include_path
Function to Return the Include Path for the KDE Library. This is the path where the header files for the Library are located.
link_lib
Function to link a KDE Library. Eg: For linking KI18n:
set_version_cfg
Function to have Conditional Compilation based on KDE Frameworks version.