// Generated by gmmproc 2.82.0 -- DO NOT MODIFY! #ifndef _GTKMM_ENTRY_H #define _GTKMM_ENTRY_H #include #include /* * Copyright (C) 1998-2002 The gtkmm Development Team * * This library 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; either * version 2.1 of the License, or (at your option) any later version. * * This library 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 library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #include #include #include #include #include //For Image::Type. #include #include #include #include #include #ifndef DOXYGEN_SHOULD_SKIP_THIS using GtkEntry = struct _GtkEntry; using GtkEntryClass = struct _GtkEntryClass; #endif /* DOXYGEN_SHOULD_SKIP_THIS */ #ifndef DOXYGEN_SHOULD_SKIP_THIS namespace Gtk { class GTKMM_API Entry_Class; } // namespace Gtk #endif //DOXYGEN_SHOULD_SKIP_THIS namespace Gtk { /** A single line text entry field. * * The Gtk::Entry widget is a single line text entry widget. A fairly large * set of key bindings are supported by default. If the entered text is * longer than the allocation of the widget, the widget will scroll so that * the cursor position is visible. * * The Entry widget looks like this: * @image html entry1.png * * @ingroup Widgets */ class GTKMM_API Entry : public Widget, public Editable, public CellEditable { public: #ifndef DOXYGEN_SHOULD_SKIP_THIS typedef Entry CppObjectType; typedef Entry_Class CppClassType; typedef GtkEntry BaseObjectType; typedef GtkEntryClass BaseClassType; #endif /* DOXYGEN_SHOULD_SKIP_THIS */ Entry(Entry&& src) noexcept; Entry& operator=(Entry&& src) noexcept; // noncopyable Entry(const Entry&) = delete; Entry& operator=(const Entry&) = delete; ~Entry() noexcept override; #ifndef DOXYGEN_SHOULD_SKIP_THIS private: friend GTKMM_API class Entry_Class; static CppClassType entry_class_; protected: explicit Entry(const Glib::ConstructParams& construct_params); explicit Entry(GtkEntry* castitem); #endif /* DOXYGEN_SHOULD_SKIP_THIS */ public: /** Get the GType for this class, for use with the underlying GObject type system. */ static GType get_type() G_GNUC_CONST; #ifndef DOXYGEN_SHOULD_SKIP_THIS static GType get_base_type() G_GNUC_CONST; #endif /// Provides access to the underlying C GObject. GtkEntry* gobj() { return reinterpret_cast(gobject_); } /// Provides access to the underlying C GObject. const GtkEntry* gobj() const { return reinterpret_cast(gobject_); } private: public: /** @addtogroup gtkmmEnums gtkmm Enums and Flags */ /** * @var IconPosition::PRIMARY * At the beginning of the entry (depending on the text direction). * * @var IconPosition::SECONDARY * At the end of the entry (depending on the text direction). */ /** Specifies the side of the entry at which an icon is placed. * * @ingroup gtkmmEnums */ enum class IconPosition { PRIMARY, SECONDARY }; Entry(); explicit Entry(const Glib::RefPtr& buffer); /** Get the `Gtk::EntryBuffer` object which holds the text for * this widget. * * @return A `Gtk::EntryBuffer` object. */ Glib::RefPtr get_buffer(); /** Get the `Gtk::EntryBuffer` object which holds the text for * this widget. * * @return A `Gtk::EntryBuffer` object. */ Glib::RefPtr get_buffer() const; /** Set the `Gtk::EntryBuffer` object which holds the text for * this widget. * * @param buffer A `Gtk::EntryBuffer`. */ void set_buffer(const Glib::RefPtr& buffer); /** 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. * * By default, GTK picks the best invisible character available * in the current font, but it can be changed with * set_invisible_char(). * * Note that you probably want to set property_input_purpose() * to Gtk::InputPurpose::PASSWORD or Gtk::InputPurpose::PIN to * inform input methods about the purpose of this entry, * in addition to setting visibility to false. * * @param visible true if the contents of the entry are displayed as plaintext. */ void set_visibility(bool visible = true); /** Retrieves whether the text in @a entry is visible. * * See set_visibility(). * * @return true if the text is currently visible. */ bool get_visibility() const; /** Sets the character to use in place of the actual text * in “password mode”. * * See set_visibility() for how to enable * “password mode”. * * 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. * * @param ch A Unicode character. */ void set_invisible_char(gunichar ch); /** Unsets the invisible char, so that the default invisible char * is used again. See set_invisible_char(). */ void unset_invisible_char(); /** Retrieves the character displayed in place of the actual text * in “password mode”. * * @return The current invisible char, or 0, if the entry does not * show invisible text at all. */ gunichar get_invisible_char() const; /** Sets whether the entry has a beveled frame around it. * * @param setting New value. */ void set_has_frame(bool setting = true); /** Gets the value set by set_has_frame(). * * @return Whether the entry has a beveled frame. */ bool get_has_frame() const; /** Sets whether the text is overwritten when typing in the `Gtk::Entry`. * * @param overwrite New value. */ void set_overwrite_mode(bool overwrite = true); /** Gets whether the `Gtk::Entry` is in overwrite mode. * * @return Whether the text is overwritten when typing. */ bool get_overwrite_mode() const; /** 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. The length is in characters. * * This is equivalent to getting @a entry's `Gtk::EntryBuffer` and * calling Gtk::EntryBuffer::set_max_length() on it. * * @param max The maximum length of the entry, or 0 for no maximum. * (other than the maximum length of entries.) The value passed in will * be clamped to the range 0-65536. */ void set_max_length(int max); /** Retrieves the maximum allowed length of the text in @a entry. * * See set_max_length(). * * @return The maximum allowed number of characters * in `Gtk::Entry`, or 0 if there is no maximum. */ int get_max_length() const; /** Retrieves the current length of the text in @a entry. * * This is equivalent to getting @a entry's `Gtk::EntryBuffer` * and calling Gtk::EntryBuffer::get_length() on it. * * @return The current number of characters * in `Gtk::Entry`, or 0 if there are none. */ guint16 get_text_length() const; /** Sets whether pressing Enter in the @a entry will activate the default * widget for the window containing the entry. * * This usually means that the dialog containing the entry will be closed, * since the default widget is usually one of the dialog buttons. * * @param setting true to activate window’s default widget on Enter keypress. */ void set_activates_default(bool setting = true); /** Retrieves the value set by set_activates_default(). * * @return true if the entry will activate the default widget. */ gboolean get_activates_default() const; /** 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. * * See also: Gtk::Editable::property_xalign() * * @param xalign The horizontal alignment, from 0 (left) to 1 (right). * Reversed for RTL layouts. */ void set_alignment(float xalign); /** 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. * * See also: Gtk::Editable::property_xalign() * * @param xalign The horizontal alignment, from 0 (left) to 1 (right). * Reversed for RTL layouts. */ void set_alignment(Align xalign); /** Gets the value set by set_alignment(). * * See also: Gtk::Editable::property_xalign() * * @return The alignment. */ float get_alignment() const; #ifndef GTKMM_DISABLE_DEPRECATED /** Sets @a completion to be the auxiliary completion object * to use with @a entry. * * All further configuration of the completion mechanism is * done on @a completion using the `Gtk::EntryCompletion` API. * Completion is disabled if @a completion is set to nullptr. * * Deprecated: 4.10: GtkEntryCompletion will be removed in GTK 5. * * @deprecated GtkEntryCompletion will be removed in GTK 5. * * @param completion The `Gtk::EntryCompletion`. */ void set_completion(const Glib::RefPtr& completion); #endif // GTKMM_DISABLE_DEPRECATED #ifndef GTKMM_DISABLE_DEPRECATED /** Returns the auxiliary completion object currently * in use by @a entry. * * Deprecated: 4.10: GtkEntryCompletion will be removed in GTK 5. * * @deprecated GtkEntryCompletion will be removed in GTK 5. * * @return The auxiliary * completion object currently in use by @a entry. */ Glib::RefPtr get_completion(); #endif // GTKMM_DISABLE_DEPRECATED #ifndef GTKMM_DISABLE_DEPRECATED /** Returns the auxiliary completion object currently * in use by @a entry. * * Deprecated: 4.10: GtkEntryCompletion will be removed in GTK 5. * * @deprecated GtkEntryCompletion will be removed in GTK 5. * * @return The auxiliary * completion object currently in use by @a entry. */ Glib::RefPtr get_completion() const; #endif // GTKMM_DISABLE_DEPRECATED /** 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. * * @param fraction Fraction of the task that’s been completed. */ void set_progress_fraction(double fraction); /** Returns the current fraction of the task that’s been completed. * * See set_progress_fraction(). * * @return A fraction from 0.0 to 1.0. */ double get_progress_fraction() const; /** Sets the fraction of total entry width to move the progress * bouncing block for each pulse. * * Use progress_pulse() to pulse * the progress. * * @param fraction Fraction between 0.0 and 1.0. */ void set_progress_pulse_step(double fraction); /** Retrieves the pulse step set with * set_progress_pulse_step(). * * @return A fraction from 0.0 to 1.0. */ double get_progress_pulse_step(); /** 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 * progress_pulse() causes the block to move by a * little bit (the amount of movement per pulse is determined * by set_progress_pulse_step()). */ void progress_pulse(); /** Retrieves the text that will be displayed when @a entry * is empty and unfocused * * @return A pointer to the * placeholder text as a string. This string points to * internally allocated storage in the widget and must * not be freed, modified or stored. If no placeholder * text has been set, nullptr will be returned. */ Glib::ustring get_placeholder_text() const; /** Sets text to be displayed in @a entry when it is empty. * * This can be used to give a visual hint of the expected * contents of the `Gtk::Entry`. * * @param text A string to be displayed when @a entry is empty and unfocused. */ void set_placeholder_text(const Glib::ustring& text); /** Sets the icon shown in the specified position using a `Gdk::Paintable`. * * If @a paintable is nullptr, no icon will be shown in the specified position. * * @param icon_pos Icon position. * @param paintable A `Gdk::Paintable`. */ void set_icon_from_paintable(const Glib::RefPtr& paintable, IconPosition icon_pos = IconPosition::PRIMARY); /** Sets the icon shown in the entry at the specified position * from the current icon theme. * * If the icon name isn’t known, a “broken image” icon will be * displayed instead. * * If @a icon_name is nullptr, no icon will be shown in the * specified position. * * @param icon_pos The position at which to set the icon. * @param icon_name An icon name. */ void set_icon_from_icon_name(const Glib::ustring& icon_name, IconPosition icon_pos = IconPosition::PRIMARY); /** 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. * * If @a icon is nullptr, no icon will be shown in the * specified position. * * @param icon_pos The position at which to set the icon. * @param icon The icon to set. */ void set_icon_from_gicon(const Glib::RefPtr& icon, IconPosition icon_pos = IconPosition::PRIMARY); /** Do not show any icon in the specified position. * See set_icon_from_paintable(), set_icon_from_icon_name(), and set_icon_from_gicon(). * * @param icon_pos The icon position. * * @newin{3,0} */ void unset_icon(IconPosition icon_pos = IconPosition::PRIMARY); /** 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::Image::Type::EMPTY. * * @param icon_pos Icon position. * @return Image representation being used. */ Image::Type get_icon_storage_type(IconPosition icon_pos = IconPosition::PRIMARY) const; /** Retrieves the `Gdk::Paintable` used for the icon. * * If no `Gdk::Paintable` was used for the icon, nullptr is returned. * * @param icon_pos Icon position. * @return A `Gdk::Paintable` * if no icon is set for this position or the icon set is not * a `Gdk::Paintable`. */ Glib::RefPtr get_icon_paintable(IconPosition icon_pos = IconPosition::PRIMARY); /** Retrieves the `Gdk::Paintable` used for the icon. * * If no `Gdk::Paintable` was used for the icon, nullptr is returned. * * @param icon_pos Icon position. * @return A `Gdk::Paintable` * if no icon is set for this position or the icon set is not * a `Gdk::Paintable`. */ Glib::RefPtr get_icon_paintable(IconPosition icon_pos = IconPosition::PRIMARY) const; /** Retrieves the icon name used for the icon. * * nullptr is returned if there is no icon or if the icon was set * by some other method (e.g., by `Gdk::Paintable` or gicon). * * @param icon_pos Icon position. * @return An icon name. */ Glib::ustring get_icon_name(IconPosition icon_pos = IconPosition::PRIMARY) const; /** Retrieves the `Gio::Icon` used for the icon. * * nullptr will be returned if there is no icon or if the icon was * set by some other method (e.g., by `Gdk::Paintable` or icon name). * * @param icon_pos Icon position. * @return A `Gio::Icon`. */ Glib::RefPtr get_icon_gicon(IconPosition icon_pos = IconPosition::PRIMARY); /** Retrieves the `Gio::Icon` used for the icon. * * nullptr will be returned if there is no icon or if the icon was * set by some other method (e.g., by `Gdk::Paintable` or icon name). * * @param icon_pos Icon position. * @return A `Gio::Icon`. */ Glib::RefPtr get_icon_gicon(IconPosition icon_pos = IconPosition::PRIMARY) const; /** Sets whether the icon is activatable. * * @param icon_pos Icon position. * @param activatable true if the icon should be activatable. */ void set_icon_activatable(bool activatable = true, IconPosition icon_pos = IconPosition::PRIMARY); /** Returns whether the icon is activatable. * * @param icon_pos Icon position. * @return true if the icon is activatable. */ bool get_icon_activatable(IconPosition icon_pos = IconPosition::PRIMARY) const; /** Sets the sensitivity for the specified icon. * * @param icon_pos Icon position. * @param sensitive Specifies whether the icon should appear * sensitive or insensitive. */ void set_icon_sensitive(IconPosition icon_pos = IconPosition::PRIMARY, bool sensitive = true); /** Returns whether the icon appears sensitive or insensitive. * * @param icon_pos Icon position. * @return true if the icon is sensitive. */ bool get_icon_sensitive(IconPosition icon_pos = IconPosition::PRIMARY); /** Finds the icon at the given position and return its index. * * The position’s coordinates are relative to the @a entry’s * top left corner. If @a x, @a y doesn’t lie inside an icon, * -1 is returned. This function is intended for use in a * Gtk::Widget::signal_query_tooltip() signal handler. * * @param x The x coordinate of the position to find, relative to @a entry. * @param y The y coordinate of the position to find, relative to @a entry. * @return The index of the icon at the given position, or -1. */ int get_icon_at_pos(int x, int y) const; /** Sets @a tooltip as the contents of the tooltip for the icon * at the specified position. * * Use nullptr for @a tooltip to remove an existing tooltip. * * See also Gtk::Widget::set_tooltip_text() and * set_icon_tooltip_markup(). * * If you unset the widget tooltip via * Gtk::Widget::set_tooltip_text() or * Gtk::Widget::set_tooltip_markup(), this sets * Gtk::Widget::property_has_tooltip() to false, which suppresses * icon tooltips too. You can resolve this by then calling * Gtk::Widget::set_has_tooltip() to set * Gtk::Widget::property_has_tooltip() back to true, or * setting at least one non-empty tooltip on any icon * achieves the same result. * * @param icon_pos The icon position. * @param tooltip The contents of the tooltip for the icon. */ void set_icon_tooltip_text(const Glib::ustring& tooltip, IconPosition icon_pos = IconPosition::PRIMARY); /** Gets the contents of the tooltip on the icon at the specified * position in @a entry. * * @param icon_pos The icon position. * @return The tooltip text. */ Glib::ustring get_icon_tooltip_text(IconPosition icon_pos = IconPosition::PRIMARY) const; /** Sets @a tooltip as the contents of the tooltip for the icon at * the specified position. * * @a tooltip is assumed to be marked up with Pango Markup. * * Use nullptr for @a tooltip to remove an existing tooltip. * * See also Gtk::Widget::set_tooltip_markup() and * set_icon_tooltip_text(). * * @param icon_pos The icon position. * @param tooltip The contents of the tooltip for the icon. */ void set_icon_tooltip_markup(const Glib::ustring& tooltip, IconPosition icon_pos = IconPosition::PRIMARY); /** Gets the contents of the tooltip on the icon at the specified * position in @a entry. * * @param icon_pos The icon position. * @return The tooltip text. */ Glib::ustring get_icon_tooltip_markup(IconPosition icon_pos = IconPosition::PRIMARY) const; /** Sets up the icon at the given position as drag source. * * This makes it so that GTK will start a drag * operation when the user clicks and drags the icon. * * @param icon_pos Icon position. * @param provider A `Gdk::ContentProvider`. * @param actions A bitmask of the allowed drag actions. */ void set_icon_drag_source(const Glib::RefPtr& provider, Gdk::DragAction actions = Gdk::DragAction::COPY, IconPosition icon_pos = IconPosition::PRIMARY); /** Returns the area where entry's icon at @a icon_pos is drawn. * This function is useful when drawing something to the * entry in a draw callback. * * @param icon_pos Icon position. * @result The location for the icon area. * * @newin{3,0} */ Gdk::Rectangle get_icon_area(IconPosition icon_pos = IconPosition::PRIMARY) const; /** Returns the index of the icon which is the source of the * current DND operation, or -1. * * @return Index of the icon which is the source of the * current DND operation, or -1. */ int get_current_icon_drag_source(); /** Reset the input method context of the entry if needed. * * This can be necessary in the case where modifying the buffer * would confuse on-going input method behavior. */ void reset_im_context(); /** Sets the input purpose which can be used by input methods * to adjust their behavior. * * @param purpose The purpose. */ void set_input_purpose(InputPurpose purpose); /** Gets the input purpose of the `Gtk::Entry`. * * @return The input purpose. */ InputPurpose get_input_purpose() const; /** Set additional hints which allow input methods to * fine-tune their behavior. * * @param hints The hints. */ void set_input_hints(InputHints hints); /** Gets the input hints of this `Gtk::Entry`. * * @return The input hints. */ InputHints get_input_hints() const; /** Sets a `Pango::AttrList`. * * The attributes in the list are applied to the entry text. * * Since the attributes will be applied to text that changes * as the user types, it makes most sense to use attributes * with unlimited extent. * * @param attrs A `Pango::AttrList`. */ void set_attributes(Pango::AttrList& attrs); /** Gets the attribute list of the `Gtk::Entry`. * * See set_attributes(). * * @return The attribute list. */ Pango::AttrList get_attributes() const; /** Sets a `Pango::TabArray`. * * The tabstops in the array are applied to the entry text. * * @param tabs A `Pango::TabArray`. */ void set_tabs(const Pango::TabArray& tabs); /** Gets the tabstops of the `Gtk::Entry`. * * See set_tabs(). * * @return The tabstops. */ Pango::TabArray get_tabs() const; /** Causes @a entry to have keyboard focus. * * It behaves like Gtk::Widget::grab_focus(), except that it doesn't * select the contents of the entry. You only want to call this on some * special entries which the user usually doesn't want to replace all text * in, such as search-as-you-type entries. */ void grab_focus_without_selecting(); /** Sets a menu model to add when constructing * the context menu for @a entry. * * @param model A `Gio::MenuModel`. */ void set_extra_menu(const Glib::RefPtr& model); /** Gets the menu model set with set_extra_menu(). * * @return The menu model. */ Glib::RefPtr get_extra_menu(); /** Gets the menu model set with set_extra_menu(). * * @return The menu model. */ Glib::RefPtr get_extra_menu() const; //TODO: Remove no_default_handler on "activate" when we can break ABI. // "activate" is an action signal. Nevertheless it can be used by applications. // https://gitlab.gnome.org/GNOME/gtk/-/issues/4848 // https://gitlab.gnome.org/GNOME/gtkmm/-/issues/100 /** * @par Slot Prototype: * void on_my_%activate() * * Flags: Run Last, Action * * Emitted when the entry is activated. * * The keybindings for this signal are all forms of the Enter key. * * @newin{4,8} */ Glib::SignalProxy signal_activate(); // no_default_handler because the wrapped C signals have no default handlers. /** * @par Slot Prototype: * void on_my_%icon_release(IconPosition icon_position) * * Flags: Run Last * * Emitted on the button release from a mouse click * over an activatable icon. * * @param icon_position The position of the clicked icon. */ Glib::SignalProxy signal_icon_release(); /** * @par Slot Prototype: * void on_my_%icon_press(IconPosition icon_position) * * Flags: Run Last * * Emitted when an activatable icon is clicked. * * @param icon_position The position of the clicked icon. */ Glib::SignalProxy signal_icon_press(); /** The buffer object which actually stores the text. * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Glib::RefPtr > property_buffer() ; /** The buffer object which actually stores the text. * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Glib::RefPtr > property_buffer() const; /** Maximum number of characters for this entry. * * Default value: 0 * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< int > property_max_length() ; /** Maximum number of characters for this entry. * * Default value: 0 * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< int > property_max_length() const; /** Whether the entry should show the “invisible char” instead of the * actual text (“password mode”). * * Default value: true * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_visibility() ; /** Whether the entry should show the “invisible char” instead of the * actual text (“password mode”). * * Default value: true * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_visibility() const; /** Whether the entry should draw a frame. * * Default value: true * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_has_frame() ; /** Whether the entry should draw a frame. * * Default value: true * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_has_frame() const; /** The character to use when masking entry contents (“password mode”). * * Default value: 42 * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< gunichar > property_invisible_char() ; /** The character to use when masking entry contents (“password mode”). * * Default value: 42 * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< gunichar > property_invisible_char() const; /** Whether the invisible char has been set for the `Gtk::Entry`. * * Default value: false * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_invisible_char_set() ; /** Whether the invisible char has been set for the `Gtk::Entry`. * * Default value: false * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_invisible_char_set() const; /** Whether to activate the default widget when Enter is pressed. * * Default value: false * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_activates_default() ; /** Whether to activate the default widget when Enter is pressed. * * Default value: false * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_activates_default() const; /** Number of pixels of the entry scrolled off the screen to the left. * * Default value: 0 * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< int > property_scroll_offset() const; /** When true, pasted multi-line text is truncated to the first line. * * Default value: false * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_truncate_multiline() ; /** When true, pasted multi-line text is truncated to the first line. * * Default value: false * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_truncate_multiline() const; /** If text is overwritten when typing in the `Gtk::Entry`. * * Default value: false * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_overwrite_mode() ; /** If text is overwritten when typing in the `Gtk::Entry`. * * Default value: false * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_overwrite_mode() const; /** The length of the text in the `Gtk::Entry`. * * Default value: 0 * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< guint > property_text_length() const; /** The current fraction of the task that's been completed. * * Default value: 0 * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< double > property_progress_fraction() ; /** The current fraction of the task that's been completed. * * Default value: 0 * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< double > property_progress_fraction() const; /** The fraction of total entry width to move the progress * bouncing block for each pulse. * * See Gtk::Entry::progress_pulse(). * * Default value: 0 * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< double > property_progress_pulse_step() ; /** The fraction of total entry width to move the progress * bouncing block for each pulse. * * See Gtk::Entry::progress_pulse(). * * Default value: 0 * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< double > property_progress_pulse_step() const; /** A `Gdk::Paintable` to use as the primary icon for the entry. * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Glib::RefPtr > property_primary_icon_paintable() ; /** A `Gdk::Paintable` to use as the primary icon for the entry. * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Glib::RefPtr > property_primary_icon_paintable() const; /** A `Gdk::Paintable` to use as the secondary icon for the entry. * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Glib::RefPtr > property_secondary_icon_paintable() ; /** A `Gdk::Paintable` to use as the secondary icon for the entry. * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Glib::RefPtr > property_secondary_icon_paintable() const; /** The icon name to use for the primary icon for the entry. * * Default value: "" * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Glib::ustring > property_primary_icon_name() ; /** The icon name to use for the primary icon for the entry. * * Default value: "" * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Glib::ustring > property_primary_icon_name() const; /** The icon name to use for the secondary icon for the entry. * * Default value: "" * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Glib::ustring > property_secondary_icon_name() ; /** The icon name to use for the secondary icon for the entry. * * Default value: "" * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Glib::ustring > property_secondary_icon_name() const; /** The `Gio::Icon` to use for the primary icon for the entry. * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Glib::RefPtr > property_primary_icon_gicon() ; /** The `Gio::Icon` to use for the primary icon for the entry. * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Glib::RefPtr > property_primary_icon_gicon() const; /** The `Gio::Icon` to use for the secondary icon for the entry. * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Glib::RefPtr > property_secondary_icon_gicon() ; /** The `Gio::Icon` to use for the secondary icon for the entry. * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Glib::RefPtr > property_secondary_icon_gicon() const; /** The representation which is used for the primary icon of the entry. * * Default value: Gtk::Image::Type::EMPTY * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Image::Type > property_primary_icon_storage_type() const; /** The representation which is used for the secondary icon of the entry. * * Default value: Gtk::Image::Type::EMPTY * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Image::Type > property_secondary_icon_storage_type() const; /** Whether the primary icon is activatable. * * GTK emits the signal_icon_press() and * signal_icon_release() signals only on sensitive, * activatable icons. * * Sensitive, but non-activatable icons can be used for purely * informational purposes. * * Default value: true * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_primary_icon_activatable() ; /** Whether the primary icon is activatable. * * GTK emits the signal_icon_press() and * signal_icon_release() signals only on sensitive, * activatable icons. * * Sensitive, but non-activatable icons can be used for purely * informational purposes. * * Default value: true * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_primary_icon_activatable() const; /** Whether the secondary icon is activatable. * * GTK emits the signal_icon_press() and * signal_icon_release() signals only on sensitive, * activatable icons. * * Sensitive, but non-activatable icons can be used for purely * informational purposes. * * Default value: true * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_secondary_icon_activatable() ; /** Whether the secondary icon is activatable. * * GTK emits the signal_icon_press() and * signal_icon_release() signals only on sensitive, * activatable icons. * * Sensitive, but non-activatable icons can be used for purely * informational purposes. * * Default value: true * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_secondary_icon_activatable() const; /** Whether the primary icon is sensitive. * * An insensitive icon appears grayed out. GTK does not emit the * signal_icon_press() and signal_icon_release() * signals and does not allow DND from insensitive icons. * * An icon should be set insensitive if the action that would trigger * when clicked is currently not available. * * Default value: true * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_primary_icon_sensitive() ; /** Whether the primary icon is sensitive. * * An insensitive icon appears grayed out. GTK does not emit the * signal_icon_press() and signal_icon_release() * signals and does not allow DND from insensitive icons. * * An icon should be set insensitive if the action that would trigger * when clicked is currently not available. * * Default value: true * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_primary_icon_sensitive() const; /** Whether the secondary icon is sensitive. * * An insensitive icon appears grayed out. GTK does not emit the * [signal@Gtk.Entry::icon-press[ and [signal @a Gtk.Entry::icon-release] * signals and does not allow DND from insensitive icons. * * An icon should be set insensitive if the action that would trigger * when clicked is currently not available. * * Default value: true * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_secondary_icon_sensitive() ; /** Whether the secondary icon is sensitive. * * An insensitive icon appears grayed out. GTK does not emit the * [signal@Gtk.Entry::icon-press[ and [signal @a Gtk.Entry::icon-release] * signals and does not allow DND from insensitive icons. * * An icon should be set insensitive if the action that would trigger * when clicked is currently not available. * * Default value: true * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_secondary_icon_sensitive() const; /** The contents of the tooltip on the primary icon. * * Also see Gtk::Entry::set_icon_tooltip_text(). * * Default value: "" * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_primary_icon_tooltip_text() ; /** The contents of the tooltip on the primary icon. * * Also see Gtk::Entry::set_icon_tooltip_text(). * * Default value: "" * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_primary_icon_tooltip_text() const; /** The contents of the tooltip on the secondary icon. * * Also see Gtk::Entry::set_icon_tooltip_text(). * * Default value: "" * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_secondary_icon_tooltip_text() ; /** The contents of the tooltip on the secondary icon. * * Also see Gtk::Entry::set_icon_tooltip_text(). * * Default value: "" * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_secondary_icon_tooltip_text() const; /** The contents of the tooltip on the primary icon, with markup. * * Also see Gtk::Entry::set_icon_tooltip_markup(). * * Default value: "" * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_primary_icon_tooltip_markup() ; /** The contents of the tooltip on the primary icon, with markup. * * Also see Gtk::Entry::set_icon_tooltip_markup(). * * Default value: "" * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_primary_icon_tooltip_markup() const; /** The contents of the tooltip on the secondary icon, with markup. * * Also see Gtk::Entry::set_icon_tooltip_markup(). * * Default value: "" * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_secondary_icon_tooltip_markup() ; /** The contents of the tooltip on the secondary icon, with markup. * * Also see Gtk::Entry::set_icon_tooltip_markup(). * * Default value: "" * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_secondary_icon_tooltip_markup() const; /** Which IM (input method) module should be used for this entry. * * See Gtk::IMContext. * * Setting this to a non-nullptr value overrides the system-wide IM * module setting. See the GtkSettings Gtk::Settings::property_gtk_im_module() * property. * * Default value: "" * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Glib::ustring > property_im_module() ; /** Which IM (input method) module should be used for this entry. * * See Gtk::IMContext. * * Setting this to a non-nullptr value overrides the system-wide IM * module setting. See the GtkSettings Gtk::Settings::property_gtk_im_module() * property. * * Default value: "" * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Glib::ustring > property_im_module() const; /** The text that will be displayed in the `Gtk::Entry` when it is empty * and unfocused. * * Default value: "" * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Glib::ustring > property_placeholder_text() ; /** The text that will be displayed in the `Gtk::Entry` when it is empty * and unfocused. * * Default value: "" * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Glib::ustring > property_placeholder_text() const; #ifndef GTKMM_DISABLE_DEPRECATED /** The auxiliary completion object to use with the entry. * * Deprecated: 4.10: GtkEntryCompletion will be removed in GTK 5. * * @deprecated GtkEntryCompletion will be removed in GTK 5. * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Glib::RefPtr > property_completion() ; /** The auxiliary completion object to use with the entry. * * Deprecated: 4.10: GtkEntryCompletion will be removed in GTK 5. * * @deprecated GtkEntryCompletion will be removed in GTK 5. * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Glib::RefPtr > property_completion() const; #endif // GTKMM_DISABLE_DEPRECATED /** The purpose of this text field. * * This property can be used by on-screen keyboards and other input * methods to adjust their behaviour. * * Note that setting the purpose to Gtk::InputPurpose::PASSWORD or * Gtk::InputPurpose::PIN is independent from setting * property_visibility(). * * Default value: Gtk::InputPurpose::FREE_FORM * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< InputPurpose > property_input_purpose() ; /** The purpose of this text field. * * This property can be used by on-screen keyboards and other input * methods to adjust their behaviour. * * Note that setting the purpose to Gtk::InputPurpose::PASSWORD or * Gtk::InputPurpose::PIN is independent from setting * property_visibility(). * * Default value: Gtk::InputPurpose::FREE_FORM * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< InputPurpose > property_input_purpose() const; /** Additional hints that allow input methods to fine-tune their behavior. * * Also see property_input_purpose() * * Default value: Gtk::InputHints::NONE * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< InputHints > property_input_hints() ; /** Additional hints that allow input methods to fine-tune their behavior. * * Also see property_input_purpose() * * Default value: Gtk::InputHints::NONE * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< InputHints > property_input_hints() const; /** A list of Pango attributes to apply to the text of the entry. * * This is mainly useful to change the size or weight of the text. * * The `Pango::Attribute`'s @a start_index and @a end_index must refer to the * Gtk::EntryBuffer text, i.e. without the preedit string. * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Pango::AttrList > property_attributes() ; /** A list of Pango attributes to apply to the text of the entry. * * This is mainly useful to change the size or weight of the text. * * The `Pango::Attribute`'s @a start_index and @a end_index must refer to the * Gtk::EntryBuffer text, i.e. without the preedit string. * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Pango::AttrList > property_attributes() const; /** A list of tabstops to apply to the text of the entry. * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Pango::TabArray > property_tabs() ; /** A list of tabstops to apply to the text of the entry. * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Pango::TabArray > property_tabs() const; /** A menu model whose contents will be appended to the context menu. * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Glib::RefPtr > property_extra_menu() ; /** A menu model whose contents will be appended to the context menu. * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< Glib::RefPtr > property_extra_menu() const; /** Whether the entry will show an Emoji icon in the secondary icon position * to open the Emoji chooser. * * Default value: false * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_show_emoji_icon() ; /** Whether the entry will show an Emoji icon in the secondary icon position * to open the Emoji chooser. * * Default value: false * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_show_emoji_icon() const; /** Whether to suggest Emoji replacements for :-delimited names * like `:heart:`. * * Default value: false * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< bool > property_enable_emoji_completion() ; /** Whether to suggest Emoji replacements for :-delimited names * like `:heart:`. * * Default value: false * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_enable_emoji_completion() const; public: public: //C++ methods used to invoke GTK+ virtual functions: protected: //GTK+ Virtual Functions (override these to change behaviour): //Default Signal Handlers:: }; } //namespace Gtk #ifndef DOXYGEN_SHOULD_SKIP_THIS namespace Glib { template <> class GTKMM_API Value : public Glib::Value_Enum { public: static GType value_type() G_GNUC_CONST; }; } // namespace Glib #endif /* DOXYGEN_SHOULD_SKIP_THIS */ namespace Glib { /** A Glib::wrap() method for this object. * * @param object The C instance. * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref. * @result A C++ instance that wraps this C instance. * * @relates Gtk::Entry */ GTKMM_API Gtk::Entry* wrap(GtkEntry* object, bool take_copy = false); } //namespace Glib #endif /* _GTKMM_ENTRY_H */