entry.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_ENTRY_H
#define _GTKMM_ENTRY_H
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: entry.hg,v 1.12 2006/06/13 17:16:26 murrayc Exp $ */
 
/* entry.h
 *
 * 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., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
#include <gtkmm/widget.h>
#include <gtkmm/editable.h>
#include <gtkmm/menu.h>
#include <gtkmm/celleditable.h>
#include <gtkmm/entrycompletion.h>
#include <gtkmm/adjustment.h>
#include <gtkmm/image.h> //For ImageType.
#include <gtkmm/border.h>
#include <gtkmm/entrybuffer.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkEntry GtkEntry;
typedef struct _GtkEntryClass GtkEntryClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{ class Entry_Class; } // namespace Gtk
namespace Gtk
{
 
enum EntryIconPosition
{
  ENTRY_ICON_PRIMARY,
  ENTRY_ICON_SECONDARY
};
 
} // namespace Gtk
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
 
template <>
class Value<Gtk::EntryIconPosition> : public Glib::Value_Enum<Gtk::EntryIconPosition>
{
public:
  static GType value_type() G_GNUC_CONST;
};
 
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{
 
 
class 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 */
 
  virtual ~Entry();
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
private:
  friend class Entry_Class;
  static CppClassType entry_class_;
 
  // noncopyable
  Entry(const Entry&);
  Entry& operator=(const Entry&);
 
protected:
  explicit Entry(const Glib::ConstructParams& construct_params);
  explicit Entry(GtkEntry* castitem);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  static GType get_type()      G_GNUC_CONST;
 
 
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GtkEntry*       gobj()       { return reinterpret_cast<GtkEntry*>(gobject_); }
 
  const GtkEntry* gobj() const { return reinterpret_cast<GtkEntry*>(gobject_); }
 
 
public:
  //C++ methods used to invoke GTK+ virtual functions:
 
protected:
  //GTK+ Virtual Functions (override these to change behaviour):
 
  //Default Signal Handlers::
  virtual void on_populate_popup(Menu* menu);
  virtual void on_insert_at_cursor(const Glib::ustring& str);
  virtual void on_activate();
 
 
