LFocusBox

LFocusBox is a PowerPlant class that is used for outlining a pane to indicate that the pane is the current focus for keystrokes.

Methods :

The methods in this class are:

LFocusBox()	AttachPane()
DontRefresh()	DrawSelf()
GetBoxRegion()	HideSelf()
Refresh()	ShowSelf()

Data Members:

There are no data members in this class.

Operation:

This class is used internally by PowerPlant in conjunction with LListBox to highlight entries in the list.

Source files:

(Pane Classes)

LFocusBox.h

LFocusBox.cp

Ancestors:

LAttachable

LPane

LFocusBox()

Purpose:

The constructors create objects from the passed-in parameters.

Access:

Public

Prototype:

LFocusBox();

LFocusBox( const LFocusBox &inOriginal );

LFocusBox( LStream *inStream );

The parameters for these constructors are:

const LFocusBox&	inOriginal	The reference to the object to copy.
LStream*	inStream	The stream to read from.

AttachPane()

Purpose:

Associate a host Pane with a FocusBox, sizing and positioning the FocusBox so that it fits around the Pane.

Access:

Virtual, Public

Prototype:

virtual void AttachPane(

LPane *inPane,

Boolean inSameBindings );

The parameters for this method are:

LPane*	inPane	The pointer to the pane.
Boolean	inSameBindings	If true, FocusBox uses same frame bindings as the host Pane. This makes the FocusBox move and resize along with the host Pane if their mutual SuperView moves or resizes.

Return:

None

:

DontRefresh()

Purpose:

Validate the area occupied by a FocusBox so it won't redraw during the next Update event. This is an override of DontRefresh() in LView.

DrawSelf()

Purpose:

Draw a FocusBox. This is an override of DrawSelf() in LPane.

GetBoxRegion()

Purpose:

Pass back a region defining a FocusBox. A FocusBox is a hollow rectangular region. Clip the region so that it is within the revealed rect. This method creates a new region which the caller must dispose of.

Access:

Protected

Prototype:

virtual RgnHandle GetBoxRegion(

const Rect &inFrame,

const Rect &inRevealed ) const;

The parameters for this method are:

const Rect&	inFrame	Reference to the frame Rect.
const Rect&	inRevealed	Reference to the revealed Rect.

Return:

A handle to the region defining the FocusBox.

HideSelf()

Purpose:

A FocusBox is being hidden. This is an override of HideSelf() in LPane.

Refresh()

Purpose:

Invalidate the area occupied by a FocusBox so it will redraw during the next Update event. This is an override of Refresh() in LPane.

ShowSelf()

Purpose:

A FocusBox is being shown. This is an override of ShowSelf() in LPane.