diff --git a/sandbox/doc/src/images/status_base_text.png b/sandbox/doc/src/images/status_base_text.png new file mode 100644 index 00000000..0ced7c8c Binary files /dev/null and b/sandbox/doc/src/images/status_base_text.png differ diff --git a/sandbox/doc/src/statusq-overview.qdoc b/sandbox/doc/src/statusq-overview.qdoc new file mode 100644 index 00000000..1efe1904 --- /dev/null +++ b/sandbox/doc/src/statusq-overview.qdoc @@ -0,0 +1,19 @@ +/*! + \page statusq-index.html + \title StatusQ + \brief A components library for Status desktop client. + + + StatusQ provides a collection of components.... + + StatusQ - Components and Interfaces + \list + \li \l{StatusQ Components}{Components} + \li \l{StatusQ Controls}{Controls} + \li \l{StatusQ Core}{Core} + \li \l{StatusQ Layout}{Layout} + \li \l{StatusQ Platform}{Platform} + \li \l{StatusQ Popups}{Popups} + \endlist +*/ + diff --git a/sandbox/doc/src/statusqcomponents.qdoc b/sandbox/doc/src/statusqcomponents.qdoc new file mode 100644 index 00000000..ca394eca --- /dev/null +++ b/sandbox/doc/src/statusqcomponents.qdoc @@ -0,0 +1,41 @@ +/*! + \qmlmodule StatusQ.Components 0.1 + \title StatusQ Components + \brief Basic set of Components StatusQ components + + This is a listing of all Components components. + + This module is part of the \l{StatusQ}{StatusQ} project. + + \list + \li \l{StatusAddress} + \li \l{StatusBadge} + \li \l{StatusChatInfoToolBar} + \li \l{StatusChatList} + \li \l{StatusChatListItem} + \li \l{StatusImageSettings} + \li \l{StatusChatListCategory} + \li \l{StatusChatListCategoryItem} + \li \l{StatusChatListAndCategories} + \li \l{StatusChatToolBar} + \li \l{StatusContactRequestsIndicatorListItem} + \li \l{StatusDescriptionListItem} + \li \l{StatusLetterIdenticon} + \li \l{StatusListItem} + \li \l{StatusListSectionHeadline} + \li \l{StatusLoadingIndicator} + \li \l{StatusMemberListItem} + \li \l{StatusNavigationListItem} + \li \l{StatusNavigationPanelHeadline} + \li \l{StatusRoundIcon} + \li \l{StatusRoundedImage} + \li \l{StatusMacWindowButtons} + \li \l{StatusListItemBadge} + \li \l{StatusExpandableItem} + \li \l{StatusSmartIdenticon} + \li \l{StatusMessage} + \li \l{StatusMessageDetails} + \li \l{StatusTagSelector} + \li \l{StatusToastMessage} + \endlist +*/ diff --git a/sandbox/doc/src/statusqcontrols.qdoc b/sandbox/doc/src/statusqcontrols.qdoc new file mode 100644 index 00000000..01990319 --- /dev/null +++ b/sandbox/doc/src/statusqcontrols.qdoc @@ -0,0 +1,43 @@ +/*! + \qmlmodule StatusQ.Controls 0.1 + \title StatusQ Controls + \brief Basic set of Controls StatusQ components + + This is a listing of all Controls components. + + This module is part of the \l{StatusQ}{StatusQ} project. + + \list + \li \l{StatusAccountSelector} + \li \l{StatusAssetSelector} + \li \l{StatusBanner} + \li \l{StatusChatCommandButton} + \li \l{StatusChatInfoButton} + \li \l{StatusChatListCategoryItemButton} + \li \l{StatusColorSelector} + \li \l{StatusIconTabButton} + \li \l{StatusNavBarTabButton} + \li \l{StatusTabBarIconButton} + \li \l{StatusToolTip} + \li \l{StatusBaseButton} + \li \l{StatusButton} + \li \l{StatusFlatButton} + \li \l{StatusRoundButton} + \li \l{StatusFlatRoundButton} + \li \l{StatusSwitch} + \li \l{StatusRadioButton} + \li \l{StatusCheckBox} + \li \l{StatusSlider} + \li \l{StatusSelect} + \li \l{StatusBaseInput} + \li \l{StatusInput} + \li \l{StatusPickerButton} + \li \l{StatusProgressBar} + \li \l{StatusPasswordStrengthIndicator} + \li \l{StatusSwitchTabButton} + \li \l{StatusSwitchTabBar} + \li \l{StatusSelectableText} + \li \l{StatusWalletColorButton} + \li \l{StatusWalletColorSelect} + \endlist +*/ diff --git a/sandbox/doc/src/statusqcore.qdoc b/sandbox/doc/src/statusqcore.qdoc new file mode 100644 index 00000000..a0b91e41 --- /dev/null +++ b/sandbox/doc/src/statusqcore.qdoc @@ -0,0 +1,22 @@ +/*! + \qmlmodule StatusQ.Core 0.1 + \title StatusQ Core + \brief Basic set of Core StatusQ components + + This is a listing of all Core components. These + files are available for general import and they are based off the \l{https://doc.qt.io/qt-5/qtquick-qmlmodule.html}{Qt + Quick Primitives} and \l{https://doc.qt.io/archives/qt-5.11/qtquick-controls2-qmlmodule.html}{Qt Quick Controls 2}. + + This module is part of the \l{StatusQ}{StatusQ} project. + + \list + \li \l{StatusAppNavBarFilterModel} + \li \l{StatusBaseText} + \li \l{StatusIcon} + \li \l{StatusIconBackgroundSettings} + \li \l{StatusIconSettings} + \li \l{StatusImageSettings} + \li \l{StatusModalHeaderSettings} + \li \l{StatusTooltipSettings} + \endlist +*/ diff --git a/sandbox/doc/src/statusqlayout.qdoc b/sandbox/doc/src/statusqlayout.qdoc new file mode 100644 index 00000000..e52097d0 --- /dev/null +++ b/sandbox/doc/src/statusqlayout.qdoc @@ -0,0 +1,16 @@ +/*! + \qmlmodule StatusQ.Layout 0.1 + \title StatusQ Layout + \brief Basic set of Layout StatusQ components + + This is a listing of all Layout components. + + This module is part of the \l{StatusQ}{StatusQ} project. + + \list + \li \l{StatusAppLayout} + \li \l{StatusAppNavBar} + \li \l{StatusAppTwoPanelLayout} + \li \l{StatusAppThreePanelLayout} + \endlist +*/ diff --git a/sandbox/doc/src/statusqplatform.qdoc b/sandbox/doc/src/statusqplatform.qdoc new file mode 100644 index 00000000..9ac9390b --- /dev/null +++ b/sandbox/doc/src/statusqplatform.qdoc @@ -0,0 +1,15 @@ +/*! + \qmlmodule StatusQ.Platform 0.1 + \title StatusQ Platform + \brief Basic set of Platform StatusQ components + + This is a listing of all Platform components. + + This module is part of the \l{StatusQ}{StatusQ} project. + + \list + \li \l{StatusMacTrafficLights} + \li \l{StatusMacNotification} + \li \l{StatusWindowsTitleBar} + \endlist +*/ diff --git a/sandbox/doc/src/statusqpopups.qdoc b/sandbox/doc/src/statusqpopups.qdoc new file mode 100644 index 00000000..b5b55e3b --- /dev/null +++ b/sandbox/doc/src/statusqpopups.qdoc @@ -0,0 +1,22 @@ +/*! + \qmlmodule StatusQ.Popups 0.1 + \title StatusQ Popups + \brief Basic set of Popups StatusQ components + + This is a listing of all Popups components. + + This module is part of the \l{StatusQ}{StatusQ} project. + + \list + \li \l{StatusMenuSeparator} + \li \l{StatusPopupMenu} + \li \l{StatusMenuItem} + \li \l{StatusMenuItemDelegate} + \li \l{StatusModal} + \li \l{StatusSearchPopup} + \li \l{StatusModalDivider} + \li \l{StatusSearchPopupMenuItem} + \li \l{StatusSearchLocationMenu} + \li \l{StatusSpellcheckingMenuItems} + \endlist +*/ diff --git a/sandbox/doc/statusq.qdocconf b/sandbox/doc/statusq.qdocconf new file mode 100644 index 00000000..f114f462 --- /dev/null +++ b/sandbox/doc/statusq.qdocconf @@ -0,0 +1,36 @@ +project = StatusQ +version = 0.1 +description = StatusQ Project +url = https://github.com/status-im/StatusQ + +#These are set implictly by qdoc as well, but only with these the module header can be found +includepaths = -I . \ + -I $PWD/../../src/StatusQ + +imagedirs = src/images +sourcedirs += src \ + $PWD/../../src/StatusQ/Components \ + $PWD/../../src/StatusQ/Controls \ + $PWD/../../src/StatusQ/Core \ + $PWD/../../src/StatusQ/Layout \ + $PWD/../../src/StatusQ/Platform \ + $PWD/../../src/StatusQ/Popups \ + +sources.fileextensions = "*.cpp *.qdoc *.qml" + +depends += qtcore \ + qtquick \ + qtqml \ + qtgui \ + qtdoc \ + qtquickcontrols2 + +navigation.homepage = "StatusQ" + +outputdir = $PWD/html +outputformats = HTML + +HTML.stylesheets = style.css +HTML.headerstyles = "\n" +HTML.postheader = "

