/usr/lib/x86_64-linux-gnu/qt5/qml/Ubuntu/Components/1.3/TextField.qml is in qml-module-ubuntu-components 1.3.1918+16.04.20160404-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 | /*
* Copyright 2015-2016 Canonical Ltd.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import QtQuick 2.4
import Ubuntu.Components 1.3 as Ubuntu
import Ubuntu.Components.Popups 1.3
/*!
\qmltype TextField
\inqmlmodule Ubuntu.Components 1.1
\ingroup ubuntu
\brief The TextField element displays a single line of editable plain text.
Input constraints can be set through validator or inputMask. Setting echoMode
to an appropriate value enables TextField to be used as password input field.
\l {https://design.ubuntu.com/apps/building-blocks/text-input#text-field}{See also the Design Guidelines on the Text Field}.
Example:
\qml
Item {
TextField {
placeholderText: "hint text"
}
TextField {
placeholderText: "without clear sign"
hasClearButton: false
}
TextField {
placeholderText: "password"
echoMode: TextInput.Password
}
TextField {
placeholderText: "overlaid in front"
primaryItem: Image {
height: parent.height
width: height
source: "magnifier.png"
}
secondaryItem: Row {
Button {
height: parent.height
width: height
iconName: "compose"
onClicked: doSomething()
}
Button {
height: parent.height
width: height
iconName: "undo"
onClicked: doSomething()
}
}
}
}
\endqml
\section2 Scrolling and text selection
The input is activated when the tap or mouse is released after being pressed
over the component.
The text can be scrolled horizontally by swiping over the content both when
the component is active or inactive.
The content can be selected in the following ways:
\list
\li - double tapping/left mouse clicking over the content, when the word that
had been tapped over will be selected
\li - by pressing and dragging the selection cursor over the text input. Note
that there has to be a delay of approx. 200 ms between the press and drag
gesture, time when the input switches from scroll mode to selection mode
\endlist
The input is focused (activated) upon tap/left mouse button release. The cursor
will be placed at the position the mouse/tap point at release time. If the click
is happening on a selected area, the selection will be cleared. Long press above
a selected area brings up the clipboard context menu. When the long press happens
over a non-selected area, the cursor will be moved to the position and the component
enters in selection mode. The selection mode can also be activated by tapping and
keeping the tap/mouse over for approx 300 ms. If there is a move during this time,
the component enters into scrolling mode. The mode is exited once the scrolling
finishes. During the scrolling mode the selected text is preserved.
\note During text selection all interactive parent Flickables are turned off.
*/
Ubuntu.ActionItem {
id: control
implicitWidth: units.gu(25)
implicitHeight: units.gu(4)
/*!
The property presents whether the TextField is highlighted or not. By
default the TextField gets highlighted when gets the focus, so can accept
text input. This property allows to control the highlight separately from
the focused behavior.
*/
property bool highlighted: activeFocus
/*!
Text that appears when there is no content in the component.
\qmlproperty string placeholderText
*/
property alias placeholderText: hint.text
/*!
Specifies whether the control has a clear button or not.
*/
property bool hasClearButton: true
/*!
\deprecated
Component to be shown and used instead of the default On Screen Keyboard.
*/
property Component customSoftwareInputPanel
onCustomSoftwareInputPanelChanged: console.error("customSoftwareInputPanel property deprecated.")
/*!
The property overrides the default popover of the TextField. When set, the TextField
will open the given popover instead of the default one defined. The popover can either
be a component or a URL to be loaded.
*/
property var popover
/*!
Overlaid component that can be set for the fore side of the TextField,
e.g.showing a magnifier to implement search functionality.
\qmlproperty list<Object> primaryItem
*/
property alias primaryItem: leftPane.data
/*!
Overlaid component that can be set for the rear side of the TextField,
e.g.showing a CAPS LOCK or NUM LOCK indication. The overlaid components
will be placed right after the clear button.
\qmlproperty list<Object> secondaryItem
*/
property alias secondaryItem: rightPane.data
/*!
Allows highlighting errors in the TextField.
*/
property bool errorHighlight: !acceptableInput
// aliased properties from TextInput
/*!
This property is always true unless a validator or input mask has been set.
If a validator or input mask has been set, this property will only be true
if the current text is acceptable to the validator or input mask as a final
string (not as an intermediate string).
\qmlproperty bool acceptableInput
*/
property alias acceptableInput: editor.acceptableInput
/*!
Whether the TextField should gain active focus on a mouse press. By default
this is set to true.
\qmlproperty bool activeFocusOnPress
*/
property alias activeFocusOnPress: editor.activeFocusOnPress
/*!
Whether the TextField should scroll when the text is longer than the width.
By default this is set to true.
\qmlproperty bool autoScroll
*/
property alias autoScroll: editor.autoScroll
/*!
Returns true if the TextField is writable and the content of the clipboard
is suitable for pasting into the TextField.
\qmlproperty bool canPaste
*/
property alias canPaste: editor.canPaste
/*!
Returns true if the TextField is writable and there are undone operations
that can be redone.
\qmlproperty bool canRedo
*/
property alias canRedo: editor.canRedo
/*!
Returns true if the TextField is writable and there are previous operations
that can be undone.
\qmlproperty bool canUndo
*/
property alias canUndo: editor.canUndo
/*!
The text color.
\qmlproperty color color
*/
property alias color: editor.color
/*!
Returns the height of the text, including the height past the height that
is covered if the text does not fit within the set height.
\qmlproperty real contentHeight
*/
property alias contentHeight: editor.contentHeight
/*!
Returns the width of the text, including the width past the width which
is covered due to insufficient wrapping if wrapMode is set.
\qmlproperty real contentWidth
*/
property alias contentWidth: editor.contentWidth
/*!
The delegate for the cursor in the TextField.
If you set a cursorDelegate for a TextField, this delegate will be used for
drawing the cursor instead of the standard cursor. An instance of the delegate
will be created and managed by the TextField when a cursor is needed, and
the x property of delegate instance will be set so as to be one pixel before
the top left of the current character.
Note that the root item of the delegate component must be a QQuickItem or
QQuickItem derived item.
*/
property Component cursorDelegate: null
/*!
The position of the cursor in the TextField.
\qmlproperty int cursorPosition
*/
property alias cursorPosition: editor.cursorPosition
/*!
The rectangle where the standard text cursor is rendered within the text
input. Read only.
The position and height of a custom cursorDelegate are updated to follow
the cursorRectangle automatically when it changes. The width of the delegate
is unaffected by changes in the cursor rectangle.
\qmlproperty rectangle cursorRectangle
*/
property alias cursorRectangle: editor.cursorRectangle
/*!
Set to true when the TextField shows a cursor.
This property is set and unset when the TextField gets active focus, so that
other properties can be bound to whether the cursor is currently showing.
As it gets set and unset automatically, when you set the value yourself you
must keep in mind that your value may be overwritten.
It can be set directly in script, for example if a KeyProxy might forward keys
to it and you desire it to look active when this happens (but without actually
giving it active focus).
It should not be set directly on the item, like in the below QML, as the specified
value will be overridden an lost on focus changes.
\qml
TextField {
text: "Text"
cursorVisible: false
}
\endqml
In the above snippet the cursor will still become visible when the TextField
gains active focus.
\qmlproperty bool cursorVisible
*/
property alias cursorVisible: editor.cursorVisible
/*!
This is the text displayed in the TextField.
If echoMode is set to TextInput::Normal, this holds the same value as the
\l text property. Otherwise, this property holds the text visible to the
user, while the text property holds the actual entered text.
\qmlproperty string displayText
*/
property alias displayText: editor.displayText
/*!
Specifies how the text should be displayed in the TextField.
\list
\li - TextInput.Normal - Displays the text as it is. (Default)
\li - TextInput.Password - Displays asterixes instead of characters.
\li - TextInput.NoEcho - Displays nothing.
\li - TextInput.PasswordEchoOnEdit - Displays characters as they are entered while
editing, otherwise displays asterisks.
\endlist
\qmlproperty enumeration echoMode
*/
property alias echoMode: editor.echoMode
/*!
Font used in the TextField.
\qmlproperty font font
*/
property alias font: editor.font
/*!
Allows you to set an input mask on the TextField, restricting the text
inputs. See QLineEdit::inputMask for further details, as the exact same mask strings
are used by TextField.
Note that when using an inputMask together with echoMode to hide the input
the empty TextField may still show masked characters - consider \l validator instead.
\sa acceptableInput, validator
\qmlproperty string inputMask
*/
property alias inputMask: editor.inputMask
/*!
This property holds whether the TextInput has partial text input from an input method.
While it is composing an input method may rely on mouse or key events from the
TextField to edit or commit the partial text. This property can be used to determine
when to disable events handlers that may interfere with the correct operation
of an input method.
\qmlproperty bool inputMethodComposing
*/
property alias inputMethodComposing: editor.inputMethodComposing
/*!
Provides hints to the input method about the expected content of the text input and how it
should operate.
The value is a bit-wise combination of flags, or Qt.ImhNone if no hints are set.
Flags that alter behaviour are:
\list
\li - Qt.ImhHiddenText - Characters should be hidden, as is typically used when entering passwords.
This is automatically set when setting echoMode to \c TextInput.Password.
\li - Qt.ImhSensitiveData - Typed text should not be stored by the active input method
in any persistent storage like predictive user dictionary.
\li - Qt.ImhNoAutoUppercase - The input method should not try to automatically switch to upper case
when a sentence ends.
\li - Qt.ImhPreferNumbers - Numbers are preferred (but not required).
\li - Qt.ImhPreferUppercase - Upper case letters are preferred (but not required).
\li - Qt.ImhPreferLowercase - Lower case letters are preferred (but not required).
\li - Qt.ImhNoPredictiveText - Do not use predictive text (i.e. dictionary lookup) while typing.
\li - Qt.ImhDate - The text editor functions as a date field.
\li - Qt.ImhTime - The text editor functions as a time field.
\endlist
Flags that restrict input (exclusive flags) are:
\list
\li - Qt.ImhDigitsOnly - Only digits are allowed.
\li - Qt.ImhFormattedNumbersOnly - Only number input is allowed. This includes decimal point and minus sign.
\li - Qt.ImhUppercaseOnly - Only upper case letter input is allowed.
\li - Qt.ImhLowercaseOnly - Only lower case letter input is allowed.
\li - Qt.ImhDialableCharactersOnly - Only characters suitable for phone dialing are allowed.
\li - Qt.ImhEmailCharactersOnly - Only characters suitable for email addresses are allowed.
\li - Qt.ImhUrlCharactersOnly - Only characters suitable for URLs are allowed.
\endlist
Masks:
\list
\li - Qt.ImhExclusiveInputMask - This mask yields nonzero if any of the exclusive flags are used.
\endlist
\qmlproperty enumeration inputMethodHints
*/
property alias inputMethodHints: editor.inputMethodHints
/*!
Returns the total number of characters in the TextField item.
If the TextField has an inputMask the length will include mask characters
and may differ from the length of the string returned by the text property.
This property can be faster than querying the length the text property as
it doesn't require any copying or conversion of the TextField's internal
string data.
\qmlproperty int length
*/
property alias length: editor.length
/*!
The maximum permitted length of the text in the TextField.
If the text is too long, it is truncated at the limit.
By default, this property contains a value of 32767.
\qmlproperty int maximumLength
*/
property alias maximumLength: editor.maximumLength
/*!
Specifies how text should be selected using a mouse.
\list
\li -TextInput.SelectCharacters - The selection is updated with individual
characters. (Default)
\li -TextInput.SelectWords - The selection is updated with whole words.
\endlist
This property only applies when selectByMouse is true.
\qmlproperty enumeration mouseSelectionMode
*/
property alias mouseSelectionMode: editor.mouseSelectionMode
/*!
Whether the TextField should keep its selection when it loses active focus
to another item in the scene. By default this is set to false.
\qmlproperty bool persistentSelection
*/
property alias persistentSelection: editor.persistentSelection
/*!
Sets whether user input can modify the contents of the TextField.
If readOnly is set to true, then user input will not affect the
text property. Any bindings or attempts to set the text property
will still work.
\qmlproperty bool readOnly
*/
property alias readOnly: editor.readOnly
/*!
Override the default rendering type for this component.
Supported render types are:
\list
\li - Text.QtRendering - (default)
\li - Text.NativeRendering
\endlist
Select Text.NativeRendering if you prefer text to look native on the target
platform and do not require advanced features such as transformation of the
text. Using such features in combination with the NativeRendering render type
will lend poor and sometimes pixelated results.
\qmlproperty enumeration renderType
*/
property alias renderType: editor.renderType
/*!
Defaults to true.
If false, the user cannot use the mouse to select text, only can use it to
focus the input.
\qmlproperty bool selectByMouse
*/
property alias selectByMouse: editor.selectByMouse
/*!
This read-only property provides the text currently selected in the text input.
It is equivalent to the following snippet, but is faster and easier to use.
\code
myTextInput.text.toString().substring(myTextInput.selectionStart,
myTextInput.selectionEnd);
\endcode
\qmlproperty string selectedText
*/
readonly property alias selectedText: editor.selectedText
/*!
The cursor position before the first character in the current selection.
This property is read-only. To change the selection, use select(start,end),
selectAll(), or selectWord().
\qmlproperty int selectionStart
*/
property alias selectionStart: editor.selectionStart
/*!
The cursor position after the last character in the current selection.
This property is read-only. To change the selection, use select(start,end),
selectAll(), or selectWord().
\qmlproperty int selectionEnd
*/
property alias selectionEnd: editor.selectionEnd
/*!
The text in the TextField.
\qmlproperty string text
*/
property alias text: editor.text
/*!
Allows you to set a validator on the TextInput. When a validator is set the
TextField will only accept input which leaves the text property in an acceptable
or intermediate state. The accepted signal will only be sent if the text is in
an acceptable state when enter is pressed.
Currently supported validators are IntValidator, DoubleValidator and RegExpValidator.
An example of using validators is shown below, which allows input of integers
between 11 and 31 into the text input:
\qml
import QtQuick 2.4
import Ubuntu.Components 1.3
TextField{
validator: IntValidator{bottom: 11; top: 31;}
focus: true
}
\endqml
The next example is for a use case of typing a PIN with masked characters.
\qml
import QtQuick 2.4
import Ubuntu.Components 1.3
TextField {
echoMode: TextInput.Password
validator: RegExpValidator { regExp: /^\d{4}$/ }
inputMethodHints: Qt.ImhDigitsOnly
}
\endqml
\sa acceptableInput, inputMask
\qmlproperty Validator validator
*/
property alias validator: editor.validator
/*!
Sets the horizontal alignment of the text within the item's width and height.
By default, the text alignment follows the natural alignment of the text, for
example text that is read from left to right will be aligned to the left.
TextField does not have vertical alignment, as the natural height is exactly
the height of the single line of text. If you set the height manually to something
larger, TextInput will always be top aligned vertically. You can use anchors to
align it however you want within another item.
The valid values for horizontalAlignment are TextInput.AlignLeft,
TextInput.AlignRight and TextInput.AlignHCenter.
Valid values for verticalAlignment are TextInput.AlignTop (default), TextInput.AlignBottom
TextInput.AlignVCenter.
When using the attached property LayoutMirroring::enabled to mirror application
layouts, the horizontal alignment of text will also be mirrored. However,
the property horizontalAlignment will remain unchanged. To query the effective
horizontal alignment of TextField, use the read-only property effectiveHorizontalAlignment.
\qmlproperty enumeration horizontalAlignment
*/
property alias horizontalAlignment: editor.horizontalAlignment
/*!
\qmlproperty enumeration effectiveHorizontalAlignment
See \l horizontalAlignment for details.
*/
property alias effectiveHorizontalAlignment: editor.effectiveHorizontalAlignment
/*!
\qmlproperty enumeration verticalAlignment
See \l horizontalAlignment for details.
*/
property alias verticalAlignment: editor.verticalAlignment
/*!
This is the character displayed when echoMode is set to Password or
PasswordEchoOnEdit. By default it is the unicode character 2022.
If this property is set to a string with more than one character, the first
character is used. If the string is empty, the value is ignored and the property
is not set.
\qmlproperty string passwordCharacter
*/
property alias passwordCharacter: editor.passwordCharacter
/*!
The text highlight color, used behind selections.
\qmlproperty color selectionColor
*/
property alias selectionColor: editor.selectionColor
/*!
The highlighted text color, used in selections.
\qmlproperty color selectedTextColor
*/
property alias selectedTextColor: editor.selectedTextColor
/*!
This handler is called when the Return or Enter key is pressed. Note that if
there is a validator or inputMask set on the text input, the handler will only
be emitted if the input is in an acceptable state.
*/
signal accepted()
/*!
\internal
If used with an action or Option accepting propagates the new text.
*/
onAccepted: {
control.triggered(control.text)
}
/*!
Copies the currently selected text to the system clipboard.
*/
function copy()
{
editor.copy();
}
/*!
Moves the currently selected text to the system clipboard.
*/
function cut()
{
editor.cut();
}
/*!
Places the clipboard or the data given as parameter into the text input.
The selected text will be replaces with the data.
*/
function paste(data)
{
if ((data !== undefined) && (typeof data === "string") && !editor.readOnly) {
var selTxt = editor.selectedText;
var txt = editor.text;
var pos = (selTxt !== "") ? txt.indexOf(selTxt) : editor.cursorPosition
if (selTxt !== "") {
editor.text = txt.substring(0, pos) + data + txt.substr(pos + selTxt.length);
} else {
editor.text = txt.substring(0, pos) + data + txt.substr(pos);
}
editor.cursorPosition = pos + data.length;
} else
editor.paste();
}
/*!
Removes active text selection.
*/
function deselect()
{
editor.deselect();
}
/*!
Inserts \a text into the TextField at \a position.
*/
function insert(position, text) {
editor.insert(position, text);
}
/*!
This function returns the character position at x pixels from the left of
the TextField. Position 0 is before the first character, position 1 is after
the first character but before the second, and so on until position text.length,
which is after all characters.
This means that for all x values before the first character this function returns 0,
and for all x values after the last character this function returns text.length.
The cursor position type specifies how the cursor position should be resolved.
\list
\li - TextInput.CursorBetweenCharacters - Returns the position between characters
that is nearest x.
\li - TextInput.CursorOnCharacter - Returns the position before the character that
is nearest x.
\endlist
*/
function positionAt(x, position)
{
if (position == undefined)
return editor.positionAt(x);
else
return editor.positionAt(x, position);
}
/*!
This function takes a character position and returns the rectangle that the
cursor would occupy, if it was placed at that character position.
This is similar to setting the cursorPosition, and then querying the cursor
rectangle, but the cursorPosition is not changed.
*/
function positionToRectangle(pos)
{
return editor.positionToRectangle(pos);
}
/*!
Causes the text from start to end to be selected.
If either start or end is out of range, the selection is not changed.
After calling this, selectionStart will become the lesser and selectionEnd
will become the greater (regardless of the order passed to this method).
*/
function select(start, end)
{
editor.select(start, end);
}
/*!
Causes all text to be selected.
*/
function selectAll()
{
editor.selectAll();
}
/*!
Causes the word closest to the current cursor position to be selected.
*/
function selectWord()
{
editor.selectWord();
}
/*!
Returns true if the natural reading direction of the editor text found between
positions start and end is right to left.
*/
function isRightToLeft(start, end) {
return editor.isRightToLeft(start, end);
}
/*!
Moves the cursor to position and updates the selection according to the
optional mode parameter. (To only move the cursor, set the cursorPosition property.)
When this method is called it additionally sets either the selectionStart
or the selectionEnd (whichever was at the previous cursor position) to the
specified position. This allows you to easily extend and contract the selected
text range.
The selection mode specifies whether the selection is updated on a per character
or a per word basis. If not specified the selection mode will default to
TextInput.SelectCharacters.
\list
\li - TextInput.SelectCharacters - Sets either the selectionStart or selectionEnd
(whichever was at the previous cursor position) to the specified position.
\li - TextInput.SelectWords - Sets the selectionStart and selectionEnd to
include all words between the specified position and the previous cursor
position. Words partially in the range are included.
\endlist
For example, take this sequence of calls:
\code
cursorPosition = 5
moveCursorSelection(9, TextInput.SelectCharacters)
moveCursorSelection(7, TextInput.SelectCharacters)
\endcode
This moves the cursor to position 5, extend the selection end from 5 to 9
and then retract the selection end from 9 to 7, leaving the text from position
5 to 7 selected (the 6th and 7th characters).
The same sequence with TextInput.SelectWords will extend the selection
start to a word boundary before or on position 5 and extend the selection
end to a word boundary on or past position 9.
*/
function moveCursorSelection(position, mode) {
editor.moveCursorSelection(position, mode)
}
/*!
Redoes the last operation if redo is \l {canRedo}{available}.
*/
function redo() {
editor.redo();
}
/*!
Undoes the last operation if undo is \l {canUndo}{available}. Deselects any current
selection, and updates the selection start to the current cursor position.
*/
function undo() {
editor.undo();
}
/*!
Removes the section of text that is between the start and end positions from the TextField.
*/
function remove(start, end) {
editor.remove(start, end);
}
/*!
Returns the section of text that is between the start and end positions.
If the TextField has an inputMask the length will include mask characters.
*/
function getText(start, end) {
return editor.getText(start, end);
}
// internals
activeFocusOnPress: true
activeFocusOnTab: true
/*! \internal */
onVisibleChanged: {
if (!visible)
control.focus = false;
}
// Escape should close the context menu even if the menu takes no input focus
Keys.onEscapePressed: {
if (activeFocus && inputHandler.popover) {
PopupUtils.close(inputHandler.popover)
} else {
event.accepted = false
}
}
LayoutMirroring.enabled: Qt.application.layoutDirection == Qt.RightToLeft
LayoutMirroring.childrenInherit: true
// grab clicks from the area between the frame and the input
MouseArea {
anchors.fill: parent
acceptedButtons: Qt.LeftButton | Qt.RightButton
// use it only when there is space between the frame and input
enabled: internal.spacing > 0
preventStealing: false
// forward mouse events to input so we can handle those uniformly
Ubuntu.Mouse.forwardTo: [inputHandler]
cursorShape: Qt.IBeamCursor
}
Text { id: fontHolder }
//internals
QtObject {
id: internal
// array of borders in left, top, right, bottom order
property real spacing: control.__styleInstance.frameSpacing
property int type: action ? action.parameterType : Ubuntu.Action.None
onTypeChanged: {
// Don't undo explicitly specified hints
if (inputMethodHints != Qt.ImhNone)
return
if (type == Ubuntu.Action.Integer
|| type == Ubuntu.Action.Real)
inputMethodHints = Qt.ImhDigitsOnly
}
}
//left pane
Item {
id: leftPane
anchors {
left: parent.left
leftMargin: internal.spacing
verticalCenter: parent.verticalCenter
}
// the left pane width depends on its children width
height: parent.height
width: childrenRect.width
// Overlay needs to have priority
z: 1
onChildrenChanged: {
// reparenting
for (var i = 0; i < children.length; i++) {
var child = children[i];
child.parent = leftPane;
child.anchors.verticalCenter = verticalCenter;
if (child.hasOwnProperty("activeFocusOnPress")) {
child.activeFocusOnPress = false;
}
child.activeFocusOnTab = false;
}
}
}
// right pane
Item {
id: rightPane
anchors {
right: parent.right
rightMargin: internal.spacing
verticalCenter: parent.verticalCenter
}
// the right pane width depends on its children width
height: parent.height
width: childrenRect.width
// Overlay needs to have priority
z: 1
onChildrenChanged: {
// reparenting
for (var i = 0; i < children.length; i++) {
var child = children[i];
child.parent = rightPane;
child.anchors.verticalCenter = verticalCenter;
if (child.hasOwnProperty("activeFocusOnPress")) {
child.activeFocusOnPress = false;
}
child.activeFocusOnTab = false;
}
}
}
Ubuntu.AbstractButton {
id: clearButton
objectName: "clear_button"
activeFocusOnPress: false
activeFocusOnTab: false
anchors {
top: parent.top
right: rightPane.left
bottom: parent.bottom
margins: internal.spacing
}
/* draggedItemMouseArea and dragger in TextCursor are reparented to the
TextField and end up being on top of the clear button.
Ensure that the clear button receives touch/mouse events first.
*/
z: 100
width: visible ? icon.width : 0
visible: control.hasClearButton &&
!control.readOnly &&
(control.activeFocus && ((editor.text != "") || editor.inputMethodComposing))
Ubuntu.Icon {
id: icon
anchors.verticalCenter: parent.verticalCenter
width: units.gu(2.5)
height: width
// use icon from icon-theme
name: control.hasClearButton && !control.readOnly ? "edit-clear" : ""
}
onClicked: editor.text = ""
}
// hint text
Ubuntu.Label {
id: hint
verticalAlignment: Text.AlignVCenter
horizontalAlignment: editor.horizontalAlignment
anchors {
left: leftPane.right
right: clearButton.left
top: parent.top
bottom: parent.bottom
margins: internal.spacing
}
// hint is shown till user types something in the field
visible: (editor.text == "") && !editor.inputMethodComposing
color: theme.palette.normal.baseText
font: editor.font
elide: Text.ElideRight
}
// text input
Flickable {
id: flicker
objectName: "input_scroller"
anchors {
left: leftPane.right
right: clearButton.left
top: parent.top
bottom: parent.bottom
margins: internal.spacing
}
topMargin: internal.spacing
// do not allow rebounding
boundsBehavior: Flickable.StopAtBounds
// need to forward events as events occurred on topMargin area are not grabbed by the MouseArea.
Ubuntu.Mouse.forwardTo: [inputHandler]
clip: true
contentWidth: editor.contentWidth
contentHeight: editor.contentHeight
TextInput {
id: editor
objectName: "text_input"
// FocusScope will forward focus to this component
focus: true
anchors.verticalCenter: parent.verticalCenter
verticalAlignment: TextInput.AlignVCenter
width: flicker.width
height: flicker.height
cursorDelegate: TextCursor {
handler: inputHandler
}
color: control.__styleInstance.color
selectedTextColor: control.__styleInstance.selectedTextColor
selectionColor: control.__styleInstance.selectionColor
font.pixelSize: FontUtils.sizeToPixels("medium")
passwordCharacter: "\u2022"
// forward keys to the root element so it can be captured outside of it
// as well as to InputHandler to handle PageUp/PageDown keys
Keys.forwardTo: [control, inputHandler]
// overrides
selectByMouse: true
activeFocusOnPress: true
onActiveFocusChanged: if (!activeFocus && inputHandler.popover) PopupUtils.close(inputHandler.popover)
// input selection and navigation handling
Ubuntu.Mouse.forwardTo: [inputHandler]
InputHandler {
id: inputHandler
anchors.fill: parent
main: control
input: editor
flickable: flicker
}
}
}
Component.onCompleted: {
editor.accepted.connect(control.accepted);
cursorPosition = 0;
}
styleName: "TextFieldStyle"
}
|