Differential D18716 Diff 52411 src/controls/ActionTextField.qml

Changeset View

Standalone View

src/controls/ActionTextField.qml

This file was added.

1		/*
2		* Copyright (C) 2019 Carl-Lucien Schwan <carl@carlschwan.eu> *
3		*
4		* This program is free software; you can redistribute it and/or modify
5		* it under the terms of the GNU Library/Lesser General Public License
6		* version 2, or (at your option) any later version, as published by the
7		* Free Software Foundation
8		*
9		* This program is distributed in the hope that it will be useful,
10		* but WITHOUT ANY WARRANTY; without even the implied warranty of
11		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12		* GNU General Public License for more details
13		*
14		* You should have received a copy of the GNU Library/Lesser General Public
15		* License along with this program; if not, write to the
16		* Free Software Foundation, Inc.,
17		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18		*/
19
20		import QtQuick 2.6
21		import QtQuick.Controls 2.1 as Controls
22		import org.kde.kirigami 2.7 as Kirigami
23
24		/**
25		* This is advanced textfield. It is recommanded to us this class when there
26		* is a need to create a create a textfield with action boutons(e.g a clear
27		* action).
28		*
29		* Example usage for a search field:
30		* @code
31		* import org.kde.kirigami 2.7 as Kirigami
32		*
33		* Kirigami.ActionTextField {
34		* id: searchField
35		*
36		* placeholderText: i18n("Search...")
37		*
38		* focusSequence: "Ctrl+F"
39		*
40		* rightActions: [
41		* Kirigami.Action {
42		* iconName: "edit-clear"
43		* visible: searchField.text != ""
44		* onTriggered: {
45		* searchField.text = ""
46		* searchField.accepted()
47		* }
48		* }
49		* ]
50		*
51		* onAccepted: console.log("Search text is " + searchField.text)
52		* }
53		*/
54		Controls.TextField
55		{
56		id: root
57
58		/**
59		* focusSequence: keysequence
60		* This property hold the a list of shortcut sequence that put the text
61		* field into focus.
62		*/
63		property string focusSequence: null
64
65		/**
66		* leftActions: list<QtObject>
67		* This propery hold the action that is left in the field. By default this
68		* field is null.
69		*/
70		property list<QtObject> leftActions
71
72		/**
73		* rightActions: list<QtObject>
74		* This propery hold the action that is right in the field. By default this
75		* field is null.
76		*/
77		property list<QtObject> rightActions
78
79		hoverEnabled: true
80
81		leftPadding: leftActionsRow.width
82		rightPadding: rightActionsRow.width
83
84		Shortcut {
85		id: focusShortcut
86		enabled: root.focusSequence != null
87		sequence: root.focusSequence
88		onActivated: {
89		root.forceActiveFocus()
90		root.selectAll()
91		}
92		}
93
94		Controls.ToolTip {
95		visible: root.focusSequence != null && root.hovered && !rightActionsRow.hovered && !leftActionsRow.hovered
96		text: root.focusSequence ? root.focusSequence : ""
97		}
98
99		Row {
100		id: leftActionsRow
101		padding: Kirigami.Units.smallSpacing
102		Repeater {
103		model: root.leftActions
104		Kirigami.Icon {
	martUnsubmitted Done icon.name, so will work also with qqc2 actions or better: source: modelData.icon.name.length > 0 ? modelData.icon.name : modelData.icon.source mart: icon.name, so will work also with qqc2 actions or better: source: modelData.icon.name.length >…
105		height: root.implicitHeight - 2 * Kirigami.Units.smallSpacing
106		width: this.implicitHeight - 2 * Kirigami.Units.smallSpacing
107		source: modelData.icon.name.length > 0 ? modelData.icon.name : modelData.icon.source
108		visible: modelData.visible
109		MouseArea {
110		anchors.fill: parent
111		onClicked: modelData.trigger()
112		cursorShape: Qt.PointingHandCursor
113		}
114		}
115		}
116		}
117
118		Row {
119		id: rightActionsRow
120		padding: Kirigami.Units.smallSpacing
121		layoutDirection: Qt.RightToLeft
122		anchors.right: parent.right
123		Repeater {
124		model: root.rightActions
125		Kirigami.Icon {
	martUnsubmitted Done icon.name or better: source: modelData.icon.name.length > 0 ? modelData.icon.name : modelData.icon.source mart: icon.name or better: source: modelData.icon.name.length > 0 ? modelData.icon.name : modelData.
126		height: root.implicitHeight - 2 * Kirigami.Units.smallSpacing
127		width: this.implicitHeight - 2 * Kirigami.Units.smallSpacing
128		source: modelData.icon.name.length > 0 ? modelData.icon.name : modelData.icon.source
129		visible: modelData.visible
130		MouseArea {
131		anchors.fill: parent
132		onClicked: modelData.trigger()
133		cursorShape: Qt.PointingHandCursor
134		}
135		}
136		}
137		}
138		}