wxprintstring

wxprintstring
	Chapter 11. The wxWidgets-based (WXWN) Components

Description

A wxprintstring object contains the content that is used by a wxprinttextitem object when a page is output during printing. The string 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

Property	Type	Description
_	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.
container	type(wxprintdatacontainer)	Specifies the object that contains the ring of which the wxprintstring object is a member. This will be either a printout, a template, or a page.
name	string	The name of the wxprintstring object.
next	wxprintstring	Specifies the next wxprintstring object in the ring of strings associated either with a printout, template, or page.
string	string	The content of the wxprintstring object.
type	type	Specifies the wxprintstring type object.

Methods

setname()

Description

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

Prototype

wxprintstringvar.setname ( string name )

Parameters

Parameter

Default value

Type name

Description

name

None

string

The new name for the printstring object.

	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 wxprintstring in the ring of printstring objects.

Prototype

wxprintstringvar.setnext ( wxprintstring next )

Parameters

Parameter	Default value	Type name	Description
next	None	wxprintstring	Calling the method with the value `.nul` sets a printstring to be the last one in the ring (the one before container.firststring) and passing any other printstring as the argument puts the target printstring immediately before the one specified as the parameter.