StatusQ - A Components selection for Status dekstop client.

" +HTML.footer = "

© 2022 Status. All rights reserved. status.im

" diff --git a/sandbox/doc/style.css b/sandbox/doc/style.css new file mode 100644 index 00000000..c72b926e --- /dev/null +++ b/sandbox/doc/style.css @@ -0,0 +1,41 @@ +body { + font-family: "Verdana"; + font-size: 14px; + max-width: 80%; + margin: auto; +} + +h1, h2, h3 { + color: #4360DF; +} + +div.sidebar { + float: right; +} + +pre { + padding: 15px; +} +div.qmlproto { + padding-left: 15px; + padding-right: 15px; +} +pre, div.qmlproto { + font-family: "Courier New"; + font-size: 20px; + margin-left: 2em; + background-color: #F0F2F5; +} + +hr { + margin-top: 2em; + margin-bottom: 2em; +} + +p.header { + margin-bottom: -1em; +} +p.footer { + text-align: right; + margin-top: -1em; +} diff --git a/sandbox/sandbox.pro b/sandbox/sandbox.pro index 9a42c130..21c62fa5 100644 --- a/sandbox/sandbox.pro +++ b/sandbox/sandbox.pro @@ -15,7 +15,7 @@ SOURCES += \ handler.cpp \ main.cpp \ sandboxapp.cpp \ - spellchecker.cpp + spellchecker.cpp \ !macx { SOURCES += statuswindow.cpp diff --git a/src/StatusQ/Core/StatusBaseText.qml b/src/StatusQ/Core/StatusBaseText.qml index 20832934..6406162f 100644 --- a/src/StatusQ/Core/StatusBaseText.qml +++ b/src/StatusQ/Core/StatusBaseText.qml @@ -1,6 +1,30 @@ import QtQuick 2.13 import StatusQ.Core.Theme 0.1 +/*! + \qmltype StatusBaseText + \inherits Text + \inqmlmodule StatusQ.Core + \since StatusQ.Core 0.1 + \brief Displays multiple lines of text. Inherits \l{https://doc.qt.io/qt-5/qml-qtquick-text.html}{Text}. + + The \c StatusBaseText item displays text. + For example: + + \qml + StatusBaseText { + width: 240 + text: "Hello World!" + font.pixelSize: 24 + color: Theme.pallete.directColor1 + } + \endqml + + \image status_base_text.png + + For a list of components available see StatusQ. +*/ + Text { font.family: Theme.palette.baseFont.name }