Documentation

wxprintbitmap
Prev Chapter 11. The wxWidgets-based (WXWN) Components Next

wxprintbitmap

Description

A wxprintbitmap object contains the image content that is used by a wxprintbitmapitem object when a page is output during printing. The bitmap can be associated with either the wxprintout object, the wxprintpagetemplate object, or the wxprintpage object. The choice is dependent on whether the item to be printed is the same throughout the printout, the same on every template, or is specific to a given page.

Type Tags

None

Object Value

Properties

PropertyTypeDescription
_type(*) This property is provided for use by the user to attach any object of any type to the type in which this property is provided.
__type(*) This property is provided for use by the user to attach any object of any type to the type in which this property is provided. It has the additional feature of being marked with the resolve keyword, so that object resolution can continue down this property.
bitmapwxbitmap The bitmap for the wxprintbitmap object.
containertype(wxprintdatacontainer) Specifies the object that contains the ring of which the wxprintbitmap object is a member. This will be either a printout, a template, or a page.
namestring The name of the wxprintbitmap object.
nextwxprintbitmap Specifies the next wxprintbitmap object in the ring of printbitmaps associated either with a printout, template, or page.
typetype Specifies the wxprintbitmap type object.

Methods

setname()

Description

Sets the name of the wxprintbitmap object. The wxprintbitmap object itself is returned, to allow multiple setting methods to be put into one expression.

Prototype

wxprintbitmapvar.setname ( string name )

Parameters
ParameterDefault valueType nameDescription
nameNonestring The new name for the printbitmap object.
[Note]Note

The name of any item: page, string, bitmap, etc. that can be accessed using the member operator must be unique across all rings associated with an object. For example in the case of a printout object, the same name cannot be assigned to a page and also to a string or a bitmap. The same name can also not be given to two items in the same ring.

setnext()

Description

Sets the position of the wxprintbitmap in the ring of printbitmap objects.

Prototype

wxprintbitmapvar.setnext ( wxprintbitmap next )

Parameters
ParameterDefault valueType nameDescription
nextNonewxprintbitmap Calling the method with the value .nul sets a printbitmap to be the last one in the ring (the one before container.firstbitmap) and passing any other printbitmap as the argument puts the target printbitmap immediately before the one specified as the parameter.
Prev Up Next
wxmenuitem Home wxprintbitmapitem