Xfce Foundation Classes
Main Page  | IndexNamespace List  |  Alphabetical List  |  Class List  |  File List


Xfc::Gdk::Bitmap Class Reference

A GdkBitmap C++ wrapper class. More...

#include <xfc/gdk/bitmap.hh>

Inheritance diagram for Xfc::Gdk::Bitmap:

Xfc::Gdk::Pixmap Xfc::Gdk::Drawable Xfc::G::Object Xfc::G::TypeInstance Xfc::Trackable List of all members.

Public Member Functions

Accessors

Detailed Description

A GdkBitmap C++ wrapper class.

Bitmap, like Pixmaps are offscreen drawables. They can be drawn upon with the standard drawing primitives, then copied to another drawable (such as a Gdk::Window) with Gdk::Pixmap::draw(). The depth of a pixmap is the number of bits per pixels. Bitmaps are simply pixmaps with a depth of 1. (That is, they are monochrome bitmaps, each pixel can be either on or off).

Note: dynamically allocated objects must either be unreferenced or assigned to a smart pointer. Stack objects are automatically unreferenced when they go out of scope.


Constructor & Destructor Documentation

Xfc::Gdk::Bitmap::Bitmap ( GdkBitmap *  bitmap,
bool  owns_reference = true 
) [explicit, protected]

Construct a new Bitmap from an existing GdkBitmap.

Parameters:
bitmap A pointer to a GdkBitmap.
owns_reference Set false if the initial reference count is floating, set true if it's not.
The bitmap can be a newly created GdkBitmap or an existing GdkBitmap. (see G::Object::Object).

Xfc::Gdk::Bitmap::Bitmap ( const char *  data,
int  width,
int  height 
)

Create a new bitmap from data in XBM format using the root window to determine the default values.

Parameters:
data A pointer to the XBM data.
width The width of the new bitmap in pixels.
height The height of the new bitmap in pixels.
Bitmap is created with a reference count of 1 that the caller owns.

Xfc::Gdk::Bitmap::Bitmap ( const Window window,
const char *  data,
int  width,
int  height 
)

Create a new bitmap from data in XBM format using window to determine the default values.

Parameters:
window The window to use.
data A pointer to the XBM data.
width The width of the new bitmap in pixels.
height The height of the new bitmap in pixels.
Bitmap is created with a reference count of 1 that the caller owns.

Xfc::Gdk::Bitmap::Bitmap ( GdkBitmap *  bitmap,
bool  owns_reference = true 
) [explicit, protected]

Construct a new Bitmap from an existing GdkBitmap.

Parameters:
bitmap A pointer to a GdkBitmap.
owns_reference Set false if the initial reference count is floating, set true if it's not.
The bitmap can be a newly created GdkBitmap or an existing GdkBitmap. (see G::Object::Object).

Xfc::Gdk::Bitmap::Bitmap ( const char *  data,
int  width,
int  height 
)

Create a new bitmap from data in XBM format using the root window to determine the default values.

Parameters:
data A pointer to the XBM data.
width The width of the new bitmap in pixels.
height The height of the new bitmap in pixels.
Bitmap is created with a reference count of 1 that the caller owns.

Xfc::Gdk::Bitmap::Bitmap ( const Window window,
const char *  data,
int  width,
int  height 
)

Create a new bitmap from data in XBM format using window to determine the default values.

Parameters:
window The window to use.
data A pointer to the XBM data.
width The width of the new bitmap in pixels.
height The height of the new bitmap in pixels.
Bitmap is created with a reference count of 1 that the caller owns.


The documentation for this class was generated from the following file: Xfce Foundation Classes
Copyright © 2004-2005 The XFC Development Team XFC 4.3