home *** CD-ROM | disk | FTP | other *** search
- /*
- *
- * Copyright (C) 2003-2004 by the gtk2-perl team (see the file AUTHORS for the
- * full list)
- *
- * 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.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 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307 USA.
- *
- *
- * $Header: /cvsroot/gtk2-perl/gtk2-perl-xs/Gtk2/gtk2perl.h,v 1.37 2005/07/11 22:39:12 kaffeetisch Exp $
- */
-
- #ifndef _GTK2PERL_H_
- #define _GTK2PERL_H_
-
- #include <gperl.h>
- #include <gtk/gtk.h>
-
- #include "gtk2perl-versions.h"
-
- /* custom GType for GdkRegion */
- #ifndef GDK_TYPE_REGION
- # define GDK_TYPE_REGION (gtk2perl_gdk_region_get_type ())
- GType gtk2perl_gdk_region_get_type (void) G_GNUC_CONST;
- #endif
-
- /* custom GType for PangoLayoutIter */
- #ifndef PANGO_TYPE_LAYOUT_ITER
- # define PANGO_TYPE_LAYOUT_ITER (gtk2perl_pango_layout_iter_get_type ())
- GType gtk2perl_pango_layout_iter_get_type (void) G_GNUC_CONST;
- #endif
-
- /* custom GType for PangoScriptIter */
- #if PANGO_CHECK_VERSION (1, 4, 0)
- # ifndef PANGO_TYPE_SCRIPT_ITER
- # define PANGO_TYPE_SCRIPT_ITER (gtk2perl_pango_script_iter_get_type ())
- GType gtk2perl_pango_script_iter_get_type (void) G_GNUC_CONST;
- # endif
- #endif
-
- #include "gtk2perl-autogen.h"
-
- /* no plug/socket on non-X11 despite patches exist for years. */
- #ifndef GDK_WINDOWING_X11
- # undef GTK_TYPE_PLUG
- # undef GTK_TYPE_SOCKET
- #endif
-
- /**
- * gtk2perl_new_gtkobject:
- * @object: object to wrap.
- *
- * convenient wrapper around gperl_new_object() which always passes %TRUE
- * for gperl_new_object()'s "own" parameter. for #GtkObjects, that parameter
- * merely results in gtk_object_sink() being called; if the object was not
- * floating, this does nothing. thus, everything just works out.
- *
- * returns: scalar wrapper for @object.
- *
- * in xs/GtkObject.xs
- */
- SV * gtk2perl_new_gtkobject (GtkObject * object);
-
-
- /*
- custom handling for GdkBitmaps, since there are no typemacros for them.
- */
- /* GObject derivative GdkBitmap */
- #define SvGdkBitmap(sv) ((GdkBitmap*)gperl_get_object_check (sv, GDK_TYPE_DRAWABLE))
- typedef GdkBitmap GdkBitmap_ornull;
- #define SvGdkBitmap_ornull(sv) (((sv) && SvOK (sv)) ? SvGdkBitmap(sv) : NULL)
- typedef GdkBitmap GdkBitmap_noinc;
- /* these are real functions, rather than macros, because there's some extra
- * work involved in making sure it's blessed into Gtk2::Gdk::Bitmap when no
- * GType exists for GdkBitmap. */
- SV * newSVGdkBitmap (GdkBitmap * bitmap);
- SV * newSVGdkBitmap_noinc (GdkBitmap * bitmap);
- #define newSVGdkBitmap_ornull(b) (b ? newSVGdkBitmap (b) : Nullsv)
-
- /* exported for GtkGC */
- SV * newSVGdkGCValues (GdkGCValues * v);
- void SvGdkGCValues (SV * data, GdkGCValues * v, GdkGCValuesMask * m);
-
- /* exported for various other parts of pango */
- SV * newSVPangoRectangle (PangoRectangle * rectangle);
-
- /*
- * GdkAtom, an opaque pointer
- */
- SV * newSVGdkAtom (GdkAtom atom);
- GdkAtom SvGdkAtom (SV * sv);
-
- SV * newSVGtkTargetEntry (GtkTargetEntry * target_entry);
- /* do not store GtkTargetEntry objects returned from this function --
- * they are only good for the block of code in which they are created */
- GtkTargetEntry * SvGtkTargetEntry (SV * sv);
- void gtk2perl_read_gtk_target_entry (SV * sv, GtkTargetEntry * entry);
-
- #define GTK2PERL_STACK_ITEMS_TO_TARGET_ENTRY_ARRAY(first, targets, ntargets) \
- { \
- guint i; \
- if (items <= first) { \
- ntargets = 0; \
- targets = NULL; \
- } else { \
- ntargets = items - first; \
- targets = gperl_alloc_temp (sizeof (GtkTargetEntry) * ntargets); \
- for (i = 0 ; i < ntargets ; i++) \
- gtk2perl_read_gtk_target_entry (ST (i + first), \
- targets + i); \
- } \
- }
-
- /*
- * get a list of GTypes from the xsub argument stack
- * used to collect column types for creating and initializing GtkTreeStores
- * and GtkListStores.
- */
- #define GTK2PERL_STACK_ITEMS_TO_GTYPE_ARRAY(arrayvar, first, last) \
- (arrayvar) = g_array_new (FALSE, FALSE, sizeof (GType)); \
- g_array_set_size ((arrayvar), (last) - (first) + 1); \
- { \
- int i; \
- for (i = (first) ; i <= (last) ; i++) { \
- char * package = SvPV_nolen (ST (i)); \
- /* look up GType by package name. */ \
- GType t = gperl_type_from_package (package); \
- if (t == 0) { \
- g_array_free ((arrayvar), TRUE); \
- croak ("package %s is not registered with GPerl", \
- package); \
- g_assert ("not reached"); \
- } \
- g_array_index ((arrayvar), GType, i-(first)) = t; \
- } \
- }
-
-
- /*
- * some custom opaque object handling for private gtk structures needed
- * for doing drag and drop.
- */
- typedef GtkTargetList GtkTargetList_ornull;
- SV * newSVGtkTargetList (GtkTargetList * list);
- #define newSVGtkTargetList_ornull(list) ((list) ? newSVGtkTargetList (list) : &PL_sv_undef)
- GtkTargetList * SvGtkTargetList (SV * sv);
- #define SvGtkTargetList_ornull(sv) (((sv) && SvOK (sv)) ? SvGtkTargetList (sv) : NULL)
-
- /*
- * exported so Gnome2 can reuse it in wrappers. other modules might want to
- * do the same. the callback for it needn't worry about param_types or
- * return type, as this does all the marshaling by hand (the C function writes
- * through the params, so we have to handle the stack specially).
- */
- void gtk2perl_menu_position_func (GtkMenu * menu,
- gint * x,
- gint * y,
- gboolean * push_in,
- GPerlCallback * callback);
-
-
- #if ! GTK_CHECK_VERSION (2, 4, 0)
- /* in versions prior to 2.4.0, GtkTreeSearchFlags was declared such that
- * glib-mkenums interpreted and registered it as a GEnum type. sometime
- * before 2.3.0, this was corrected, and the type is registered as a GFlags.
- * The maps file has GFlags (since that's correct), but we have to mangle
- * things somewhat for the bindings to work properly with older libraries. */
- # undef SvGtkTextSearchFlags
- # undef newSVGtkTextSearchFlags
- # define SvGtkTextSearchFlags(sv) (gperl_convert_enum (GTK_TYPE_TEXT_SEARCH_FLAGS, sv))
- # define newSVGtkTextSearchFlags(val) (gperl_convert_back_enum (GTK_TYPE_TEXT_SEARCH_FLAGS, val))
- #endif
-
- /* object handling for GdkGeometry */
- SV * newSVGdkGeometry (GdkGeometry *geometry);
- GdkGeometry * SvGdkGeometry (SV *object);
- GdkGeometry * SvGdkGeometryReal (SV *object, GdkWindowHints *hints);
-
- /* special handling for GdkPixbufFormat, which was introduced in gtk+ 2.2.0 */
- #if GTK_CHECK_VERSION (2, 2, 0)
- SV * newSVGdkPixbufFormat (GdkPixbufFormat * format);
- GdkPixbufFormat * SvGdkPixbufFormat (SV * sv);
- #endif
-
- #endif /* _GTK2PERL_H_ */
-