drawable.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GDKMM_DRAWABLE_H
#define _GDKMM_DRAWABLE_H
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: drawable.hg,v 1.12 2006/12/03 17:21:37 murrayc Exp $ */
 
/* 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 <pangomm/font.h>
#include <pangomm/layout.h>
#include <pangomm/layoutline.h>
#include <pangomm/glyphstring.h>
#include <gdkmm/region.h>
#include <gdkmm/gc.h>
#include <gdkmm/image.h>
#include <gdkmm/color.h>
#include <gdkmm/rgbcmap.h>
#include <gdkmm/types.h>
#include <cairomm/context.h>
//#include <gdkmm/pixbuf.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GdkDrawable GdkDrawable;
typedef struct _GdkDrawableClass GdkDrawableClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gdk
{ class Drawable_Class; } // namespace Gdk
#endif //DOXYGEN_SHOULD_SKIP_THIS
 
namespace Gdk
{
 
enum RgbDither
{
  RGB_DITHER_NONE,
  RGB_DITHER_NORMAL,
  RGB_DITHER_MAX
};
 
} // namespace Gdk
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
 
template <>
class Value<Gdk::RgbDither> : public Glib::Value_Enum<Gdk::RgbDither>
{
public:
  static GType value_type() G_GNUC_CONST;
};
 
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gdk
{
 
 
class GC;
class Pixbuf;
 
class Drawable : public Glib::Object
{
  
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
public:
  typedef Drawable CppObjectType;
  typedef Drawable_Class CppClassType;
  typedef GdkDrawable BaseObjectType;
  typedef GdkDrawableClass BaseClassType;
 
private:  friend class Drawable_Class;
  static CppClassType drawable_class_;
 
private:
  // noncopyable
  Drawable(const Drawable&);
  Drawable& operator=(const Drawable&);
 
protected:
  explicit Drawable(const Glib::ConstructParams& construct_params);
  explicit Drawable(GdkDrawable* castitem);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
  virtual ~Drawable();
 
  static GType get_type()      G_GNUC_CONST;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
 
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GdkDrawable*       gobj()       { return reinterpret_cast<GdkDrawable*>(gobject_); }
 
  const GdkDrawable* gobj() const { return reinterpret_cast<GdkDrawable*>(gobject_); }
 
  GdkDrawable* gobj_copy();
 
private:
 
  
protected:
  Drawable();
 
public:
  
  static Glib::RefPtr<Drawable> create();
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void get_size(int& width, int& height);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void get_size(int& width, int& height) const;
#endif // GDKMM_DISABLE_DEPRECATED
 
 
  int get_depth() const;
 
  
  void set_colormap(const Glib::RefPtr<Colormap>& colormap);
  
  Glib::RefPtr<Colormap> get_colormap();
  
#ifndef GDKMM_DISABLE_DEPRECATED
 
  Glib::RefPtr<Visual> get_visual();
#endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_point(const Glib::RefPtr<const GC>& gc, int x, int y);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
  #ifndef GDKMM_DISABLE_DEPRECATED
 
  //TODO: Mention C++ API in the deprecation comment.
  void draw_points(const Glib::RefPtr<const GC>& gc, const Glib::ArrayHandle<Point>& points);
  #endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_line(const Glib::RefPtr<const GC>& gc, int x1, int y1, int x2, int y2);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
  #ifndef GDKMM_DISABLE_DEPRECATED
 
  //TODO: Mention C++ API in the deprecation comment.
  void draw_lines(const Glib::RefPtr<const GC>& gc, const Glib::ArrayHandle<Point>& points);
  #endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_rectangle(const Glib::RefPtr<const GC>& gc, bool filled, int x, int y, int width, int height);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_arc(const Glib::RefPtr<const GC>& gc, bool filled, int x, int y, int width, int height, int angle1, int angle2);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
  void draw_polygon(const Glib::RefPtr<const GC>& gc, bool filled, const Glib::ArrayHandle<Point>& points);
 
  
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_drawable(const Glib::RefPtr<const GC>& gc, const Glib::RefPtr<const Drawable>& src, int xsrc, int ysrc, int xdest, int ydest, int width =  -1, int height =  -1);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_image(const Glib::RefPtr<const GC>& gc, const Glib::RefPtr<const Image>& image, int xsrc, int ysrc, int xdest, int ydest, int width =  -1, int height =  -1);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
  //segs is an array, and this function will be used so little that it doesn't seem worth wrapping it to use a container of C++ types.
  //Note: The segs parameter was made const in GTK+ 2.16, but we can't change that in our C++ API. TODO: Change it when we can do an ABI break.
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_segments(const Glib::RefPtr<const GC>& gc, GdkSegment* segs, int n_segs);
#endif // GDKMM_DISABLE_DEPRECATED
 
 // TODO
 
  //glyphs is not an array. I went down to pango_xft_render in pango and saw that PangoGlyphString here is not an array. -Bryan
  
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_glyphs(const Glib::RefPtr<const GC>& gc, const Glib::RefPtr<const Pango::Font>& font, int x, int y, const Pango::GlyphString& glyphs);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_layout_line(const Glib::RefPtr<const GC>& gc, int x, int y, const Glib::RefPtr<const Pango::LayoutLine>& line);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_layout_line(const Glib::RefPtr<const GC>& gc, int x, int y, const Glib::RefPtr<const Pango::LayoutLine>& line, const Color& foreground, const Color& background);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_layout(const Glib::RefPtr<const GC>& gc, int x, int y, const Glib::RefPtr<const Pango::Layout>& layout);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_layout(const Glib::RefPtr<const GC>& gc, int x, int y, const Glib::RefPtr<const Pango::Layout>& layout, const Color& foreground, const Color& background);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
//Note: The pixbuf parameter was made const in GTK+ 2.16, but we can't change that in our C++ API. TODO: Change it when we can do an ABI break.
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_pixbuf(const Glib::RefPtr<const GC>& gc, const Glib::RefPtr<Pixbuf>& pixbuf, int src_x, int src_y, int dest_x, int dest_y, int width, int height, RgbDither dither, int x_dither, int y_dither);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
  #ifndef GDKMM_DISABLE_DEPRECATED
 
  //TODO: Mention C++ API in the deprecation comment.
  void draw_pixbuf(const Glib::RefPtr<Pixbuf>& pixbuf,
    int src_x, int src_y, int dest_x, int dest_y,
    int width, int height,
    RgbDither dither, int x_dither, int y_dither);
  #endif // GDKMM_DISABLE_DEPRECATED
 
 
  // Note: This has no 'refreturn' because get_image() returns a newly created Image object.
  
  Glib::RefPtr<Image> get_image(int x, int y, int width, int height) const;
 
  // gdk_drawable_copy_to_image() returns a new GdkImage when the image parameter is NULL, but that seems to be much the
  // same as gdk_drawable_get_image().
  void copy_to_image(const Glib::RefPtr<Image>& image, int src_x, int src_y, int dest_x, int dest_y, int width, int height) const;
  
 
  Region get_clip_region() const;
  
  Region get_visible_region() const;
 
 
  // **** RGB stuff ****
 
  
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_rgb_image(const Glib::RefPtr<const GC>& gc, int x, int y, int width, int height, RgbDither dith, const guchar* rgb_buf, int rowstride);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_rgb_image_dithalign(const Glib::RefPtr<const GC>& gc, int x, int y, int width, int height, RgbDither dith, const guchar* rgb_buf, int rowstride, int xdith, int ydith);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_rgb_32_image(const Glib::RefPtr<const GC>& gc, int x, int y, int width, int height, RgbDither dith, const guchar* rgb_buf, int rowstride);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_rgb_32_image_dithalign(const Glib::RefPtr<const GC>& gc, int x, int y, int width, int height, RgbDither dith, const guchar* buf, int rowstride, int xdith, int ydith);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_gray_image(const Glib::RefPtr<const GC>& gc, int x, int y, int width, int height, RgbDither dith, const guchar* rgb_buf, int rowstride);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  void draw_indexed_image(const Glib::RefPtr<const GC>& gc, int x, int y, int width, int height, RgbDither dith, const guchar* rgb_buf, int rowstride, const RgbCmap& cmap);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  Glib::RefPtr<Screen> get_screen();
#endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  Glib::RefPtr<const Screen> get_screen() const;
#endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  Glib::RefPtr<Display> get_display();
#endif // GDKMM_DISABLE_DEPRECATED
 
 
#ifndef GDKMM_DISABLE_DEPRECATED
 
  Glib::RefPtr<const Display> get_display() const;
#endif // GDKMM_DISABLE_DEPRECATED
 
 
  Cairo::RefPtr<Cairo::Context> create_cairo_context();
 
 
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::Drawable> wrap(GdkDrawable* object, bool take_copy = false);
}
 
 
#endif /* _GDKMM_DRAWABLE_H */