// Generated by gmmproc 2.54.0 -- DO NOT MODIFY!
#ifndef _GTKMM_ENTRYCOMPLETION_H
#define _GTKMM_ENTRYCOMPLETION_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* Copyright (C) 2003 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 <gtkmm/widget.h>
#include <gtkmm/celllayout.h>
#include <gtkmm/treemodel.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
using GtkEntryCompletion = struct _GtkEntryCompletion;
using GtkEntryCompletionClass = struct _GtkEntryCompletionClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class EntryCompletion_Class; } // namespace Gtk
#endif //DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{
class Entry;
/** Completion functionality for Gtk::Entry.
*
* Gtk::EntryCompletion is an auxiliary object to be used in conjunction with
* Gtk::Entry to provide the completion functionality.
*
* It derives from Gtk::CellLayout, to allow the user to add extra cells to the Gtk::TreeView with completion matches.
*
* "Completion functionality" means that when the user modifies the text in the
* entry, Gtk::EntryCompletion checks which rows in the model match the current
* content of the entry, and displays a list of matches. By default, the
* matching is done by comparing the entry text case-insensitively against
* the text column of the model (see set_text_column()),
* but this can be overridden with a custom match function (see set_match_func()).
*
* When the user selects a completion, the content of the entry is updated.
* By default, the content of the entry is replaced by the text column of the
* model, but this can be overridden by connecting to the match_selected signal
* and updating the entry in the signal handler. Note that you should return true
* from the signal handler to suppress the default behaviour.
*
* To add completion functionality to an entry, use Gtk::Entry::set_completion().
*
* In addition to regular completion matches, which will be inserted into
* the entry when they are selected, Gtk::EntryCompletion also allows the display of
* "actions" in the popup window. Their appearance is similar to menu items,
* to differentiate them clearly from completion strings. When an action is
* selected, the action_activated signal is emitted.
*/
class EntryCompletion
: public Glib::Object,
public Gtk::CellLayout,
public Gtk::Buildable
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
using CppObjectType = EntryCompletion;
using CppClassType = EntryCompletion_Class;
using BaseObjectType = GtkEntryCompletion;
using BaseClassType = GtkEntryCompletionClass;
// noncopyable
EntryCompletion(const EntryCompletion&) = delete;
EntryCompletion& operator=(const EntryCompletion&) = delete;
private: friend class EntryCompletion_Class;
static CppClassType entrycompletion_class_;
protected:
explicit EntryCompletion(const Glib::ConstructParams& construct_params);
explicit EntryCompletion(GtkEntryCompletion* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
EntryCompletion(EntryCompletion&& src) noexcept;
EntryCompletion& operator=(EntryCompletion&& src) noexcept;
~EntryCompletion() noexcept override;
/** 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.
GtkEntryCompletion* gobj() { return reinterpret_cast<GtkEntryCompletion*>(gobject_); }
///Provides access to the underlying C GObject.
const GtkEntryCompletion* gobj() const { return reinterpret_cast<GtkEntryCompletion*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GtkEntryCompletion* gobj_copy();
private:
protected:
EntryCompletion();
public:
static Glib::RefPtr<EntryCompletion> create();
//Careful, this actually returns a GtkWidget*, so it might not always be a GtkEntry in future GTK+ versions.
/** Gets the entry @a completion has been attached to.
*
* @newin{2,4}
*
* @return The entry @a completion has been attached to.
*/
Entry* get_entry();
/** Gets the entry @a completion has been attached to.
*
* @newin{2,4}
*
* @return The entry @a completion has been attached to.
*/
const Entry* get_entry() const;
/** Sets the model for a Gtk::EntryCompletion. If @a completion already has
* a model set, it will remove it before setting the new model.
* Use unset_model() to unset the old model.
*
* @newin{2,4}
*
* @param model The Gtk::TreeModel.
*/
void set_model(const Glib::RefPtr<TreeModel>& model);
/** Returns the model the Gtk::EntryCompletion is using as data source.
* Returns <tt>nullptr</tt> if the model is unset.
*
* @newin{2,4}
*
* @return A Gtk::TreeModel, or <tt>nullptr</tt> if none
* is currently being used.
*/
Glib::RefPtr<TreeModel> get_model();
/** Returns the model the Gtk::EntryCompletion is using as data source.
* Returns <tt>nullptr</tt> if the model is unset.
*
* @newin{2,4}
*
* @return A Gtk::TreeModel, or <tt>nullptr</tt> if none
* is currently being used.
*/
Glib::RefPtr<const TreeModel> get_model() const;
/** Remove the model from the EntryCompletion.
*
* @see set_model().
*
* @newin{2,16}
*/
void unset_model();
/// For example, bool on_match(const Glib::ustring& key, const TreeModel::const_iterator& iter);
typedef sigc::slot<bool, const Glib::ustring&, const TreeModel::const_iterator&> SlotMatch;
void set_match_func(const SlotMatch& slot);
/** Requires the length of the search key for @a completion to be at least
* @a length. This is useful for long lists, where completing using a small
* key takes a lot of time and will come up with meaningless results anyway
* (ie, a too large dataset).
*
* @newin{2,4}
*
* @param length The minimum length of the key in order to start completing.
*/
void set_minimum_key_length(int length);
/** Returns the minimum key length as set for @a completion.
*
* @newin{2,4}
*
* @return The currently used minimum key length.
*/
int get_minimum_key_length() const;
/** Computes the common prefix that is shared by all rows in @a completion
* that start with @a key. If no row matches @a key, <tt>nullptr</tt> will be returned.
* Note that a text column must have been set for this function to work,
* see set_text_column() for details.
*
* @newin{3,4}
*
* @param key The text to complete for.
* @return The common prefix all rows starting with
* @a key or <tt>nullptr</tt> if no row matches @a key.
*/
Glib::ustring compute_prefix(const Glib::ustring& key);
/** Requests a completion operation, or in other words a refiltering of the
* current list with completions, using the current key. The completion list
* view will be updated accordingly.
*
* @newin{2,4}
*/
void complete();
/** Requests a prefix insertion.
*
* @newin{2,6}
*/
void insert_prefix();
//We reordered the parameters, compared to the C version, so that we can have method overloads without the index.
// TODO: We would really like an insert() which before-inserts an iterator, like ListStore::insert(),
// but there is no EntryCompletion::insert_before() for us to use.
void insert_action_text(const Glib::ustring& text, int index);
void prepend_action_text(const Glib::ustring& text);
//TODO: Add append_action_text() somehow? It would be slow if we count the children each time. murrayc.
void insert_action_markup(const Glib::ustring& markup, int index);
void prepend_action_markup(const Glib::ustring& markup);
//TODO: Change default - it would be nicer to delete the last action instead of the first.
/** Deletes the action at @a index from @a completion’s action list.
*
* Note that @a index is a relative position and the position of an
* action may have changed since it was inserted.
*
* @newin{2,4}
*
* @param index The index of the item to delete.
*/
void delete_action(int index = 0);
/** Sets whether the common prefix of the possible completions should
* be automatically inserted in the entry.
*
* @newin{2,6}
*
* @param inline_completion <tt>true</tt> to do inline completion.
*/
void set_inline_completion(bool inline_completion = true);
/** Returns whether the common prefix of the possible completions should
* be automatically inserted in the entry.
*
* @newin{2,6}
*
* @return <tt>true</tt> if inline completion is turned on.
*/
bool get_inline_completion() const;
/** Sets whether it is possible to cycle through the possible completions
* inside the entry.
*
* @newin{2,12}
*
* @param inline_selection <tt>true</tt> to do inline selection.
*/
void set_inline_selection(bool inline_selection = true);
/** Returns <tt>true</tt> if inline-selection mode is turned on.
*
* @newin{2,12}
*
* @return <tt>true</tt> if inline-selection mode is on.
*/
bool get_inline_selection() const;
/** Sets whether the completions should be presented in a popup window.
*
* @newin{2,6}
*
* @param popup_completion <tt>true</tt> to do popup completion.
*/
void set_popup_completion(bool popup_completion = true);
/** Returns whether the completions should be presented in a popup window.
*
* @newin{2,6}
*
* @return <tt>true</tt> if popup completion is turned on.
*/
bool get_popup_completion() const;
/** Sets whether the completion popup window will be resized to be the same
* width as the entry.
*
* @newin{2,8}
*
* @param popup_set_width <tt>true</tt> to make the width of the popup the same as the entry.
*/
void set_popup_set_width(bool popup_set_width = true);
/** Returns whether the completion popup window will be resized to the
* width of the entry.
*
* @newin{2,8}
*
* @return <tt>true</tt> if the popup window will be resized to the width of
* the entry.
*/
bool get_popup_set_width() const;
/** Sets whether the completion popup window will appear even if there is
* only a single match. You may want to set this to <tt>false</tt> if you
* are using [inline completion][GtkEntryCompletion--inline-completion].
*
* @newin{2,8}
*
* @param popup_single_match <tt>true</tt> if the popup should appear even for a single
* match.
*/
void set_popup_single_match(bool popup_single_match = true);
/** Returns whether the completion popup window will appear even if there is
* only a single match.
*
* @newin{2,8}
*
* @return <tt>true</tt> if the popup window will appear regardless of the
* number of matches.
*/
bool get_popup_single_match() const;
/** Get the original text entered by the user that triggered
* the completion or an empty string if there's no completion ongoing.
*
* @newin{2,12}
*
* @return The prefix for the current completion.
*/
Glib::ustring get_completion_prefix() const;
/** Convenience function for setting up the most used case of this code: a
* completion list with just strings. This function will set up @a completion
* to have a list displaying all (and just) strings in the completion list,
* and to get those strings from @a column in the model of @a completion.
*
* This functions creates and adds a Gtk::CellRendererText for the selected
* column. If you need to set the text column, but don't want the cell
* renderer, use Glib::object_set() to set the Gtk::EntryCompletion::property_text_column()
* property directly.
*
* @newin{2,4}
*
* @param column The column in the model of @a completion to get strings from.
*/
void set_text_column(const TreeModelColumnBase& column);
/** Convenience function for setting up the most used case of this code: a
* completion list with just strings. This function will set up @a completion
* to have a list displaying all (and just) strings in the completion list,
* and to get those strings from @a column in the model of @a completion.
*
* This functions creates and adds a Gtk::CellRendererText for the selected
* column. If you need to set the text column, but don't want the cell
* renderer, use Glib::object_set() to set the Gtk::EntryCompletion::property_text_column()
* property directly.
*
* @newin{2,4}
*
* @param column The column in the model of @a completion to get strings from.
*/
void set_text_column(int column);
/** Returns the column in the model of @a completion to get strings from.
*
* @newin{2,6}
*
* @return The column containing the strings.
*/
int get_text_column() const;
/**
* @par Slot Prototype:
* <tt>void on_my_%action_activated(int index)</tt>
*
* Flags: Run Last
*
* Gets emitted when an action is activated.
*
* @newin{2,4}
*
* @param index The index of the activated action.
*/
Glib::SignalProxy< void,int > signal_action_activated();
//We completely hand-code these signals because we want to change how the parameters are wrapped,
//because we need both the iter and the model to make the C++ iter.
/** Emitted when a match from the list is selected.
* The default behaviour is to replace the contents of the
* entry with the contents of the text column in the row
* pointed to by @a iter.
*
* It is necessary to connect your signal handler <i>before</i>
* the default one, which would otherwise return <tt>true</tt>,
* a value which signifies that the signal has been handled,
* thus preventing any other handler from being invoked.
*
* To do this, pass <tt>false</tt> to this signal proxy's
* <tt>connect()</tt> method. For example:
* <tt> completion->signal_match_selected().connect(sigc::mem_fun(*this, &YourClass::on_completion_match_selected), false); </tt>
*
* @param model The TreeModel containing the matches
* @param iter A TreeModel::iterator positioned at the selected match
* @result true if the signal has been handled
*
* @par Prototype:
* <tt>bool %on_match_selected(const TreeModel::iterator& iter)</tt>
*/
Glib::SignalProxy1< bool, const TreeModel::iterator& > signal_match_selected();
/** Emitted when a match from the cursor is on a match
* of the list. The default behaviour is to replace the contents
* of the entry with the contents of the text column in the row
* pointed to by @a iter.
*
* @param model The TreeModel containing the matches
* @param iter A TreeModel::iterator positioned at the selected match
* @result true if the signal has been handled
*
* @par Prototype:
* <tt>bool %on_cursor_on_match(const TreeModel::iterator& iter)</tt>
*
* @newin{2,12}
*/
Glib::SignalProxy1< bool, const TreeModel::iterator& > signal_cursor_on_match();
/**
* @par Slot Prototype:
* <tt>bool on_my_%insert_prefix(const Glib::ustring& prefix)</tt>
*
* Flags: Run Last
*
* Gets emitted when the inline autocompletion is triggered.
* The default behaviour is to make the entry display the
* whole prefix and select the newly inserted part.
*
* Applications may connect to this signal in order to insert only a
* smaller part of the @a prefix into the entry - e.g. the entry used in
* the Gtk::FileChooser inserts only the part of the prefix up to the
* next '/'.
*
* @newin{2,6}
*
* @param prefix The common prefix of all possible completions.
* @return <tt>true</tt> if the signal has been handled.
*/
Glib::SignalProxy< bool,const Glib::ustring& > signal_insert_prefix();
//TODO: Remove no_default_handler when we can break ABI.
/**
* @par Slot Prototype:
* <tt>void on_my_%no_matches()</tt>
*
* Flags: Run Last
*
* Gets emitted when the filter model has zero
* number of rows in completion_complete method.
* (In other words when GtkEntryCompletion is out of
* suggestions)
*
* @newin{3,14}
*/
Glib::SignalProxy< void > signal_no_matches();
/** The model to find matches in.
*
* @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<Gtk::TreeModel> > property_model() ;
/** The model to find matches in.
*
* @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<Gtk::TreeModel> > property_model() const;
/** Minimum length of the search key in order to look up matches.
*
* @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_minimum_key_length() ;
/** Minimum length of the search key in order to look up matches.
*
* @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_minimum_key_length() const;
/** The column of the model containing the strings.
* Note that the strings must be UTF-8.
*
* @newin{2,6}
*
* @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_text_column() ;
/** The column of the model containing the strings.
* Note that the strings must be UTF-8.
*
* @newin{2,6}
*
* @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_text_column() const;
/** Determines whether the common prefix of the possible completions
* should be inserted automatically in the entry. Note that this
* requires text-column to be set, even if you are using a custom
* match function.
*
* @newin{2,6}
*
* @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_inline_completion() ;
/** Determines whether the common prefix of the possible completions
* should be inserted automatically in the entry. Note that this
* requires text-column to be set, even if you are using a custom
* match function.
*
* @newin{2,6}
*
* @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_inline_completion() const;
/** Determines whether the possible completions should be
* shown in a popup window.
*
* @newin{2,6}
*
* @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_popup_completion() ;
/** Determines whether the possible completions should be
* shown in a popup window.
*
* @newin{2,6}
*
* @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_popup_completion() const;
/** Determines whether the completions popup window will be
* resized to the width of the entry.
*
* @newin{2,8}
*
* @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_popup_set_width() ;
/** Determines whether the completions popup window will be
* resized to the width of the entry.
*
* @newin{2,8}
*
* @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_popup_set_width() const;
/** Determines whether the completions popup window will shown
* for a single possible completion. You probably want to set
* this to <tt>false</tt> if you are using
* [inline completion][GtkEntryCompletion--inline-completion].
*
* @newin{2,8}
*
* @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_popup_single_match() ;
/** Determines whether the completions popup window will shown
* for a single possible completion. You probably want to set
* this to <tt>false</tt> if you are using
* [inline completion][GtkEntryCompletion--inline-completion].
*
* @newin{2,8}
*
* @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_popup_single_match() const;
/** Determines whether the possible completions on the popup
* will appear in the entry as you navigate through them.
*
* @newin{2,12}
*
* @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_inline_selection() ;
/** Determines whether the possible completions on the popup
* will appear in the entry as you navigate through them.
*
* @newin{2,12}
*
* @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_inline_selection() const;
/** The Gtk::CellArea used to layout cell renderers in the treeview column.
*
* If no area is specified when creating the entry completion with
* Gtk::EntryCompletion::new_with_area() a horizontally oriented
* Gtk::CellAreaBox will be used.
*
* @newin{3,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< Glib::RefPtr<CellArea> > property_cell_area() const;
protected:
//Default Signal Handler:
virtual bool on_match_selected(const TreeModel::iterator& iter);
//No default handler for on_cursor_on_match(), to preserve ABI. TODO: Add this when we can break ABI.
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
/// This is a default handler for the signal signal_action_activated().
virtual void on_action_activated(int index);
/// This is a default handler for the signal signal_insert_prefix().
virtual bool on_insert_prefix(const Glib::ustring& prefix);
};
} // namespace Gtk
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::EntryCompletion
*/
Glib::RefPtr<Gtk::EntryCompletion> wrap(GtkEntryCompletion* object, bool take_copy = false);
}
#endif /* _GTKMM_ENTRYCOMPLETION_H */