poz/quickshell
1
0
Fork 0
forked from quickshell/quickshell
Code Pull requests Activity

widgets/wrapper: add WrapperMouseArea

Browse source
This commit is contained in:
outfoxxed 2025-05-17 00:38:09 -07:00
parent 4d7d06bb9b
commit 4d74851fd0
Signed by untrusted user: outfoxxed
GPG key ID: 4C88A185FB89301E
3 changed files with 52 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
src/widgets/CMakeLists.txt
View file

@ -11,6 +11,7 @@ qt_add_qml_module(quickshell-widgets
IconImage.qml
ClippingRectangle.qml
WrapperItem.qml
WrapperMouseArea.qml
WrapperRectangle.qml
ClippingWrapperRectangle.qml
)

50
src/widgets/WrapperMouseArea.qml Normal file
View file

@ -0,0 +1,50 @@
import QtQuick
///! MouseArea wrapper item.
/// This component is useful for wrapping a single component in
/// a mouse area. It works the same as @@WrapperItem, but with a @@QtQuick.MouseArea.
///
/// > [!NOTE] WrapperMouseArea is a @@MarginWrapperManager based component.
/// > See its documentation for information on how margins and sizes are calculated.
///
/// > [!NOTE] The child item can be specified by writing it inline in the wrapper,
/// > as in the example above, or by using the @@child property. See
/// > @@WrapperManager.child for details.
///
/// > [!WARNING] You should not set @@Item.x, @@Item.y, @@Item.width,
/// > @@Item.height or @@Item.anchors on the child item, as they are used
/// > by WrapperItem to position it. Instead set @@Item.implicitWidth and
/// > @@Item.implicitHeight.
///
/// [QtQuick.Layouts]: https://doc.qt.io/qt-6/qtquicklayouts-index.html
MouseArea {
/// The default for @@topMargin, @@bottomMargin, @@leftMargin and @@rightMargin.
/// Defaults to 0.
property /*real*/alias margin: manager.margin
/// An extra margin applied in addition to @@topMargin, @@bottomMargin,
/// @@leftMargin, and @@rightMargin. Defaults to 0.
property /*real*/alias extraMargin: manager.extraMargin
/// The requested top margin of the content item, not counting @@extraMargin.
///
/// Defaults to @@margin, and may be reset by assigning `undefined`.
property /*real*/alias topMargin: manager.topMargin
/// The requested bottom margin of the content item, not counting @@extraMargin.
///
/// Defaults to @@margin, and may be reset by assigning `undefined`.
property /*real*/alias bottomMargin: manager.bottomMargin
/// The requested left margin of the content item, not counting @@extraMargin.
///
/// Defaults to @@margin, and may be reset by assigning `undefined`.
property /*real*/alias leftMargin: manager.leftMargin
/// The requested right margin of the content item, not counting @@extraMargin.
///
/// Defaults to @@margin, and may be reset by assigning `undefined`.
property /*real*/alias rightMargin: manager.rightMargin
/// Determines if child item should be resized larger than its implicit size if
/// the parent is resized larger than its implicit size. Defaults to false.
property /*bool*/alias resizeChild: manager.resizeChild
/// See @@WrapperManager.child for details.
property /*Item*/alias child: manager.child
MarginWrapperManager { id: manager }
}

1
src/widgets/module.md
View file

@ -10,6 +10,7 @@ qml_files = [
"IconImage.qml",
"ClippingRectangle.qml",
"WrapperItem.qml",
"WrapperMouseArea.qml",
"WrapperRectangle.qml",
"ClippingWrapperRectangle.qml",
]