fltk/FL/Fl_Cairo.H
Fabien Costantini bd882119e7 Doxygen documentation : minor comment fixes.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6365 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-03 07:48:38 +00:00

100 lines
3.3 KiB
C++

//
// "$Id$"
//
// Main header file for the Fast Light Tool Kit (FLTK).
//
// Copyright 1998-2008 by Bill Spitzak and others.
//
// 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA.
//
// Please report all bugs and problems on the following page:
//
// http://www.fltk.org/str.php
//
/** \file
Handling transparently platform dependent cairo include files
*/
#ifndef FL_CAIRO_H
# define FL_CAIRO_H
# ifdef HAVE_CAIRO
// Cairo is currently supported for the following platforms:
// Win32, Apple Quartz, X11
# include <FL/Fl_Export.H>
# if defined(USE_X11) // X11
# include <cairo-xlib.h>
# elif defined(WIN32)
# include <cairo-win32.h>
# elif defined(__APPLE_QUARTZ__)
# include <cairo-quartz.h>
# elif defined(__APPLE_QD__)
# error Apple Quartz is necessary for Cairo upport.
# else
# error Cairo is not supported on that platform.
# endif
/**
\addtogroup group_cairo
@{
*/
/**
Contains all the necessary info on the current cairo context.
A private internal & unique corresponding object is created to
permit cairo context state handling while keeping it opaque.
For internal use only.
\note Only available when configure has the --enable-cairo option
*/
class FL_EXPORT Fl_Cairo_State {
public:
Fl_Cairo_State() : cc_(0), own_cc_(false), autolink_(false), window_(0), gc_(0) {}
// access attributes
cairo_t* cc() const {return cc_;} ///< Gets the current cairo context
bool autolink() const {return autolink_;} ///< Sets the autolink option. See Fl::cairo_autolink_context(bool)
/** Sets the current cairo context, \a own indicates cc deletion is handle externally by user */
void cc(cairo_t* c, bool own=true) {
if (cc_ && own_cc_) cairo_destroy(cc_);
cc_=c;
if (!cc_) window_=0;
own_cc_=own;
}
void autolink(bool b) {autolink_ = b;} ///< Gets the autolink option
void window(void* w) {window_=w;} ///< Sets the window \a w to keep track on
void* window() const {return window_;} ///< Gets the last window attached to a cc
void gc(void* c) {gc_=c;} ///< Sets the gc \a c to keep track on
void* gc() const {return gc_;} ///< Gets the last gc attached to a cc
private:
cairo_t * cc_; // contains the unique autoupdated cairo context
bool own_cc_; // indicates whether we must delete the cc, useful for internal cleanup
bool autolink_; // true by default, permits to prevent the automatic cairo mapping on fltk windows for custom cairo implementations
void* window_, *gc_; // for keeping track internally of last win+gc treated
};
/** @} */
# endif // HAVE_CAIRO
#endif // FL_CAIRO_H
//
// End of "$Id$" .
//