libraries/kirigami-addons/Mainpage.dox

0001 /*
0002  *  This file is part of Kirigami Addons
0003  *  SPDX-FileCopyrightText: 2023 Thiago Masato Costa Sueto <thiago.sueto@kde.org>
0004  *
0005  *  SPDX-License-Identifier: LGPL-2.0-or-later
0006  */
0007
0008 /** @mainpage Kirigami Addons
0009
0010 @section Introduction
0011
0012 Kirigami Addons is an additional set of visual components that work well on mobile and desktop and are guaranteed to be cross-platform. It uses Kirigami under the hood to create its components and should look native with any QtQuick Controls style.
0013
0014 A tutorial for Kirigami Addons can be found over <a href="https://develop.kde.org/docs/getting-started/kirigami/formcard-intro/">Develop</a>.
0015
0016 @subsection common_components Most common components
0017
0018 Kirigami Addons provides several QML modules. Each module may contain one or multiple components.
0019
0020 The following components are either commonly used or serve as entrypoints for using other API in their respective modules:
0021
0022 - @ref addonscomponents "Components Module"
0023   - AlbumMaximizeComponent
0024   - SearchPopupField
0025 - @ref dateandtime "Date and Time Module"
0026   - TimePopup
0027   - DatePopup
0028 - @ref delegate "Delegates Module"
0029   - IndicatorItemDelegate
0030   - RoundedItemDelegate
0031   - RoundedTreeDelegate
0032 - @ref formcard "Form Card Module"
0033   - AboutKDE
0034   - AboutPage
0035   - FormCard
0036   - FormHeader
0037   - FormCardPage
0038 - @ref categorizedsettings "Categorized Settings Module"
0039   - CategorizedSettings
0040   - SettingAction
0041 - @ref sounds "Sounds Module"
0042   - SoundsPicker
0043 - @ref treeview "TreeView Module"
0044   - TreeViewDecoration
0045
0046 @subsection modules List of modules and components
0047
0048 Each component can be used with an import statement following this pattern:
0049
0050 ```
0051 import org.kde.kirigamiaddons.<module_name> <version>
0052 ```
0053
0054 Starting with Qt6, the version is optional.
0055
0056 The following list can be used to check which component belongs to which module:
0057
0058 @subsubsection addonscomponents org.kde.kirigamiaddons.components
0059
0060 - AbstractMaximizeComponent
0061 - AlbumMaximizeComponent
0062 - AlbumModelItem
0063 - Avatar
0064 - AvatarButton
0065 - FloatingButton
0066 - DoubleFloatingButton
0067 - ImageMaximizeDelegate
0068 - VideoMaximizeDelegate
0069 - SearchPopupField
0070
0071 @subsubsection dateandtime org.kde.kirigamiaddons.dateandtime
0072
0073 - DatePicker
0074 - DatePopup
0075 - TimePicker
0076
0077 @subsubsection delegates org.kde.kirigamiaddons.delegates
0078
0079 - IndicatorItemDelegate
0080 - RoundedItemDelegate
0081 - RoundedTreeDelegate
0082
0083 @subsubsection formcard org.kde.kirigamiaddons.formcard
0084
0085 - AboutKDE
0086 - AboutPage
0087 - AbstractFormDelegate
0088 - FormArrow
0089 - FormButtonDelegate
0090 - FormCard
0091 - FormCardPage
0092 - FormCheckDelegate
0093 - FormComboBoxDelegate
0094 - FormDateTimeDelegate
0095 - FormDelegateBackground
0096 - FormDelegateSeparator
0097 - FormGridContainer
0098 - FormHeader
0099 - FormRadioDelegate
0100 - FormSectionText
0101 - FormSpinBoxDelegate
0102 - FormSwitchDelegate
0103 - FormTextDelegate
0104 - FormTextFieldDelegate
0105
0106 @subsubsection categorizedsettings org.kde.kirigamiaddons.settings
0107
0108 - CategorizedSettings
0109 - SettingAction
0110
0111 @subsubsection sounds org.kde.kirigamiaddons.sounds
0112
0113 - SoundsPicker
0114
0115 @subsubsection treeview org.kde.kirigamiaddons.treeview
0116
0117 - TreeViewDecoration
0118
0119 @licenses
0120 @lgpl
0121
0122 */
0123
0124 // DOXYGEN_SET_PROJECT_NAME = "Kirigami Addons"
0125 // DOXYGEN_SET_RECURSIVE = YES
0126 // DOXYGEN_EXCLUDE_PATTERNS = */lib/* */private/* */tests/* */autotests/* */android/* */examples/* */styles/*