cellrenderer.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_CELLRENDERER_H
#define _GTKMM_CELLRENDERER_H
 
#include <gtkmmconfig.h>
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.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/object.h>
#include <gtkmm/widget.h>
#include <gtkmm/celleditable.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkCellRenderer GtkCellRenderer;
typedef struct _GtkCellRendererClass GtkCellRendererClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{ class CellRenderer_Class; } // namespace Gtk
namespace Gtk
{
 
enum CellRendererState
{
  CELL_RENDERER_SELECTED = 1 << 0,
  CELL_RENDERER_PRELIT = 1 << 1,
  CELL_RENDERER_INSENSITIVE = 1 << 2,
  CELL_RENDERER_SORTED = 1 << 3,
  CELL_RENDERER_FOCUSED = 1 << 4
};
 
inline CellRendererState operator|(CellRendererState lhs, CellRendererState rhs)
  { return static_cast<CellRendererState>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
 
inline CellRendererState operator&(CellRendererState lhs, CellRendererState rhs)
  { return static_cast<CellRendererState>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
 
inline CellRendererState operator^(CellRendererState lhs, CellRendererState rhs)
  { return static_cast<CellRendererState>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
 
inline CellRendererState operator~(CellRendererState flags)
  { return static_cast<CellRendererState>(~static_cast<unsigned>(flags)); }
 
inline CellRendererState& operator|=(CellRendererState& lhs, CellRendererState rhs)
  { return (lhs = static_cast<CellRendererState>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
 
inline CellRendererState& operator&=(CellRendererState& lhs, CellRendererState rhs)
  { return (lhs = static_cast<CellRendererState>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
 
inline CellRendererState& operator^=(CellRendererState& lhs, CellRendererState rhs)
  { return (lhs = static_cast<CellRendererState>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
 
} // namespace Gtk
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
 
template <>
class Value<Gtk::CellRendererState> : public Glib::Value_Flags<Gtk::CellRendererState>
{
public:
  static GType value_type() G_GNUC_CONST;
};
 
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{
 
enum CellRendererMode
{
  CELL_RENDERER_MODE_INERT,
  CELL_RENDERER_MODE_ACTIVATABLE,
  CELL_RENDERER_MODE_EDITABLE
};
 
} // namespace Gtk
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
 
template <>
class Value<Gtk::CellRendererMode> : public Glib::Value_Enum<Gtk::CellRendererMode>
{
public:
  static GType value_type() G_GNUC_CONST;
};
 
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{
 
 
class CellRenderer : public Gtk::Object
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef CellRenderer CppObjectType;
  typedef CellRenderer_Class CppClassType;
  typedef GtkCellRenderer BaseObjectType;
  typedef GtkCellRendererClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
  virtual ~CellRenderer();
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
private:
  friend class CellRenderer_Class;
  static CppClassType cellrenderer_class_;
 
  // noncopyable
  CellRenderer(const CellRenderer&);
  CellRenderer& operator=(const CellRenderer&);
 
protected:
  explicit CellRenderer(const Glib::ConstructParams& construct_params);
  explicit CellRenderer(GtkCellRenderer* 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
 
  GtkCellRenderer*       gobj()       { return reinterpret_cast<GtkCellRenderer*>(gobject_); }
 
  const GtkCellRenderer* gobj() const { return reinterpret_cast<GtkCellRenderer*>(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_editing_canceled();
 
 
private:
 
public:
 
  
  void get_size(Widget& widget, const Gdk::Rectangle& cell_area, int& x_offset, int& y_offset, int& width, int& height) const;
 
  void get_size(Widget& widget, int& x_offset, int& y_offset, int& width, int& height) const;
 
  
  void render(const Glib::RefPtr<Gdk::Window>& window, Widget& widget, const Gdk::Rectangle& background_area, const Gdk::Rectangle& cell_area, const Gdk::Rectangle& expose_area, CellRendererState flags);
 
  
  bool activate(GdkEvent* event, Widget& widget, const Glib::ustring& path, const Gdk::Rectangle& background_area, const Gdk::Rectangle& cell_area, CellRendererState flags);
 
  
  CellEditable* start_editing(GdkEvent* event, Widget& widget, const Glib::ustring& path, const Gdk::Rectangle& background_area, const Gdk::Rectangle& cell_area, CellRendererState flags =  CellRendererState(0));
 
  
  void set_fixed_size(int width, int height);
  
  void get_fixed_size(int& width, int& height) const;
 
  
  void set_alignment(float xalign, float yalign);
  
  void get_alignment(float& xalign, float& yalign) const;
 
  
  void set_padding(int xpad, int ypad);
  
  void get_padding(int& xpad, int& ypad) const;
 
  
  void set_visible(bool visible =  true);
  
  bool get_visible() const;
  
  void set_sensitive(bool sensitive =  true);
  
  bool get_sensitive() const;
 
  
#ifndef GTKMM_DISABLE_DEPRECATED
 
  void editing_canceled();
#endif // GTKMM_DISABLE_DEPRECATED
 
 
  void stop_editing(bool canceled =  false);
 
  virtual Glib::PropertyProxy_Base _property_renderable();
 
  
  Glib::SignalProxy0< void > signal_editing_canceled();
 
 
  //We use no_default_handler for this, because we can not add a new vfunc to 2.5 without breaking ABI.
  //TODO: Remove no_default_handler when we do an ABI-break-with-parallel-install.
  //TODO: Remove the warning in the documentation when we have fixed the inheritance of CellRendererCombo.
  
  Glib::SignalProxy2< void,CellEditable*,const Glib::ustring& > signal_editing_started();
 
 
  Glib::PropertyProxy< CellRendererMode > property_mode() ;
 
  Glib::PropertyProxy_ReadOnly< CellRendererMode > property_mode() const;
 
  Glib::PropertyProxy< bool > property_visible() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_visible() const;
 
  Glib::PropertyProxy< bool > property_sensitive() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_sensitive() const;
 
  Glib::PropertyProxy< float > property_xalign() ;
 
  Glib::PropertyProxy_ReadOnly< float > property_xalign() const;
 
  Glib::PropertyProxy< float > property_yalign() ;
 
  Glib::PropertyProxy_ReadOnly< float > property_yalign() const;
 
  Glib::PropertyProxy< unsigned int > property_xpad() ;
 
  Glib::PropertyProxy_ReadOnly< unsigned int > property_xpad() const;
 
  Glib::PropertyProxy< unsigned int > property_ypad() ;
 
  Glib::PropertyProxy_ReadOnly< unsigned int > property_ypad() const;
 
  Glib::PropertyProxy< int > property_width() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_width() const;
 
  Glib::PropertyProxy< int > property_height() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_height() const;
 
  Glib::PropertyProxy< bool > property_is_expander() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_is_expander() const;
 
  Glib::PropertyProxy< bool > property_is_expanded() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_is_expanded() const;
 
  Glib::PropertyProxy_WriteOnly< Glib::ustring > property_cell_background() ;
 
 
  Glib::PropertyProxy< Gdk::Color > property_cell_background_gdk() ;
 
  Glib::PropertyProxy_ReadOnly< Gdk::Color > property_cell_background_gdk() const;
 
  Glib::PropertyProxy< bool > property_cell_background_set() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_cell_background_set() const;
 
  Glib::PropertyProxy_ReadOnly< bool > property_editing() const;
 
 
protected:
  CellRenderer();
 
    virtual void get_size_vfunc(Widget& widget, const Gdk::Rectangle* cell_area, int* x_offset, int* y_offset, int* width, int* height) const;
 
 
    virtual void render_vfunc(const Glib::RefPtr<Gdk::Drawable>& window, Widget& widget, const Gdk::Rectangle& background_area, const Gdk::Rectangle& cell_area, const Gdk::Rectangle& expose_area, CellRendererState flags);
 
 
    virtual bool activate_vfunc(GdkEvent* event, Widget& widget, const Glib::ustring& path, const Gdk::Rectangle& background_area, const Gdk::Rectangle& cell_area, CellRendererState flags);
 
 
    virtual CellEditable* start_editing_vfunc(GdkEvent* event, Widget& widget, const Glib::ustring& path, const Gdk::Rectangle& background_area, const Gdk::Rectangle& cell_area, CellRendererState flags);
 
 
};
 
} // namespace Gtk
 
 
namespace Glib
{
  Gtk::CellRenderer* wrap(GtkCellRenderer* object, bool take_copy = false);
} //namespace Glib
 
 
#endif /* _GTKMM_CELLRENDERER_H */