wxBitmap

Implements methods from the following classes

• wxGDIObject

Methods

• wxBitmap
  Default constructor.
• ConvertToDisabled
  Returns disabled (dimmed) version of the bitmap.
• ConvertToImage
  Creates an image from a platform-dependent bitmap.
• CopyFromIcon
  Creates the bitmap from an icon.
• Create
  Creates a fresh bitmap.
• GetDepth
  Gets the colour depth of the bitmap.
• GetHeight
  Gets the height of the bitmap in pixels.
• GetMask
  Gets the associated mask (if any) which may have been loaded from a file or set for the bitmap.
• GetPalette
  Gets the associated palette (if any) which may have been loaded from a file or set for the bitmap.
• GetSize
  Returns the size of the bitmap in pixels.
• GetSubBitmap
  Returns a sub bitmap of the current one as long as the rect belongs entirely to the bitmap.
• GetWidth
  Gets the width of the bitmap in pixels.
• IsOk
  Returns true if bitmap data is present.
• LoadFile
  Loads a bitmap from a file or resource.
• SaveFile
  Saves a bitmap in the named file.
• SetDepth
  Sets the depth member (does not affect the bitmap data).
• SetHeight
  Sets the height member (does not affect the bitmap data).
• SetMask
  Sets the mask for this bitmap.
• SetPalette
  Sets the associated palette.
• SetWidth
  Sets the width member (does not affect the bitmap data).

Static Methods

• AddHandler
  Adds a handler to the end of the static list of format handlers.
• CleanUpHandlers
  Deletes all bitmap handlers.
• FindHandler
  Finds the handler with the given name.
• InitStandardHandlers
  Adds the standard bitmap format handlers, which, depending on wxWidgets configuration, can be handlers for Windows bitmap, Windows bitmap resource, and XPM.
• InsertHandler
  Adds a handler at the start of the static list of format handlers.
• RemoveHandler
  Finds the handler with the given name, and removes it.

wxBitmap

wxBitmap ( )

Default constructor.
wxBitmap ( wxBitmap $bitmap )

Copy constructor, uses reference counting.
wxBitmap ( integer $width, integer $height, integer $depth=wxBITMAP_SCREEN_DEPTH )

Creates a new bitmap.
wxBitmap ( wxSize $sz, integer $depth=wxBITMAP_SCREEN_DEPTH )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
wxBitmap ( string $name, wxBitmapType $type=wxBITMAP_DEFAULT_TYPE )

Loads a bitmap from a file or resource.
wxBitmap ( wxImage $img, integer $depth=wxBITMAP_SCREEN_DEPTH )

Creates this bitmap object from the given image.

AddHandler

static AddHandler ( wxBitmapHandler &$handler )

Adds a handler to the end of the static list of format handlers.

CleanUpHandlers

static CleanUpHandlers ( )

Deletes all bitmap handlers.

ConvertToDisabled

wxBitmap ConvertToDisabled ( integer $brightness=255 )

Returns disabled (dimmed) version of the bitmap.

ConvertToImage

wxImage ConvertToImage ( )

Creates an image from a platform-dependent bitmap.

CopyFromIcon

bool CopyFromIcon ( wxIcon $icon )

Creates the bitmap from an icon.

Create

bool Create ( integer $width, integer $height, integer $depth=wxBITMAP_SCREEN_DEPTH )

Creates a fresh bitmap.
bool Create ( wxSize $sz, integer $depth=wxBITMAP_SCREEN_DEPTH )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

FindHandler

static wxBitmapHandler& FindHandler ( string $name )

Finds the handler with the given name.
static wxBitmapHandler& FindHandler ( string $extension, wxBitmapType $bitmapType )

Finds the handler associated with the given extension and type.
static wxBitmapHandler& FindHandler ( wxBitmapType $bitmapType )

Finds the handler associated with the given bitmap type.

GetDepth

integer GetDepth ( )

Gets the colour depth of the bitmap.

GetHeight

integer GetHeight ( )

Gets the height of the bitmap in pixels.

GetMask

wxMask& GetMask ( )

Gets the associated mask (if any) which may have been loaded from a file or set for the bitmap.

GetPalette

wxPalette& GetPalette ( )

Gets the associated palette (if any) which may have been loaded from a file or set for the bitmap.

GetSize

wxSize GetSize ( )

Returns the size of the bitmap in pixels.

GetSubBitmap

wxBitmap GetSubBitmap ( wxRect $rect )

Returns a sub bitmap of the current one as long as the rect belongs entirely to the bitmap.

GetWidth

integer GetWidth ( )

Gets the width of the bitmap in pixels.

InitStandardHandlers

static InitStandardHandlers ( )

Adds the standard bitmap format handlers, which, depending on wxWidgets configuration, can be handlers for Windows bitmap, Windows bitmap resource, and XPM.

InsertHandler

static InsertHandler ( wxBitmapHandler &$handler )

Adds a handler at the start of the static list of format handlers.

IsOk

bool IsOk ( )

Returns true if bitmap data is present.

LoadFile

bool LoadFile ( string $name, wxBitmapType $type=wxBITMAP_DEFAULT_TYPE )

Loads a bitmap from a file or resource.

RemoveHandler

static bool RemoveHandler ( string $name )

Finds the handler with the given name, and removes it.

SaveFile

bool SaveFile ( string $name, wxBitmapType $type, wxPalette $palette=NULL )

Saves a bitmap in the named file.

SetDepth

SetDepth ( integer $depth )

Sets the depth member (does not affect the bitmap data).

SetHeight

SetHeight ( integer $height )

Sets the height member (does not affect the bitmap data).

SetMask

SetMask ( wxMask &$mask )

Sets the mask for this bitmap.

SetPalette

SetPalette ( wxPalette $palette )

Sets the associated palette.

SetWidth

SetWidth ( integer $width )

Sets the width member (does not affect the bitmap data).