tk/ydkmm/ydkmm/gdkmm/image.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GDKMM_IMAGE_H
#define _GDKMM_IMAGE_H
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: image.hg,v 1.5 2006/04/12 11:11:24 murrayc Exp $ */
 
/* bitmap.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 <glibmm/object.h>
#include <gdkmm/visual.h>
#include <gdkmm/colormap.h>
#include <gdkmm/types.h> //For ByteOrder.
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GdkImage GdkImage;
typedef struct _GdkImageClass GdkImageClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gdk
{ class Image_Class; } // namespace Gdk
#endif //DOXYGEN_SHOULD_SKIP_THIS
 
namespace Gdk
{
 
enum ImageType
{
  IMAGE_NORMAL,
  IMAGE_SHARED,
  IMAGE_FASTEST
};
 
} // namespace Gdk
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
 
template <>
class Value<Gdk::ImageType> : public Glib::Value_Enum<Gdk::ImageType>
{
public:
  static GType value_type() G_GNUC_CONST;
};
 
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gdk
{
 
 
class Image : public Glib::Object
{
  
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
public:
  typedef Image CppObjectType;
  typedef Image_Class CppClassType;
  typedef GdkImage BaseObjectType;
  typedef GdkImageClass BaseClassType;
 
private:  friend class Image_Class;
  static CppClassType image_class_;
 
private:
  // noncopyable
  Image(const Image&);
  Image& operator=(const Image&);
 
protected:
  explicit Image(const Glib::ConstructParams& construct_params);
  explicit Image(GdkImage* castitem);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
  virtual ~Image();
 
  static GType get_type()      G_GNUC_CONST;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
 
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GdkImage*       gobj()       { return reinterpret_cast<GdkImage*>(gobject_); }
 
  const GdkImage* gobj() const { return reinterpret_cast<GdkImage*>(gobject_); }
 
  GdkImage* gobj_copy();
 
private:
 
  
protected:
 
  Image(ImageType type, const Glib::RefPtr<Visual>& visual, int width, int height);
  
 
public:
  
  static Glib::RefPtr<Image> create(ImageType type, const Glib::RefPtr<Visual>& visual, int width, int height);
 
 
  //We ignore gdk_image_new_bitmap() because the documentation says that it is deprecated.
  
 
  void put_pixel(int x, int y, guint32 pixel);
  
  guint32 get_pixel(int x, int y) const;
  
  void set_colormap(const Glib::RefPtr<Colormap>& colormap);
  
  Glib::RefPtr<Colormap> get_colormap();
  
  Glib::RefPtr<const Colormap> get_colormap() const;
 
  
  ImageType get_image_type() const;
  
  Glib::RefPtr<Visual> get_visual();
  
  Glib::RefPtr<const Visual> get_visual() const;
  
  ByteOrder get_byte_order() const;
  
  int get_width() const;
  
  int get_height() const;
  
  guint16 get_depth() const;
 
  
#ifndef GDKMM_DISABLE_DEPRECATED
 
  guint16 get_bpp() const;
#endif // GDKMM_DISABLE_DEPRECATED
 
 
  guint16 get_bytes_per_pixel() const;
 
  
#ifndef GDKMM_DISABLE_DEPRECATED
 
  guint16 get_bpl() const;
#endif // GDKMM_DISABLE_DEPRECATED
 
 
  guint16 get_bytes_per_line() const;
 
  
  guint16 get_bits_per_pixel() const;
 
  
  void* get_pixels();
  
  const void* get_pixels() const;
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  //This memory block is not read-only, apparently:
   void* get_mem();
  const void* get_mem() const;
 #endif // GDKMM_DISABLE_DEPRECATED
 
 
  //TODO: This should be const really.
   void* get_windowing_data() const;
 
 
public:
 
public:
  //C++ methods used to invoke GTK+ virtual functions:
 
protected:
  //GTK+ Virtual Functions (override these to change behaviour):
 
  //Default Signal Handlers::
 
 
};
 
} /* namespace Gdk */
 
 
namespace Glib
{
  Glib::RefPtr<Gdk::Image> wrap(GdkImage* object, bool take_copy = false);
}
 
 
#endif /* _GDKMM_IMAGE_H */