Creates a #GtkSearchEntry, with a find icon when the search field is empty, and a clear icon when it isn't.
Connect to NextMatch signal.
Connect to PreviousMatch signal.
Connect to SearchChanged signal.
Connect to StopSearch signal.
This function should be called when the top-level window which contains the search entry received a key event. If the entry is part of a #GtkSearchBar, it is preferable to call gtk.search_bar.SearchBar.handleEvent instead, which will reveal the entry in addition to passing the event to this function.
Returns this, for use in with statements.
Get builder for gtk.search_entry.SearchEntry
Returns this, for use in with statements.
Get builder for gtk.entry.Entry
Get attributes property.
Set attributes property.
Get capsLockWarning property.
Set capsLockWarning property.
Get completion property.
Set completion property.
Get imModule property.
Set imModule property.
Get innerBorder property.
Set innerBorder property.
Get inputHints property.
Set inputHints property.
Get inputPurpose property.
Set inputPurpose property.
Get invisibleChar property.
Set invisibleChar property.
Get invisibleCharSet property.
Set invisibleCharSet property.
Get maxWidthChars property.
Set maxWidthChars property.
Get overwriteMode property.
Set overwriteMode property.
Get placeholderText property.
Set placeholderText property.
Get populateAll property.
Set populateAll property.
Get primaryIconActivatable property.
Set primaryIconActivatable property.
Get primaryIconGicon property.
Set primaryIconGicon property.
Get primaryIconName property.
Set primaryIconName property.
Get primaryIconPixbuf property.
Set primaryIconPixbuf property.
Get primaryIconSensitive property.
Set primaryIconSensitive property.
Get primaryIconStock property.
Set primaryIconStock property.
Get primaryIconStorageType property.
Get primaryIconTooltipMarkup property.
Set primaryIconTooltipMarkup property.
Get primaryIconTooltipText property.
Set primaryIconTooltipText property.
Get progressFraction property.
Set progressFraction property.
Get progressPulseStep property.
Set progressPulseStep property.
Get secondaryIconActivatable property.
Set secondaryIconActivatable property.
Get secondaryIconGicon property.
Set secondaryIconGicon property.
Get secondaryIconName property.
Set secondaryIconName property.
Get secondaryIconPixbuf property.
Set secondaryIconPixbuf property.
Get secondaryIconSensitive property.
Set secondaryIconSensitive property.
Get secondaryIconStock property.
Set secondaryIconStock property.
Get secondaryIconStorageType property.
Get secondaryIconTooltipMarkup property.
Set secondaryIconTooltipMarkup property.
Get secondaryIconTooltipText property.
Set secondaryIconTooltipText property.
Get shadowType property.
Set shadowType property.
Get textLength property.
Get truncateMultiline property.
Set truncateMultiline property.
Get xalign property.
Set xalign property.
Creates a new entry with the specified text buffer.
Retrieves the value set by gtk.entry.Entry.setActivatesDefault.
Gets the value set by gtk.entry.Entry.setAlignment.
Gets the attribute list that was set on the entry using gtk.entry.Entry.setAttributes, if any.
Get the #GtkEntryBuffer object which holds the text for this widget.
Returns the auxiliary completion object currently in use by entry.
Returns the index of the icon which is the source of the current DND operation, or -1.
Retrieves the horizontal cursor adjustment for the entry. See gtk.entry.Entry.setCursorHadjustment.
Gets the value set by gtk.entry.Entry.setHasFrame.
Returns whether the icon is activatable.
Gets the area where entry’s icon at icon_pos is drawn. This function is useful when drawing something to the entry in a draw callback.
Finds the icon at the given position and return its index. The position’s coordinates are relative to the entry’s top left corner. If x, y doesn’t lie inside an icon, -1 is returned. This function is intended for use in a #GtkWidget::query-tooltip signal handler.
Retrieves the #GIcon used for the icon, or null if there is no icon or if the icon was set by some other method (e.g., by stock, pixbuf, or icon name).
Retrieves the icon name used for the icon, or null if there is no icon or if the icon was set by some other method (e.g., by pixbuf, stock or gicon).
Retrieves the image used for the icon.
Returns whether the icon appears sensitive or insensitive.
Retrieves the stock id used for the icon, or null if there is no icon or if the icon was set by some other method (e.g., by pixbuf, icon name or gicon).
Gets the type of representation being used by the icon to store image data. If the icon has no image data, the return value will be gtk.types.ImageType.Empty.
Gets the contents of the tooltip on the icon at the specified position in entry.
Gets the contents of the tooltip on the icon at the specified position in entry.
This function returns the entry’s #GtkEntry:inner-border property. See gtk.entry.Entry.setInnerBorder for more information.
Gets the value of the #GtkEntry:input-hints property.
Gets the value of the #GtkEntry:input-purpose property.
Retrieves the character displayed in place of the real characters for entries with visibility set to false. See gtk.entry.Entry.setInvisibleChar.
Gets the #PangoLayout used to display the entry. The layout is useful to e.g. convert text positions to pixel positions, in combination with gtk.entry.Entry.getLayoutOffsets. The returned layout is owned by the entry and must not be modified or freed by the caller.
Obtains the position of the #PangoLayout used to render text in the entry, in widget coordinates. Useful if you want to line up the text in an entry with some other text, e.g. when using the entry to implement editable cells in a sheet widget.
Retrieves the maximum allowed length of the text in entry. See gtk.entry.Entry.setMaxLength.
Retrieves the desired maximum width of entry, in characters. See gtk.entry.Entry.setMaxWidthChars.
Gets the value set by gtk.entry.Entry.setOverwriteMode.
Retrieves the text that will be displayed when entry is empty and unfocused
Returns the current fraction of the task that’s been completed. See gtk.entry.Entry.setProgressFraction.
Retrieves the pulse step set with gtk.entry.Entry.setProgressPulseStep.
Gets the tabstops that were set on the entry using gtk.entry.Entry.setTabs, if any.
Retrieves the contents of the entry widget. See also gtk.editable.Editable.getChars.
Gets the area where the entry’s text is drawn. This function is useful when drawing something to the entry in a draw callback.
Retrieves the current length of the text in entry.
Retrieves whether the text in entry is visible. See gtk.entry.Entry.setVisibility.
Gets the value set by gtk.entry.Entry.setWidthChars.
Causes entry to have keyboard focus.
Allow the #GtkEntry input method to internally handle key press and release events. If this function returns true, then no further processing should be done for this key event. See gtk.imcontext.IMContext.filterKeypress.
Converts from a position in the entry’s #PangoLayout (returned by gtk.entry.Entry.getLayout) to a position in the entry contents (returned by gtk.entry.Entry.getText).
Indicates that some progress is made, but you don’t know how much. Causes the entry’s progress indicator to enter “activity mode,” where a block bounces back and forth. Each call to gtk.entry.Entry.progressPulse causes the block to move by a little bit (the amount of movement per pulse is determined by gtk.entry.Entry.setProgressPulseStep).
Reset the input method context of the entry if needed.
If setting is true, pressing Enter in the entry will activate the default widget for the window containing the entry. This usually means that the dialog box containing the entry will be closed, since the default widget is usually one of the dialog buttons.
Sets the alignment for the contents of the entry. This controls the horizontal positioning of the contents when the displayed text is shorter than the width of the entry.
Sets a #PangoAttrList; the attributes in the list are applied to the entry text.
Set the #GtkEntryBuffer object which holds the text for this widget.
Sets completion to be the auxiliary completion object to use with entry. All further configuration of the completion mechanism is done on completion using the #GtkEntryCompletion API. Completion is disabled if completion is set to null.
Hooks up an adjustment to the cursor position in an entry, so that when the cursor is moved, the adjustment is scrolled to show that position. See gtk.scrolled_window.ScrolledWindow.getHadjustment for a typical way of obtaining the adjustment.
Sets whether the entry has a beveled frame around it.
Sets whether the icon is activatable.
Sets up the icon at the given position so that GTK+ will start a drag operation when the user clicks and drags the icon.
Sets the icon shown in the entry at the specified position from the current icon theme. If the icon isn’t known, a “broken image” icon will be displayed instead.
Sets the icon shown in the entry at the specified position from the current icon theme.
Sets the icon shown in the specified position using a pixbuf.
Sets the icon shown in the entry at the specified position from a stock image.
Sets the sensitivity for the specified icon.
Sets tooltip as the contents of the tooltip for the icon at the specified position. tooltip is assumed to be marked up with the [Pango text markup language]PangoMarkupFormat.
Sets tooltip as the contents of the tooltip for the icon at the specified position.
Sets entry’s inner-border property to border, or clears it if null is passed. The inner-border is the area around the entry’s text, but inside its frame.
Sets the #GtkEntry:input-hints property, which allows input methods to fine-tune their behaviour.
Sets the #GtkEntry:input-purpose property which can be used by on-screen keyboards and other input methods to adjust their behaviour.
Sets the character to use in place of the actual text when gtk.entry.Entry.setVisibility has been called to set text visibility to false. i.e. this is the character used in “password mode” to show the user how many characters have been typed. By default, GTK+ picks the best invisible char available in the current font. If you set the invisible char to 0, then the user will get no feedback at all; there will be no text on the screen as they type.
Sets the maximum allowed length of the contents of the widget. If the current contents are longer than the given length, then they will be truncated to fit.
Sets the desired maximum width in characters of entry.
Sets whether the text is overwritten when typing in the #GtkEntry.
Sets text to be displayed in entry when it is empty and unfocused. This can be used to give a visual hint of the expected contents of the #GtkEntry.
Causes the entry’s progress indicator to “fill in” the given fraction of the bar. The fraction should be between 0.0 and 1.0, inclusive.
Sets the fraction of total entry width to move the progress bouncing block for each call to gtk.entry.Entry.progressPulse.
Sets a #PangoTabArray; the tabstops in the array are applied to the entry text.
Sets the text in the widget to the given value, replacing the current contents.
Sets whether the contents of the entry are visible or not. When visibility is set to false, characters are displayed as the invisible char, and will also appear that way when the text in the entry widget is copied elsewhere.
Changes the size request of the entry to be about the right size for n_chars characters. Note that it changes the size request, the size can still be affected by how you pack the widget into containers. If n_chars is -1, the size reverts to the default entry size.
Converts from a position in the entry contents (returned by gtk.entry.Entry.getText) to a position in the entry’s #PangoLayout (returned by gtk.entry.Entry.getLayout, with text retrieved via pango.layout.Layout.getText).
Unsets the invisible char previously set with gtk.entry.Entry.setInvisibleChar. So that the default invisible char is used again.
Connect to Activate signal.
Connect to Backspace signal.
Connect to CopyClipboard signal.
Connect to CutClipboard signal.
Connect to DeleteFromCursor signal.
Connect to IconPress signal.
Connect to IconRelease signal.
Connect to InsertAtCursor signal.
Connect to InsertEmoji signal.
Connect to MoveCursor signal.
Connect to PasteClipboard signal.
Connect to PopulatePopup signal.
Connect to PreeditChanged signal.
Connect to ToggleOverwrite signal.
#GtkSearchEntry is a subclass of #GtkEntry that has been tailored for use as a search entry.
It will show an inactive symbolic “find” icon when the search entry is empty, and a symbolic “clear” icon when there is text. Clicking on the “clear” icon will empty the search entry.
Note that the search/clear icon is shown using a secondary icon, and thus does not work if you are using the secondary icon position for some other purpose.
To make filtering appear more reactive, it is a good idea to not react to every change in the entry text immediately, but only after a short delay. To support this, #GtkSearchEntry emits the #GtkSearchEntry::search-changed signal which can be used instead of the #GtkEditable::changed signal.
The #GtkSearchEntry::previous-match, #GtkSearchEntry::next-match and #GtkSearchEntry::stop-search signals can be used to implement moving between search results and ending the search.
Often, GtkSearchEntry will be fed events by means of being placed inside a #GtkSearchBar. If that is not the case, you can use gtk.search_entry.SearchEntry.handleEvent to pass events.