tk/ytkmm/ytkmm/gtkmm/image.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_IMAGE_H
#define _GTKMM_IMAGE_H
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: image.hg,v 1.9 2006/04/12 11:11:25 murrayc Exp $ */
 
/* image.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/misc.h>
#include <gtkmm/iconset.h>
#include <gdkmm/pixbufanimation.h>
#include <giomm/icon.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkImage GtkImage;
typedef struct _GtkImageClass GtkImageClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{ class Image_Class; } // namespace Gtk
namespace Gtk
{
 
 
enum ImageType
{
  IMAGE_EMPTY,
  IMAGE_PIXMAP,
  IMAGE_IMAGE,
  IMAGE_PIXBUF,
  IMAGE_STOCK,
  IMAGE_ICON_SET,
  IMAGE_ANIMATION,
  IMAGE_ICON_NAME,
  IMAGE_GICON
};
 
} // namespace Gtk
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
 
template <>
class Value<Gtk::ImageType> : public Glib::Value_Enum<Gtk::ImageType>
{
public:
  static GType value_type() G_GNUC_CONST;
};
 
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{
 
 
class Image : public Misc
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef Image CppObjectType;
  typedef Image_Class CppClassType;
  typedef GtkImage BaseObjectType;
  typedef GtkImageClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
  virtual ~Image();
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
private:
  friend class Image_Class;
  static CppClassType image_class_;
 
  // noncopyable
  Image(const Image&);
  Image& operator=(const Image&);
 
protected:
  explicit Image(const Glib::ConstructParams& construct_params);
  explicit Image(GtkImage* 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
 
  GtkImage*       gobj()       { return reinterpret_cast<GtkImage*>(gobject_); }
 
  const GtkImage* gobj() const { return reinterpret_cast<GtkImage*>(gobject_); }
 
 
public:
  //C++ methods used to invoke GTK+ virtual functions:
 
protected:
  //GTK+ Virtual Functions (override these to change behaviour):
 
  //Default Signal Handlers::
 
 
private:
 
  
public:
 
  Image();
 
  //TODO: The C documentation says that the constructor parameters can be NULL. Choose sensible method overloads.
 
    explicit Image(const Glib::RefPtr<Gdk::Pixmap>& pixmap, const Glib::RefPtr<Gdk::Bitmap>& mask);
 
 
    explicit Image(const Glib::RefPtr<Gdk::Image>& image, const Glib::RefPtr<Gdk::Bitmap>& mask);
 
 
    explicit Image(const std::string& file);
 
 
    explicit Image(const Glib::RefPtr<Gdk::Pixbuf>& pixbuf);
 
 
    explicit Image(const IconSet& icon_set, IconSize icon_size);
 
 
#ifndef GTKMM_DISABLE_DEPRECATED
 
    explicit Image(IconSet& icon_set, IconSize icon_size);
 
#endif // GTKMM_DISABLE_DEPRECATED
 
 
  //We don't wrap gtk_image_new_from_icon_name() to avoid a clash with the from-filename constructor.
  //But we do wrap gtk_image_set_from_icon_name()
  
 
  Image(const Gtk::StockID& stock_id, IconSize size);
  
  Image(const Glib::RefPtr<Gdk::PixbufAnimation>& animation);
 
  
  void set(const Glib::RefPtr<Gdk::Pixmap>& pixmap, const Glib::RefPtr<Gdk::Bitmap>& mask);
  
  void set(const Glib::RefPtr<Gdk::Image>& gdk_image, const Glib::RefPtr<Gdk::Bitmap>& mask);
  
  void set(const std::string& filename);
  
  void set(const Glib::RefPtr<Gdk::Pixbuf>& pixbuf);
  
  void set(const Gtk::StockID& stock_id, IconSize size);
  
  
#ifndef GTKMM_DISABLE_DEPRECATED
 
  void set(IconSet& icon_set, IconSize size);
#endif // GTKMM_DISABLE_DEPRECATED
 
 
  void set(const IconSet& icon_set, IconSize size);
 
  
  void set(const Glib::RefPtr<Gdk::PixbufAnimation>& animation);
  
  void set(const Glib::RefPtr<const Gio::Icon>& icon, IconSize size);
 
  
  void set_from_icon_name(const Glib::ustring& icon_name, IconSize size);
 
 
  void clear();
 
  
  ImageType get_storage_type() const;
 
  void get_pixmap(Glib::RefPtr<Gdk::Pixmap>& pixmap, Glib::RefPtr<Gdk::Bitmap>& mask) const;
  void get_image(Glib::RefPtr<Gdk::Image>& gdk_image, Glib::RefPtr<Gdk::Bitmap>& mask) const;
  
  Glib::RefPtr<Gdk::Pixbuf> get_pixbuf();
  
  Glib::RefPtr<const Gdk::Pixbuf> get_pixbuf() const;
  void get_stock(Gtk::StockID& stock_id, IconSize& size) const;
  void get_icon_set(IconSet& icon_set, IconSize& size) const;
  
  Glib::RefPtr<Gdk::PixbufAnimation> get_animation();
  
  Glib::RefPtr<const Gdk::PixbufAnimation> get_animation() const;
 
  Glib::RefPtr<Gio::Icon> get_gicon(Gtk::IconSize& icon_size);
 
  Glib::RefPtr<const Gio::Icon> get_gicon(Gtk::IconSize& icon_size) const;
  
 
  Glib::ustring get_icon_name() const;
  Glib::ustring get_icon_name(IconSize& size);
  
 
  int get_pixel_size() const;
 
  void set_pixel_size(int pixel_size);
 
  Glib::PropertyProxy< Glib::RefPtr<Gdk::Pixbuf> > property_pixbuf() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Pixbuf> > property_pixbuf() const;
 
  Glib::PropertyProxy< Glib::RefPtr<Gdk::Pixmap> > property_pixmap() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Pixmap> > property_pixmap() const;
 
  Glib::PropertyProxy< Glib::RefPtr<Gdk::Image> > property_image() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Image> > property_image() const;
 
  Glib::PropertyProxy< Glib::RefPtr<Gdk::Pixmap> > property_mask() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Pixmap> > property_mask() const;
 
  Glib::PropertyProxy< Glib::ustring > property_file() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_file() const;
 
  Glib::PropertyProxy< Glib::ustring > property_stock() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_stock() const;
 
  Glib::PropertyProxy< Gtk::IconSet > property_icon_set() ;
 
  Glib::PropertyProxy_ReadOnly< Gtk::IconSet > property_icon_set() const;
 
  Glib::PropertyProxy< int > property_icon_size() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_icon_size() const;
 
  Glib::PropertyProxy< int > property_pixel_size() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_pixel_size() const;
 
  Glib::PropertyProxy< Glib::RefPtr<Gdk::PixbufAnimation> > property_pixbuf_animation() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::PixbufAnimation> > property_pixbuf_animation() const;
 
  Glib::PropertyProxy< Glib::ustring > property_icon_name() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_icon_name() const;
 
  Glib::PropertyProxy_ReadOnly< ImageType > property_storage_type() const;
 
 
  Glib::PropertyProxy< Glib::RefPtr<Gio::Icon> > property_gicon() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gio::Icon> > property_gicon() const;
 
 
};
 
} /* namespace Gtk */
 
 
namespace Glib
{
  Gtk::Image* wrap(GtkImage* object, bool take_copy = false);
} //namespace Glib
 
 
#endif /* _GTKMM_IMAGE_H */