private:
 
  
public:
 
  Entry();
    explicit Entry(const Glib::RefPtr<EntryBuffer>& buffer);
 
 
  Glib::RefPtr<EntryBuffer> get_buffer();
  
  Glib::RefPtr<const EntryBuffer> get_buffer() const;
 
  
  void set_buffer(const Glib::RefPtr<EntryBuffer>& buffer);
 
  
  Glib::RefPtr<Gdk::Window> get_text_window();
  
  Glib::RefPtr<const Gdk::Window> get_text_window() const;
  
  void set_visibility(bool visible =  true);
  
  bool get_visibility() const;
  
  void set_invisible_char(gunichar ch);
  
  void unset_invisible_char();
  
  gunichar get_invisible_char() const;
  
  void set_has_frame(bool setting =  true);
  
  bool get_has_frame() const;
 
  
  void set_inner_border(const Border& border);
  
  Border get_inner_border() const;
 
  
  void set_overwrite_mode(bool overwrite =  true);
  
  bool get_overwrite_mode() const;
  
  void set_max_length(int max);
  
  int get_max_length() const;
  
  guint16 get_text_length() const;
  
  void set_activates_default(bool setting =  true);
  
  gboolean get_activates_default() const;
  
  void set_width_chars(int n_chars);
  
  int get_width_chars() const;
  
  void set_text(const Glib::ustring & text);
  
  Glib::ustring get_text() const;
  
  Glib::RefPtr<Pango::Layout> get_layout();
  
  Glib::RefPtr<const Pango::Layout> get_layout() const;
  
  void get_layout_offsets(int& x, int& y);
 
  
  int layout_index_to_text_index(int layout_index) const;
  
  int text_index_to_layout_index(int text_index) const;
 
  
  void set_cursor_hadjustment(Adjustment& adjustment);
  
  Adjustment* get_cursor_hadjustment();
  
  const Adjustment* get_cursor_hadjustment() const;
 
  
  void set_alignment(float xalign);
  
  void set_alignment(AlignmentEnum xalign);
  
  float get_alignment() const;
 
  
  void set_completion(const Glib::RefPtr<EntryCompletion>& completion);
  
  Glib::RefPtr<EntryCompletion> get_completion();
  
  Glib::RefPtr<const EntryCompletion> get_completion() const;
 
  
  void set_progress_fraction(double fraction);
  
  double get_progress_fraction() const;
  
  void set_progress_pulse_step(double fraction);
  
  double get_progress_pulse_step();
  
  void progress_pulse();
 
 
  void set_icon_from_pixbuf(const Glib::RefPtr<Gdk::Pixbuf>& pixbuf, EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
  
 
  void set_icon_from_stock(const StockID& stock_id, EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
  
 
  void set_icon_from_icon_name(const Glib::ustring& icon_name, EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
  
 
  void set_icon_from_gicon(const Glib::RefPtr<Gio::Icon>& icon, EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
  
 
  ImageType get_icon_storage_type(EntryIconPosition icon_pos =  ENTRY_ICON_PRIMARY) const;
  
  Glib::RefPtr<Gdk::Pixbuf> get_icon_pixbuf(EntryIconPosition icon_pos =  ENTRY_ICON_PRIMARY);
  
  Glib::RefPtr<const Gdk::Pixbuf> get_icon_pixbuf(EntryIconPosition icon_pos =  ENTRY_ICON_PRIMARY) const;
  
  StockID get_icon_stock(EntryIconPosition icon_pos =  ENTRY_ICON_PRIMARY) const;
  
  Glib::ustring get_icon_name(EntryIconPosition icon_pos =  ENTRY_ICON_PRIMARY) const;
  
  Glib::RefPtr<Gio::Icon> get_icon_gicon(EntryIconPosition icon_pos =  ENTRY_ICON_PRIMARY);
  
  Glib::RefPtr<const Gio::Icon> get_icon_gicon(EntryIconPosition icon_pos =  ENTRY_ICON_PRIMARY) const;
 
  
  void set_icon_activatable(bool activatable = true, EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
  
 
  bool get_icon_activatable(EntryIconPosition icon_pos =  ENTRY_ICON_PRIMARY) const;
  
  void set_icon_sensitive(EntryIconPosition icon_pos =  ENTRY_ICON_PRIMARY, bool sensitive =  true);
  
  bool get_icon_sensitive(EntryIconPosition icon_pos =  ENTRY_ICON_PRIMARY);
  
  int get_icon_at_pos(int x, int y) const;
 
  
  void set_icon_tooltip_text(const Glib::ustring& tooltip, EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
  
 
  Glib::ustring get_icon_tooltip_text(EntryIconPosition icon_pos =  ENTRY_ICON_PRIMARY) const;
 
  
  void set_icon_tooltip_markup(const Glib::ustring& tooltip, EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
  
 
  Glib::ustring get_icon_tooltip_markup(EntryIconPosition icon_pos =  ENTRY_ICON_PRIMARY) const;
 
  
  void set_icon_drag_source(const Glib::RefPtr<TargetList>& target_list, Gdk::DragAction actions = Gdk::ACTION_COPY, EntryIconPosition icon_pos = ENTRY_ICON_PRIMARY);
  
 
  int get_current_icon_drag_source();
 
  
  Glib::RefPtr<Gdk::Window> get_icon_window(EntryIconPosition icon_pos =  ENTRY_ICON_PRIMARY);
  
  Glib::RefPtr<const Gdk::Window> get_icon_window(EntryIconPosition icon_pos =  ENTRY_ICON_PRIMARY) const;
 
  
  bool im_context_filter_keypress(GdkEventKey* event);
  
  void reset_im_context();
 
  
  Glib::SignalProxy1< void,Menu* > signal_populate_popup();
 
 
  Glib::SignalProxy1< void,const Glib::ustring& > signal_insert_at_cursor();
 
 
  //Key-binding signals:
 
  //This is a keybinding signal, but it is allowed:
  // http://mail.gnome.org/archives/gtk-devel-list/2003-January/msg00108.html
  // "activate is probably about the only exception"
  
  Glib::SignalProxy0< void > signal_activate();
 
 
  Glib::SignalProxy2< void,EntryIconPosition,const GdkEventButton* > signal_icon_release();
 
  
  Glib::SignalProxy2< void,EntryIconPosition,const GdkEventButton* > signal_icon_press();
 
 
  Glib::PropertyProxy< Glib::RefPtr<EntryBuffer> > property_buffer() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<EntryBuffer> > property_buffer() const;
 
  Glib::PropertyProxy_ReadOnly< int > property_cursor_position() const;
 
 
  Glib::PropertyProxy_ReadOnly< int > property_selection_bound() const;
 
 
  Glib::PropertyProxy< bool > property_editable() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_editable() const;
 
  Glib::PropertyProxy< int > property_max_length() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_max_length() const;
 
  Glib::PropertyProxy< bool > property_visibility() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_visibility() const;
 
  Glib::PropertyProxy< bool > property_has_frame() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_has_frame() const;
 
  Glib::PropertyProxy< Border > property_inner_border() ;
 
  Glib::PropertyProxy_ReadOnly< Border > property_inner_border() const;
 
  Glib::PropertyProxy< gunichar > property_invisible_char() ;
 
  Glib::PropertyProxy_ReadOnly< gunichar > property_invisible_char() const;
 
  Glib::PropertyProxy< bool > property_invisible_char_set() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_invisible_char_set() const;
 
  Glib::PropertyProxy< bool > property_activates_default() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_activates_default() const;
 
  Glib::PropertyProxy< int > property_width_chars() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_width_chars() const;
 
  Glib::PropertyProxy_ReadOnly< int > property_scroll_offset() const;
 
 
  Glib::PropertyProxy< ShadowType > property_shadow_type() ;
 
  Glib::PropertyProxy_ReadOnly< ShadowType > property_shadow_type() const;
 
  Glib::PropertyProxy< Glib::ustring > property_text() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_text() const;
 
  Glib::PropertyProxy< float > property_xalign() ;
 
  Glib::PropertyProxy_ReadOnly< float > property_xalign() const;
 
  Glib::PropertyProxy< bool > property_truncate_multiline() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_truncate_multiline() const;
 
  Glib::PropertyProxy< bool > property_overwrite_mode() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_overwrite_mode() const;
 
  Glib::PropertyProxy_ReadOnly< guint > property_text_length() const;
 
 
  Glib::PropertyProxy< bool > property_caps_lock_warning() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_caps_lock_warning() const;
 
  Glib::PropertyProxy< double > property_progress_fraction() ;
 
  Glib::PropertyProxy_ReadOnly< double > property_progress_fraction() const;
 
  Glib::PropertyProxy< double > property_progress_pulse_step() ;
 
  Glib::PropertyProxy_ReadOnly< double > property_progress_pulse_step() const;
 
  Glib::PropertyProxy< Glib::RefPtr<Gdk::Pixbuf> > property_primary_icon_pixbuf() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Pixbuf> > property_primary_icon_pixbuf() const;
 
  Glib::PropertyProxy< Glib::RefPtr<Gdk::Pixbuf> > property_secondary_icon_pixbuf() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Pixbuf> > property_secondary_icon_pixbuf() const;
 
  Glib::PropertyProxy< StockID > property_primary_icon_stock() ;
 
  Glib::PropertyProxy_ReadOnly< StockID > property_primary_icon_stock() const;
 
  Glib::PropertyProxy< StockID > property_secondary_icon_stock() ;
 
  Glib::PropertyProxy_ReadOnly< StockID > property_secondary_icon_stock() const;
 
  Glib::PropertyProxy< Glib::ustring > property_primary_icon_name() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_primary_icon_name() const;
 
  Glib::PropertyProxy< Glib::ustring > property_secondary_icon_name() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_secondary_icon_name() const;
 
  Glib::PropertyProxy< Glib::RefPtr<Gio::Icon> > property_primary_icon_gicon() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gio::Icon> > property_primary_icon_gicon() const;
 
  Glib::PropertyProxy< Glib::RefPtr<Gio::Icon> > property_secondary_icon_gicon() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gio::Icon> > property_secondary_icon_gicon() const;
 
  Glib::PropertyProxy_ReadOnly< ImageType > property_primary_icon_storage_type() const;
 
 
  Glib::PropertyProxy_ReadOnly< ImageType > property_secondary_icon_storage_type() const;
 
 
  Glib::PropertyProxy< bool > property_primary_icon_activatable() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_primary_icon_activatable() const;
 
  Glib::PropertyProxy< bool > property_secondary_icon_activatable() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_secondary_icon_activatable() const;
 
  Glib::PropertyProxy< bool > property_primary_icon_sensitive() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_primary_icon_sensitive() const;
 
  Glib::PropertyProxy< bool > property_secondary_icon_sensitive() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_secondary_icon_sensitive() const;
 
  Glib::PropertyProxy< bool > property_primary_icon_tooltip_text() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_primary_icon_tooltip_text() const;
 
  Glib::PropertyProxy< bool > property_secondary_icon_tooltip_text() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_secondary_icon_tooltip_text() const;
 
  Glib::PropertyProxy< bool > property_primary_icon_tooltip_markup() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_primary_icon_tooltip_markup() const;
 
  Glib::PropertyProxy< bool > property_secondary_icon_tooltip_markup() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_secondary_icon_tooltip_markup() const;
 
  Glib::PropertyProxy< Glib::ustring > property_im_module() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_im_module() const;
 
 
};
 
} /* namespace Gtk */
 
 
namespace Glib
{
  Gtk::Entry* wrap(GtkEntry* object, bool take_copy = false);
} //namespace Glib
 
 
#endif /* _GTKMM_ENTRY_H */