// -*- c++ -*- // Generated by gtkmmproc -- DO NOT MODIFY! #ifndef _GDKMM_GC_H #define _GDKMM_GC_H #include /* $Id$ */ /* gc.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 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. */ #include #include #include #include #include #include #include #ifndef DOXYGEN_SHOULD_SKIP_THIS typedef struct _GdkGC GdkGC; typedef struct _GdkGCClass GdkGCClass; #endif /* DOXYGEN_SHOULD_SKIP_THIS */ namespace Gdk { class GC_Class; } // namespace Gdk namespace Gdk { /** @addtogroup gdkmmEnums Enums and Flags */ /** * @ingroup gdkmmEnums */ enum LineStyle { LINE_SOLID, LINE_ON_OFF_DASH, LINE_DOUBLE_DASH }; } // namespace Gdk #ifndef DOXYGEN_SHOULD_SKIP_THIS namespace Glib { template <> class Value : public Glib::Value_Enum { public: static GType value_type() G_GNUC_CONST; }; } // namespace Glib #endif /* DOXYGEN_SHOULD_SKIP_THIS */ namespace Gdk { /** * @ingroup gdkmmEnums */ enum CapStyle { CAP_NOT_LAST, CAP_BUTT, CAP_ROUND, CAP_PROJECTING }; } // namespace Gdk #ifndef DOXYGEN_SHOULD_SKIP_THIS namespace Glib { template <> class Value : public Glib::Value_Enum { public: static GType value_type() G_GNUC_CONST; }; } // namespace Glib #endif /* DOXYGEN_SHOULD_SKIP_THIS */ namespace Gdk { /** * @ingroup gdkmmEnums */ enum JoinStyle { JOIN_MITER, JOIN_ROUND, JOIN_BEVEL }; } // namespace Gdk #ifndef DOXYGEN_SHOULD_SKIP_THIS namespace Glib { template <> class Value : public Glib::Value_Enum { public: static GType value_type() G_GNUC_CONST; }; } // namespace Glib #endif /* DOXYGEN_SHOULD_SKIP_THIS */ namespace Gdk { /** * @ingroup gdkmmEnums */ enum Fill { SOLID, TILED, STIPPLED, OPAQUE_STIPPLED }; } // namespace Gdk #ifndef DOXYGEN_SHOULD_SKIP_THIS namespace Glib { template <> class Value : public Glib::Value_Enum { public: static GType value_type() G_GNUC_CONST; }; } // namespace Glib #endif /* DOXYGEN_SHOULD_SKIP_THIS */ namespace Gdk { /** * @ingroup gdkmmEnums */ enum Function { COPY, INVERT, XOR, CLEAR, AND, AND_REVERSE, AND_INVERT, NOOP, OR, EQUIV, OR_REVERSE, COPY_INVERT, OR_INVERT, NAND, NOR, SET }; } // namespace Gdk #ifndef DOXYGEN_SHOULD_SKIP_THIS namespace Glib { template <> class Value : public Glib::Value_Enum { public: static GType value_type() G_GNUC_CONST; }; } // namespace Glib #endif /* DOXYGEN_SHOULD_SKIP_THIS */ namespace Gdk { /** * @ingroup gdkmmEnums */ enum SubwindowMode { CLIP_BY_CHILDREN, INCLUDE_INFERIORS }; } // namespace Gdk #ifndef DOXYGEN_SHOULD_SKIP_THIS namespace Glib { template <> class Value : public Glib::Value_Enum { public: static GType value_type() G_GNUC_CONST; }; } // namespace Glib #endif /* DOXYGEN_SHOULD_SKIP_THIS */ namespace Gdk { /** * @ingroup gdkmmEnums * @par Bitwise operators: * %GCValuesMask operator|(GCValuesMask, GCValuesMask)
* %GCValuesMask operator&(GCValuesMask, GCValuesMask)
* %GCValuesMask operator^(GCValuesMask, GCValuesMask)
* %GCValuesMask operator~(GCValuesMask)
* %GCValuesMask& operator|=(GCValuesMask&, GCValuesMask)
* %GCValuesMask& operator&=(GCValuesMask&, GCValuesMask)
* %GCValuesMask& operator^=(GCValuesMask&, GCValuesMask)
*/ enum GCValuesMask { GC_FOREGROUND = 1 << 0, GC_BACKGROUND = 1 << 1, GC_FONT = 1 << 2, GC_FUNCTION = 1 << 3, GC_FILL = 1 << 4, GC_TILE = 1 << 5, GC_STIPPLE = 1 << 6, GC_CLIP_MASK = 1 << 7, GC_SUBWINDOW = 1 << 8, GC_TS_X_ORIGIN = 1 << 9, GC_TS_Y_ORIGIN = 1 << 10, GC_CLIP_X_ORIGIN = 1 << 11, GC_CLIP_Y_ORIGIN = 1 << 12, GC_EXPOSURES = 1 << 13, GC_LINE_WIDTH = 1 << 14, GC_LINE_STYLE = 1 << 15, GC_CAP_STYLE = 1 << 16, GC_JOIN_STYLE = 1 << 17 }; /** @ingroup gdkmmEnums */ inline GCValuesMask operator|(GCValuesMask lhs, GCValuesMask rhs) { return static_cast(static_cast(lhs) | static_cast(rhs)); } /** @ingroup gdkmmEnums */ inline GCValuesMask operator&(GCValuesMask lhs, GCValuesMask rhs) { return static_cast(static_cast(lhs) & static_cast(rhs)); } /** @ingroup gdkmmEnums */ inline GCValuesMask operator^(GCValuesMask lhs, GCValuesMask rhs) { return static_cast(static_cast(lhs) ^ static_cast(rhs)); } /** @ingroup gdkmmEnums */ inline GCValuesMask operator~(GCValuesMask flags) { return static_cast(~static_cast(flags)); } /** @ingroup gdkmmEnums */ inline GCValuesMask& operator|=(GCValuesMask& lhs, GCValuesMask rhs) { return (lhs = static_cast(static_cast(lhs) | static_cast(rhs))); } /** @ingroup gdkmmEnums */ inline GCValuesMask& operator&=(GCValuesMask& lhs, GCValuesMask rhs) { return (lhs = static_cast(static_cast(lhs) & static_cast(rhs))); } /** @ingroup gdkmmEnums */ inline GCValuesMask& operator^=(GCValuesMask& lhs, GCValuesMask rhs) { return (lhs = static_cast(static_cast(lhs) ^ static_cast(rhs))); } } // namespace Gdk #ifndef DOXYGEN_SHOULD_SKIP_THIS namespace Glib { template <> class Value : public Glib::Value_Flags { public: static GType value_type() G_GNUC_CONST; }; } // namespace Glib #endif /* DOXYGEN_SHOULD_SKIP_THIS */ namespace Gdk { class Drawable; /** All drawing operations in GDK take a graphics context (GC) argument. * A graphics context encapsulates information about the way things are drawn, such as the foreground color or line width. * By using graphics contexts, the number of arguments to each drawing call is greatly reduced, and communication overhead * is minimized, since identical arguments do not need to be passed repeatedly. */ class GC : public Glib::Object { #ifndef DOXYGEN_SHOULD_SKIP_THIS public: typedef GC CppObjectType; typedef GC_Class CppClassType; typedef GdkGC BaseObjectType; typedef GdkGCClass BaseClassType; private: friend class GC_Class; static CppClassType gc_class_; private: // noncopyable GC(const GC&); GC& operator=(const GC&); protected: explicit GC(const Glib::ConstructParams& construct_params); explicit GC(GdkGC* castitem); #endif /* DOXYGEN_SHOULD_SKIP_THIS */ public: virtual ~GC(); #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 GObject. GdkGC* gobj() { return reinterpret_cast(gobject_); } ///Provides access to the underlying C GObject. const GdkGC* gobj() const { return reinterpret_cast(gobject_); } ///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. GdkGC* gobj_copy(); private: protected: GC(); explicit GC(const Glib::RefPtr& drawable); public: static Glib::RefPtr create(); static Glib::RefPtr create(const Glib::RefPtr& drawable); // Custom wrap these?, maybe with a Gdk::GC::Value class. Need to do take care of refcounts of GdkGCValue's fields. // Actually, I don't see the need for these methods. murrayc. //_WRAP_METHOD(void get_values(GdkGCValues& values) const, gdk_gc_get_values) //_WRAP_METHOD(void set_values(const GdkGCValues& values, GCValuesMask values_mask), gdk_gc_set_values) //__IGNORE(gdk_gc_get_values, gdk_gc_set_values) /** Sets the foreground color for a graphics context. * Note that this function uses @a color ->pixel, use * set_rgb_fg_color() to specify the foreground * color as red, green, blue components. * @param color The new foreground color. */ void set_foreground(const Color& color); /** Sets the background color for a graphics context. * Note that this function uses @a color ->pixel, use * set_rgb_bg_color() to specify the background * color as red, green, blue components. * @param color The new background color. */ void set_background(const Color& color); /** Determines how the current pixel values and the * pixel values being drawn are combined to produce * the final pixel values. * @param function The Gdk::Function to use. */ void set_function(Function function); /** Set the fill mode for a graphics context. * @param fill The new fill mode. */ void set_fill(Fill fill); /** Set a tile pixmap for a graphics context. * This will only be used if the fill mode * is Gdk::TILED. * @param tile The new tile pixmap. */ void set_tile(const Glib::RefPtr& tile); /** Set the stipple bitmap for a graphics context. The * stipple will only be used if the fill mode is * Gdk::STIPPLED or Gdk::OPAQUE_STIPPLED. * @param stipple The new stipple bitmap. */ void set_stipple(const Glib::RefPtr& stipple); /** Set the origin when using tiles or stipples with * the GC. The tile or stipple will be aligned such * that the upper left corner of the tile or stipple * will coincide with this point. * @param x The x-coordinate of the origin. * @param y The y-coordinate of the origin. */ void set_ts_origin(int x, int y); /** Sets the origin of the clip mask. The coordinates are * interpreted relative to the upper-left corner of * the destination drawable of the current operation. * @param x The x-coordinate of the origin. * @param y The y-coordinate of the origin. */ void set_clip_origin(int x, int y); /** Sets the clip mask for a graphics context from a bitmap. * The clip mask is interpreted relative to the clip * origin. (See set_clip_origin()). * @param mask A bitmap. */ void set_clip_mask(const Glib::RefPtr& mask); /** @deprecated Use set_clip_rectangle(const Rectangle& rectangle) instead. */ /** Sets the clip mask for a graphics context from a * rectangle. The clip mask is interpreted relative to the clip * origin. (See set_clip_origin()). * @param rectangle The rectangle to clip to. */ void set_clip_rectangle(Rectangle& rectangle); /** Sets the clip mask for a graphics context from a * rectangle. The clip mask is interpreted relative to the clip * origin. (See set_clip_origin()). * @param rectangle The rectangle to clip to. */ void set_clip_rectangle(const Rectangle& rectangle); /** Sets the clip mask for a graphics context from a region structure. * The clip mask is interpreted relative to the clip origin. (See * set_clip_origin()). * @param region The Gdk::Region. */ void set_clip_region(const Region& region); /** Sets how drawing with this GC on a window will affect child * windows of that window. * @param mode The subwindow mode. */ void set_subwindow(SubwindowMode mode); /** Sets whether copying non-visible portions of a drawable * using this graphics context generate exposure events * for the corresponding regions of the destination * drawable. (See gdk_draw_drawable()). * @param exposures If true, exposure events will be generated. */ void set_exposures(bool exposures); /** Sets various attributes of how lines are drawn. See * the corresponding members of Gdk::GCValues for full * explanations of the arguments. * @param line_width The width of lines. * @param line_style The dash-style for lines. * @param cap_style The manner in which the ends of lines are drawn. * @param join_style The in which lines are joined together. */ void set_line_attributes(int line_width, LineStyle line_style, CapStyle cap_style, JoinStyle join_style); /** Sets the way dashed-lines are drawn. Lines will be * drawn with alternating on and off segments of the * lengths specified in @a dash_list . The manner in * which the on and off segments are drawn is determined * by the @a line_style value of the GC. (This can * be changed with set_line_attributes().) * * The @a dash_offset defines the phase of the pattern, * specifying how many pixels into the dash-list the pattern * should actually begin. * @param dash_offset The phase of the dash pattern. * @param dash_list An array of dash lengths. * @param n The number of elements in @a dash_list . */ void set_dashes(int dash_offset, gint8* dash_list, int n); /** Offset attributes such as the clip and tile-stipple origins * of the GC so that drawing at x - x_offset, y - y_offset with * the offset GC has the same effect as drawing at x, y with the original * GC. * @param x_offset Amount by which to offset the GC in the X direction. * @param y_offset Amount by which to offset the GC in the Y direction. */ void offset(int x_offset, int y_offset); /** Sets the colormap for the GC to the given colormap. The depth * of the colormap's visual must match the depth of the drawable * for which the GC was created. * @param colormap A Gdk::Colormap. */ void set_colormap(const Glib::RefPtr& colormap); /** Retrieves the colormap for a given GC, if it exists. * A GC will have a colormap if the drawable for which it was created * has a colormap, or if a colormap was set explicitely with * gdk_gc_set_colormap. * @return The colormap of @a gc , or 0 if @a gc doesn't have one. */ Glib::RefPtr get_colormap(); /** Set the foreground color of a GC using an unallocated color. The * pixel value for the color will be determined using GdkRGB. If the * colormap for the GC has not previously been initialized for GdkRGB, * then for pseudo-color colormaps (colormaps with a small modifiable * number of colors), a colorcube will be allocated in the colormap. * * Calling this function for a GC without a colormap is an error. * @param color An unallocated Gdk::Color. */ void set_rgb_fg_color(const Color& color); /** Set the background color of a GC using an unallocated color. The * pixel value for the color will be determined using GdkRGB. If the * colormap for the GC has not previously been initialized for GdkRGB, * then for pseudo-color colormaps (colormaps with a small modifiable * number of colors), a colorcube will be allocated in the colormap. * * Calling this function for a GC without a colormap is an error. * @param color An unallocated Gdk::Color. */ void set_rgb_bg_color(const Color& color); /** Gets the Gdk::Screen for which @a gc was created * @return The Gdk::Screen for @a gc . * * @newin2p2. */ Glib::RefPtr get_screen(); /** Gets the Gdk::Screen for which @a gc was created * @return The Gdk::Screen for @a gc . * * @newin2p2. */ Glib::RefPtr get_screen() const; public: public: //C++ methods used to invoke GTK+ virtual functions: #ifdef GLIBMM_VFUNCS_ENABLED #endif //GLIBMM_VFUNCS_ENABLED protected: //GTK+ Virtual Functions (override these to change behaviour): #ifdef GLIBMM_VFUNCS_ENABLED #endif //GLIBMM_VFUNCS_ENABLED //Default Signal Handlers:: #ifdef GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED #endif //GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED }; } /* namespace Gdk */ namespace Glib { /** @relates Gdk::GC * @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. */ Glib::RefPtr wrap(GdkGC* object, bool take_copy = false); } #endif /* _GDKMM_GC_H */