frameworks/kguiaddons/README.md

0001 # KDE GUI Addons
0002
0003 Utilities for graphical user interfaces
0004
0005 ## Introduction
0006
0007 The &KDE GUI addons provide utilities for graphical user interfaces in the areas
0008 of colors, fonts, text, images, keyboard input.
0009
0010 ## Usage
0011
0012 To use KGuiAddons, you'll want to look for it using
0013
0014 ```cmake
0015 find_package(KF5GuiAddons)
0016 ```
0017
0018 or its QMake counterpart.
0019
0020 ### Color utilities
0021
0022 The KColorUtils namespace contains various small utilities to work with colors. KColorCollection provides
0023 handling of color collections ("pallettes"). KColorMimeData adds drag-and-drop and clipboard mimedata
0024 manipulation to QColor objects
0025
0026 ### Text utilities
0027
0028 KWordWrap is a special word wrapping algorithm that takes beauty into account. It can be used
0029 directly with QPainter or can return the wrapped text in a QString.
0030
0031 KDateValidator is a QValidator that validates user-entered dates.
0032
0033 KFontUtils::adaptFontSize() is a function that calculates the biggest font size (in points)
0034 that can be used to draw a text centered in a rectangle using word wrapping.
0035
0036 ### Keyboard utilities
0037
0038 KeySequenceRecorder is a utility that records a QKeySequence by listening to key events in a window.
0039 This can be used to let the user modify predefined keyboard shortcuts for example.
0040
0041 ### Icon utilities
0042
0043 KIconUtils contains functions to add overlays on top of a QIcon.
0044
0045 ### Cursor utilities
0046
0047 KCursorSaver is used to temporarily set a mouse cursor and restore the previous one on destruction.
0048