libgtksourceviewmm-3.0-dev 3.2.0-1ubuntu1 / usr / include / gtksourceviewmm-3.0 / gtksourceviewmm / gutterrendererpixbuf.h

// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _GTKSOURCEVIEWMM_GUTTERRENDERERPIXBUF_H
#define _GTKSOURCEVIEWMM_GUTTERRENDERERPIXBUF_H


#include <glibmm.h>

/* gutterrendererpixbuf.h
 *
 * Copyright (C) 2010, 2011 Krzesimir Nowak
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/// \file
/// \brief GutterRendererPixbuf class

#include <glibmm/refptr.h>
#include <gdkmm/pixbuf.h>
#include <gtksourceviewmm/gutterrenderer.h>


#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkSourceGutterRendererPixbuf GtkSourceGutterRendererPixbuf;
typedef struct _GtkSourceGutterRendererPixbufClass GtkSourceGutterRendererPixbufClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */


namespace Gsv
{ class GutterRendererPixbuf_Class; } // namespace Gsv
namespace Gsv
{

// TODO: write docs.

class GutterRendererPixbuf : public GutterRenderer
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef GutterRendererPixbuf CppObjectType;
  typedef GutterRendererPixbuf_Class CppClassType;
  typedef GtkSourceGutterRendererPixbuf BaseObjectType;
  typedef GtkSourceGutterRendererPixbufClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

  virtual ~GutterRendererPixbuf();

#ifndef DOXYGEN_SHOULD_SKIP_THIS

private:
  friend class GutterRendererPixbuf_Class;
  static CppClassType gutterrendererpixbuf_class_;

  // noncopyable
  GutterRendererPixbuf(const GutterRendererPixbuf&);
  GutterRendererPixbuf& operator=(const GutterRendererPixbuf&);

protected:
  explicit GutterRendererPixbuf(const Glib::ConstructParams& construct_params);
  explicit GutterRendererPixbuf(GtkSourceGutterRendererPixbuf* 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

  ///Provides access to the underlying C GtkObject.
  GtkSourceGutterRendererPixbuf*       gobj()       { return reinterpret_cast<GtkSourceGutterRendererPixbuf*>(gobject_); }

  ///Provides access to the underlying C GtkObject.
  const GtkSourceGutterRendererPixbuf* gobj() const { return reinterpret_cast<GtkSourceGutterRendererPixbuf*>(gobject_); }


public:
  //C++ methods used to invoke GTK+ virtual functions:

protected:
  //GTK+ Virtual Functions (override these to change behaviour):

  //Default Signal Handlers::


private:

public:
  GutterRendererPixbuf();

  
  /** Get the pixbuf of the renderer.
   * @return A Gdk::Pixbuf.
   */
  Glib::RefPtr<Gdk::Pixbuf> get_pixbuf();

  
  /** Get the pixbuf of the renderer.
   * @return A Gdk::Pixbuf.
   */
  Glib::RefPtr<const Gdk::Pixbuf> get_pixbuf() const;

 
  void set_pixbuf(const Glib::RefPtr<const Gdk::Pixbuf>& pixbuf);

  
  std::string get_stock_id() const;

  
  void set_stock_id(const std::string& stock_id);

 
  /** Get the gicon of the renderer
   * @return A Icon.
   */
  Glib::RefPtr<Gio::Icon> get_icon();

  
  /** Get the gicon of the renderer
   * @return A Icon.
   */
  Glib::RefPtr<const Gio::Icon> get_icon() const;

 
  void set_icon(const Glib::RefPtr<Gio::Icon>& icon);

  
  std::string get_icon_name() const;

  
  void set_icon_name(const std::string& icon_name);

  #ifdef GLIBMM_PROPERTIES_ENABLED
/** The pixbuf.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
   * the value of the property changes.
   */
  Glib::PropertyProxy< Glib::RefPtr<Gdk::Pixbuf> > property_pixbuf() ;
#endif //#GLIBMM_PROPERTIES_ENABLED

#ifdef GLIBMM_PROPERTIES_ENABLED
/** The pixbuf.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
   * the value of the property changes.
   */
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Pixbuf> > property_pixbuf() const;
#endif //#GLIBMM_PROPERTIES_ENABLED

  #ifdef GLIBMM_PROPERTIES_ENABLED
/** The stock id.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
   * the value of the property changes.
   */
  Glib::PropertyProxy<std::string> property_stock_id() ;
#endif //#GLIBMM_PROPERTIES_ENABLED

#ifdef GLIBMM_PROPERTIES_ENABLED
/** The stock id.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
   * the value of the property changes.
   */
  Glib::PropertyProxy_ReadOnly<std::string> property_stock_id() const;
#endif //#GLIBMM_PROPERTIES_ENABLED

  #ifdef GLIBMM_PROPERTIES_ENABLED
/** The icon name.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
   * the value of the property changes.
   */
  Glib::PropertyProxy<std::string> property_icon_name() ;
#endif //#GLIBMM_PROPERTIES_ENABLED

#ifdef GLIBMM_PROPERTIES_ENABLED
/** The icon name.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
   * the value of the property changes.
   */
  Glib::PropertyProxy_ReadOnly<std::string> property_icon_name() const;
#endif //#GLIBMM_PROPERTIES_ENABLED

  #ifdef GLIBMM_PROPERTIES_ENABLED
/** The gicon.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
   * the value of the property changes.
   */
  Glib::PropertyProxy< Glib::RefPtr<Gio::Icon> > property_gicon() ;
#endif //#GLIBMM_PROPERTIES_ENABLED

#ifdef GLIBMM_PROPERTIES_ENABLED
/** The gicon.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
   * the value of the property changes.
   */
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gio::Icon> > property_gicon() const;
#endif //#GLIBMM_PROPERTIES_ENABLED


};

} // namespace Gsv


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 Gsv::GutterRendererPixbuf
   */
  Gsv::GutterRendererPixbuf* wrap(GtkSourceGutterRendererPixbuf* object, bool take_copy = false);
} //namespace Glib


#endif /* _GTKSOURCEVIEWMM_GUTTERRENDERERPIXBUF_H */