entrycompletion.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_ENTRYCOMPLETION_H
#define _GTKMM_ENTRYCOMPLETION_H
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: entrycompletion.hg,v 1.24 2006/07/19 16:58:50 murrayc Exp $ */
 
/* 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., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
#include <gtkmm/widget.h>
#include <gtkmm/treemodel.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkEntryCompletion GtkEntryCompletion;
typedef struct _GtkEntryCompletionClass 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;
 
//TODO: This should derive+implement from CellLayout, when we can break ABI.
//Then we should add "It derives from the Gtk::CellLayout, to allow the user to add extra cells to the Gtk::TreeView with completion matches".
 
class EntryCompletion : public Glib::Object
{
  
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
public:
  typedef EntryCompletion CppObjectType;
  typedef EntryCompletion_Class CppClassType;
  typedef GtkEntryCompletion BaseObjectType;
  typedef GtkEntryCompletionClass BaseClassType;
 
private:  friend class EntryCompletion_Class;
  static CppClassType entrycompletion_class_;
 
private:
  // noncopyable
  EntryCompletion(const EntryCompletion&);
  EntryCompletion& operator=(const EntryCompletion&);
 
protected:
  explicit EntryCompletion(const Glib::ConstructParams& construct_params);
  explicit EntryCompletion(GtkEntryCompletion* castitem);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
  virtual ~EntryCompletion();
 
  static GType get_type()      G_GNUC_CONST;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
 
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GtkEntryCompletion*       gobj()       { return reinterpret_cast<GtkEntryCompletion*>(gobject_); }
 
  const GtkEntryCompletion* gobj() const { return reinterpret_cast<GtkEntryCompletion*>(gobject_); }
 
  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.
  
  Entry* get_entry();
  
  const Entry* get_entry() const;
 
  
  void set_model(const Glib::RefPtr<TreeModel>& model);
  
  Glib::RefPtr<TreeModel> get_model();
  
  Glib::RefPtr<const TreeModel> get_model() const;
 
  void unset_model();
 
  typedef sigc::slot<bool, const Glib::ustring&, const TreeModel::const_iterator&> SlotMatch;
  
  void set_match_func(const SlotMatch& slot);
  
  
  void set_minimum_key_length(int length);
  
  int get_minimum_key_length() const;
  
  void complete();
 
  
  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.
  
  void delete_action(int index =  0);
 
  
  void set_inline_completion(bool inline_completion =  true);
  
  bool get_inline_completion() const;
  
  void set_inline_selection(bool inline_selection =  true);
  
  bool get_inline_selection() const;
  
  void set_popup_completion(bool popup_completion =  true);
  
  bool get_popup_completion() const;
 
  
  void set_popup_set_width(bool popup_set_width =  true);
  
  bool get_popup_set_width() const;
 
  
#ifndef GTKMM_DISABLE_DEPRECATED
 
  void set_popup_single_width(bool popup_single_match =  true);
#endif // GTKMM_DISABLE_DEPRECATED
 
 
  void set_popup_single_match(bool popup_single_match =  true);
 
  
  bool get_popup_single_match() const;
  
  Glib::ustring get_completion_prefix() const;
 
  
  void set_text_column(const TreeModelColumnBase& column);
  
  void set_text_column(int column);
  
#ifndef GTKMM_DISABLE_DEPRECATED
 
  int get_text_column();
#endif // GTKMM_DISABLE_DEPRECATED
 
 
  int get_text_column() const;
 
  
  Glib::SignalProxy1< 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.
  
  
  Glib::SignalProxy1< bool, const TreeModel::iterator& > signal_match_selected();
 
  Glib::SignalProxy1< bool, const TreeModel::iterator& > signal_cursor_on_match();
 
 
  //We use no_default_handler for these signals, because we can not add a new vfunc without breaking ABI.
  //TODO: Remove no_default_handler when we do an ABI-break-with-parallel-install.
 
  
  Glib::SignalProxy1< bool,const Glib::ustring& > signal_insert_prefix();
 
 
  Glib::PropertyProxy< Glib::RefPtr<Gtk::TreeModel> > property_model() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gtk::TreeModel> > property_model() const;
 
  Glib::PropertyProxy< int > property_minimum_key_length() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_minimum_key_length() const;
 
  Glib::PropertyProxy< int > property_text_column() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_text_column() const;
 
  Glib::PropertyProxy< bool > property_inline_completion() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_inline_completion() const;
 
  Glib::PropertyProxy< bool > property_popup_completion() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_popup_completion() const;
 
  Glib::PropertyProxy< bool > property_popup_set_width() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_popup_set_width() const;
 
  Glib::PropertyProxy< bool > property_popup_single_match() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_popup_single_match() const;
 
  Glib::PropertyProxy< bool > property_inline_selection() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_inline_selection() const;
 
 
protected:
 
  //Default Signal Handler:
  virtual bool on_match_selected(const TreeModel::iterator& iter);  
  //No default handler for on_cursor_on_match(), to preserver 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::
  virtual void on_action_activated(int index);
 
 
};
 
} // namespace Gtk
 
 
namespace Glib
{
  Glib::RefPtr<Gtk::EntryCompletion> wrap(GtkEntryCompletion* object, bool take_copy = false);
}
 
 
#endif /* _GTKMM_ENTRYCOMPLETION_H */