FLTK 1.3.0
Fl_Pixmap.H
1 //
2 // "$Id: Fl_Pixmap.H 7903 2010-11-28 21:06:39Z matt $"
3 //
4 // Pixmap header file for the Fast Light Tool Kit (FLTK).
5 //
6 // Copyright 1998-2010 by Bill Spitzak and others.
7 //
8 // This library is free software; you can redistribute it and/or
9 // modify it under the terms of the GNU Library General Public
10 // License as published by the Free Software Foundation; either
11 // version 2 of the License, or (at your option) any later version.
12 //
13 // This library is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 // Library General Public License for more details.
17 //
18 // You should have received a copy of the GNU Library General Public
19 // License along with this library; if not, write to the Free Software
20 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21 // USA.
22 //
23 // Please report all bugs and problems on the following page:
24 //
25 // http://www.fltk.org/str.php
26 //
27 
28 /* \file
29  Fl_Pixmap widget . */
30 
31 #ifndef Fl_Pixmap_H
32 #define Fl_Pixmap_H
33 # include "Fl_Image.H"
34 
35 class Fl_Widget;
36 struct Fl_Menu_Item;
37 
38 // Older C++ compilers don't support the explicit keyword... :(
39 # if defined(__sgi) && !defined(_COMPILER_VERSION)
40 # define explicit
41 # endif // __sgi && !_COMPILER_VERSION
42 
47 class FL_EXPORT Fl_Pixmap : public Fl_Image {
48  friend class Fl_Quartz_Graphics_Driver;
49  friend class Fl_GDI_Graphics_Driver;
50  friend class Fl_Xlib_Graphics_Driver;
51  void copy_data();
52  void delete_data();
53  void set_data(const char * const *p);
54 
55  protected:
56 
57  void measure();
58 
59  public:
60 
61  int alloc_data; // Non-zero if data was allocated
62 
63  private:
64 
65 #if defined(__APPLE__) || defined(WIN32)
66  void *id_; // for internal use
67  void *mask_; // for internal use (mask bitmap)
68 #else
69  unsigned id_; // for internal use
70  unsigned mask_; // for internal use (mask bitmap)
71 #endif // __APPLE__ || WIN32
72 
73  public:
74 
76  explicit Fl_Pixmap(char * const * D) : Fl_Image(-1,0,1), alloc_data(0), id_(0), mask_(0) {set_data((const char*const*)D); measure();}
78  explicit Fl_Pixmap(uchar* const * D) : Fl_Image(-1,0,1), alloc_data(0), id_(0), mask_(0) {set_data((const char*const*)D); measure();}
80  explicit Fl_Pixmap(const char * const * D) : Fl_Image(-1,0,1), alloc_data(0), id_(0), mask_(0) {set_data((const char*const*)D); measure();}
82  explicit Fl_Pixmap(const uchar* const * D) : Fl_Image(-1,0,1), alloc_data(0), id_(0), mask_(0) {set_data((const char*const*)D); measure();}
83  virtual ~Fl_Pixmap();
84  virtual Fl_Image *copy(int W, int H);
85  Fl_Image *copy() { return copy(w(), h()); }
86  virtual void color_average(Fl_Color c, float i);
87  virtual void desaturate();
88  virtual void draw(int X, int Y, int W, int H, int cx=0, int cy=0);
89  void draw(int X, int Y) {draw(X, Y, w(), h(), 0, 0);}
90  virtual void label(Fl_Widget*w);
91  virtual void label(Fl_Menu_Item*m);
92  virtual void uncache();
93 };
94 
95 #endif
96 
97 //
98 // End of "$Id: Fl_Pixmap.H 7903 2010-11-28 21:06:39Z matt $".
99 //
Fl_Widget is the base class for all widgets in FLTK.
Definition: Fl_Widget.H:109
virtual void desaturate()
The desaturate() method converts an image to grayscale.
Definition: Fl_Image.cxx:108
Fl_Pixmap(char *const *D)
The constructors create a new pixmap from the specified XPM data.
Definition: Fl_Pixmap.H:76
The Fl_Pixmap class supports caching and drawing of colormap (pixmap) images, including transparency...
Definition: Fl_Pixmap.H:47
virtual void label(Fl_Widget *w)
The label() methods are an obsolete way to set the image attribute of a widget or menu item...
Definition: Fl_Image.cxx:118
The Mac OS X-specific graphics class.
Definition: Fl_Device.H:406
Fl_Image is the base class used for caching and drawing all kinds of images in FLTK.
Definition: Fl_Image.H:51
Fl_Pixmap(const char *const *D)
The constructors create a new pixmap from the specified XPM data.
Definition: Fl_Pixmap.H:80
virtual void draw(int X, int Y, int W, int H, int cx=0, int cy=0)
Draws the image with a bounding box.
Definition: Fl_Image.cxx:61
Fl_Pixmap(const uchar *const *D)
The constructors create a new pixmap from the specified XPM data.
Definition: Fl_Pixmap.H:82
Fl_Image * copy()
The copy() method creates a copy of the specified image.
Definition: Fl_Image.H:136
The Xlib-specific graphics class.
Definition: Fl_Device.H:469
The Fl_Menu_Item structure defines a single menu item that is used by the Fl_Menu_ class...
Definition: Fl_Menu_Item.H:118
virtual void color_average(Fl_Color c, float i)
The color_average() method averages the colors in the image with the FLTK color value c...
Definition: Fl_Image.cxx:99
unsigned int Fl_Color
an FLTK color value
Definition: Enumerations.H:769
int w() const
Returns the current image width in pixels.
Definition: Fl_Image.H:91
Fl_Pixmap(uchar *const *D)
The constructors create a new pixmap from the specified XPM data.
Definition: Fl_Pixmap.H:78
virtual void uncache()
If the image has been cached for display, delete the cache data.
Definition: Fl_Image.cxx:58
int h() const
Returns the current image height in pixels.
Definition: Fl_Image.H:94
The MSWindows-specific graphics class.
Definition: Fl_Device.H:439
unsigned char uchar
unsigned char
Definition: fl_types.h:39