Entry¶

Widget description¶
An entry is a convenience widget which shows a box that the user can enter text into.
Entries by default don’t scroll, so they grow to accommodate the entire text,
resizing the parent window as needed. This can be changed with the property
scrollable
.
They can also be single line or multi line (the default) and when set to multi line mode they support text wrapping in any of the modes indicated by Wrap mode.
Other features include password mode, filtering of inserted text with
markup_filter_append()
and related
functions, inline “items” and formatted markup text.
Scrollable Interface¶
This widget supports the scrollable interface.
If you wish to control the scolling behaviour using these functions,
inherit both the widget class and the
Scrollable
class
using multiple inheritance, for example:
class ScrollableGenlist(Genlist, Scrollable):
def __init__(self, canvas, *args, **kwargs):
Genlist.__init__(self, canvas)
Formatted text¶
The markup tags supported by the Entry are defined by the theme, but even when writing new themes or extensions it’s a good idea to stick to a sane default, to maintain coherency and avoid application breakages. Currently defined by the default theme are the following tags:
<br>
Inserts a line break.
<ps>
Inserts a paragraph separator. This is preferred over line breaks.
<tab>
Inserts a tab.
<em>...</em>
Emphasis. Sets the oblique style for the enclosed text.
<b>...</b>
Sets the bold style for the enclosed text.
<link>...</link>
Underlines the enclosed text.
<hilight>...</hilight>
Highlights the enclosed text.
Special markups¶
Besides those used to format text, entries support two special markup tags used to insert click-able portions of text or items inlined within the text.
Anchors¶
Anchors are similar to HTML anchors. Text can be surrounded by <a> and </a> tags and an event will be generated when this text is clicked, like this:
This text is outside <a href=anc-01>but this one is an anchor</a>
The href
attribute in the opening tag gives the name that will be
used to identify the anchor and it can be any valid utf8 string.
When an anchor is clicked, an "anchor,clicked"
signal is emitted with
an EntryAnchorInfo
in the event_info
parameter for the
callback function. The same applies for anchor,in
(mouse in),
anchor,out
(mouse out), anchor,down
(mouse down), and anchor,up
(mouse up) events on an anchor.
Items¶
Inlined in the text, any other Object
can
be inserted by using <item>
tags this way:
<item size=16x16 vsize=full href=emoticon/haha></item>
Just like with anchors, the href
identifies each item, but these need,
in addition, to indicate their size, which is done using any one of
size
, absize
or relsize
attributes. These attributes take their
value in the WxH format, where W is the width and H the height of the
item.
absize: Absolute pixel size for the item. Whatever value is set will be the item’s size regardless of any scale value the object may have been set to. The final line height will be adjusted to fit larger items.
size: Similar to absize, but it’s adjusted to the scale value set for the object.
relsize: Size is adjusted for the item to fit within the current line height.
Besides their size, items are specified a vsize
value that affects
how their final size and position are calculated. The possible values
are:
ascent
: Item will be placed within the line’s baseline and its ascent. That is, the height between the line where all characters are positioned and the highest point in the line. Forsize
andabsize
items, the descent value will be added to the total line height to make them fit.relsize
items will be adjusted to fit within this space.full
: Items will be placed between the descent and ascent, or the lowest point in the line and its highest.
After the size for an item is calculated, the entry will request an object to
place in its space. For this, the functions set with
item_provider_append()
and related
functions will be called in order until one of them returns a non-None value.
If no providers are available, or all of them return None, then the entry
falls back to one of the internal defaults, provided the name matches with one
of them.
All of the following are currently supported:
emoticon/angry
emoticon/angry-shout
emoticon/crazy-laugh
emoticon/evil-laugh
emoticon/evil
emoticon/goggle-smile
emoticon/grumpy
emoticon/grumpy-smile
emoticon/guilty
emoticon/guilty-smile
emoticon/haha
emoticon/half-smile
emoticon/happy-panting
emoticon/happy
emoticon/indifferent
emoticon/kiss
emoticon/knowing-grin
emoticon/laugh
emoticon/little-bit-sorry
emoticon/love-lots
emoticon/love
emoticon/minimal-smile
emoticon/not-happy
emoticon/not-impressed
emoticon/omg
emoticon/opensmile
emoticon/smile
emoticon/sorry
emoticon/squint-laugh
emoticon/surprised
emoticon/suspicious
emoticon/tongue-dangling
emoticon/tongue-poke
emoticon/uh
emoticon/unhappy
emoticon/very-sorry
emoticon/what
emoticon/wink
emoticon/worried
emoticon/wtf
Alternatively, an item may reference an image by its path, using
the URI form file:///path/to/an/image.png
and the entry will then
use that image for the item.
Setting entry’s style¶
There are 2 major ways to change the entry’s style:
Theme - set the “base” field to the desired style.
User style - Pushing overrides to the theme style to the textblock object by using
text_style_user_push()
.
You should modify the theme when you would like to change the style for aesthetic reasons. While the user style should be changed when you would like to change the style to something specific defined at run-time, e.g, setting font or font size in a text editor.
Loading and saving files¶
Entries have convenience functions to load text from a file and save changes
back to it after a short delay. The automatic saving is enabled by default, but
can be disabled with autosave
and files
can be loaded directly as plain text or have any markup in them recognized. See
file
for more details.
Emitted signals¶
changed
: The text within the entry was changed.changed,user
: The text within the entry was changed because of user interaction.activated
: The enter key was pressed on a single line entry.aborted
: The escape key was pressed on a single line entry. (since 1.7)press
: A mouse button has been pressed on the entry.longpressed
: A mouse button has been pressed and held for a couple seconds.clicked
: The entry has been clicked (mouse press and release).clicked,double
: The entry has been double clicked.clicked,triple
: The entry has been triple clicked.selection,paste
: A paste of the clipboard contents was requested.selection,copy
: A copy of the selected text into the clipboard was requested.selection,cut
: A cut of the selected text into the clipboard was requested.selection,start
: A selection has begun and no previous selection existed.selection,changed
: The current selection has changed.selection,cleared
: The current selection has been cleared.cursor,changed
: The cursor has changed position.anchor,clicked
: An anchor has been clicked. The event_info parameter for the callback will be anEntryAnchorInfo
.anchor,in
: Mouse cursor has moved into an anchor. The event_info parameter for the callback will be anEntryAnchorInfo
.anchor,out
: Mouse cursor has moved out of an anchor. The event_info parameter for the callback will be anEntryAnchorInfo
.anchor,up
: Mouse button has been unpressed on an anchor. The event_info parameter for the callback will be anEntryAnchorInfo
.anchor,down
: Mouse button has been pressed on an anchor. The event_info parameter for the callback will be anEntryAnchorInfo
.preedit,changed
: The preedit string has changed.text,set,done
: Whole text has been set to the entry.rejected
: .Called when some of inputs are rejected by the filter. (since 1.9)
Layout content parts¶
icon
- An icon in the entryend
- A content in the end of the entry
Layout text parts¶
default
- text of the entryguide
- placeholder of the entry
Enumerations¶
Autocapitalization types¶
- efl.elementary.ELM_AUTOCAPITAL_TYPE_NONE¶
No auto-capitalization when typing
- efl.elementary.ELM_AUTOCAPITAL_TYPE_WORD¶
Autocapitalize each word typed
- efl.elementary.ELM_AUTOCAPITAL_TYPE_SENTENCE¶
Autocapitalize the start of each sentence
- efl.elementary.ELM_AUTOCAPITAL_TYPE_ALLCHARACTER¶
Autocapitalize all letters
Copy & paste modes¶
- efl.elementary.ELM_CNP_MODE_MARKUP¶
Copy & paste text with markup tags
- efl.elementary.ELM_CNP_MODE_NO_IMAGE¶
Copy & paste text without item (image) tags
- efl.elementary.ELM_CNP_MODE_PLAINTEXT¶
Copy & paste text without markup tags
Input Hints¶
- efl.elementary.ELM_INPUT_HINT_NONE¶
No active hints
Added in version 1.12.
- efl.elementary.ELM_INPUT_HINT_AUTO_COMPLETE¶
Suggest word auto completion
Added in version 1.12.
- efl.elementary.ELM_INPUT_HINT_SENSITIVE_DATA¶
typed text should not be stored
Added in version 1.12.
Input panel language sort order¶
- efl.elementary.ELM_INPUT_PANEL_LANG_AUTOMATIC¶
Automatic
- efl.elementary.ELM_INPUT_PANEL_LANG_ALPHABET¶
Alphabetic
Input panel layouts¶
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_NORMAL¶
Default layout
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_NUMBER¶
Number layout
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_EMAIL¶
Email layout
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_URL¶
URL layout
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_PHONENUMBER¶
Phone number layout
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_IP¶
IP layout
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_MONTH¶
Month layout
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_NUMBERONLY¶
Number only layout
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_INVALID¶
Never use this
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_HEX¶
Hexadecimal layout
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_TERMINAL¶
Command-line terminal layout
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_PASSWORD¶
Like normal, but no auto-correct, no auto-capitalization etc.
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_DATETIME¶
Date and time layout
Added in version 1.10.
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_EMOTICON¶
Emoticon layout
Added in version 1.10.
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_VOICE¶
Voice layout, but if the IME does not support voice, then normal layout will be shown
Added in version 1.19.
Input panel normal layout variation¶
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_NORMAL¶
The plain normal layout
Added in version 1.12.
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_FILENAME¶
Filename layout. Symbols such as ‘/’ should be disabled
Added in version 1.12.
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_PERSON_NAME¶
The name of a person
Added in version 1.12.
Input panel numberonly layout variation¶
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_NORMAL¶
The numberonly normal layout
Added in version 1.12.
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_SIGNED¶
The signed number layout
Added in version 1.12.
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_DECIMAL¶
The decimal number layout
Added in version 1.12.
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_SIGNED_AND_DECIMAL¶
The signed and decimal number layout
Added in version 1.12.
Input panel password layout variation¶
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NORMAL¶
The normal password layout
Added in version 1.12.
- efl.elementary.ELM_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NUMBERONLY¶
The password layout to allow only number
Added in version 1.12.
Input panel return key modes¶
- efl.elementary.ELM_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT¶
Default
- efl.elementary.ELM_INPUT_PANEL_RETURN_KEY_TYPE_DONE¶
Done
- efl.elementary.ELM_INPUT_PANEL_RETURN_KEY_TYPE_GO¶
Go
- efl.elementary.ELM_INPUT_PANEL_RETURN_KEY_TYPE_JOIN¶
Join
- efl.elementary.ELM_INPUT_PANEL_RETURN_KEY_TYPE_LOGIN¶
Login
- efl.elementary.ELM_INPUT_PANEL_RETURN_KEY_TYPE_NEXT¶
Next
- efl.elementary.ELM_INPUT_PANEL_RETURN_KEY_TYPE_SEARCH¶
Search
- efl.elementary.ELM_INPUT_PANEL_RETURN_KEY_TYPE_SEND¶
Send
- efl.elementary.ELM_INPUT_PANEL_RETURN_KEY_TYPE_SIGNIN¶
Sign-in
Added in version 1.10.
Text format¶
- efl.elementary.ELM_TEXT_FORMAT_PLAIN_UTF8¶
Plain UTF-8 type
- efl.elementary.ELM_TEXT_FORMAT_MARKUP_UTF8¶
UTF-8 with markup
Wrap mode¶
- efl.elementary.ELM_WRAP_NONE¶
No wrap
- efl.elementary.ELM_WRAP_CHAR¶
Wrap between characters
- efl.elementary.ELM_WRAP_WORD¶
Wrap in allowed wrapping points (as defined in the unicode standard)
- efl.elementary.ELM_WRAP_MIXED¶
Word wrap, and if that fails, char wrap