f5a1576d7c
also replaced some html with doxygen equivalent. note that not all comments are consistent. some are one-liners, even though the contain [obvious?] parameters, and others have \param and \returns. note too, that some parameter names are ambiguous and require type info, eg line could be FL_BLINE* for whole line entry, or int for line number, and this can make descriptions awkward (\param line line number). git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6318 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
77 lines
2.4 KiB
C++
77 lines
2.4 KiB
C++
//
|
|
// "$Id$"
|
|
//
|
|
// Bitmap 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
|
|
Fl_Bitmap widget . */
|
|
|
|
#ifndef Fl_Bitmap_H
|
|
#define Fl_Bitmap_H
|
|
# include "Fl_Image.H"
|
|
|
|
class Fl_Widget;
|
|
struct Fl_Menu_Item;
|
|
|
|
/**
|
|
The Fl_Bitmap class supports caching and drawing of mono-color
|
|
(bitmap) images. Images are drawn using the current color.
|
|
*/
|
|
class FL_EXPORT Fl_Bitmap : public Fl_Image {
|
|
public:
|
|
|
|
/** pointer to raw bitmap data */
|
|
const uchar *array;
|
|
/** Non-zero if array points to bitmap data allocated internally */
|
|
int alloc_array;
|
|
#if defined(__APPLE__) || defined(WIN32)
|
|
/** for internal use */
|
|
void *id;
|
|
#else
|
|
/** for internal use */
|
|
unsigned id;
|
|
#endif // __APPLE__ || WIN32
|
|
/** The constructors create a new bitmap from the specified bitmap data */
|
|
Fl_Bitmap(const uchar *bits, int W, int H) :
|
|
Fl_Image(W,H,0), array(bits), alloc_array(0), id(0) {data((const char **)&array, 1);}
|
|
/** The constructors create a new bitmap from the specified bitmap data */
|
|
Fl_Bitmap(const char *bits, int W, int H) :
|
|
Fl_Image(W,H,0), array((const uchar *)bits), alloc_array(0), id(0) {data((const char **)&array, 1);}
|
|
virtual ~Fl_Bitmap();
|
|
virtual Fl_Image *copy(int W, int H);
|
|
Fl_Image *copy() { return copy(w(), h()); }
|
|
virtual void draw(int X, int Y, int W, int H, int cx=0, int cy=0);
|
|
void draw(int X, int Y) {draw(X, Y, w(), h(), 0, 0);}
|
|
virtual void label(Fl_Widget*w);
|
|
virtual void label(Fl_Menu_Item*m);
|
|
virtual void uncache();
|
|
};
|
|
|
|
#endif
|
|
|
|
//
|
|
// End of "$Id$".
|
|
//
|