rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvAttachmentsHandler Class Reference

Class used to handle attachments of graphic objects. More...

Inheritance diagram for IlvAttachmentsHandler:
IlvViewHandler

List of all members.

Public Member Functions

 IlvAttachmentsHandler ()
 Constructor.
IlvGraphicHoldergetGraphicHolder () const
 Returns the graphic holder associated with the attachments handler.
virtual void handleResize (const IlvRect &rect)
 Is called when the view observed by the view handler is resized.
virtual void setView (IlvView *view)
 Sets the view object observed by the view handler.

Static Public Member Functions

static IlvAttachmentsHandlerGet (const IlvView *view)
 Returns the attachments handler instance associated with the specified view.
static IlvAttachmentsHandlerSet (IlvView *view, IlvAttachmentsHandler *handler)
 Sets the specified attachments handler to the specified view.

Detailed Description

Class used to handle attachments of graphic objects.

Library: views

IlvAttachmentsHandler is a subclass of the IlvViewHandler class that deals with attachments set by calling IlvSetAttachment. Each time the view observed by this handler is resized, attached objects located in the graphic holder connected to this view are moved or resized according to their attachments.

See also:
IlvSetAttachment, IlvGraphicHolder.

Constructor & Destructor Documentation

IlvAttachmentsHandler::IlvAttachmentsHandler (  ) 

Constructor.

Initializes a new instance of the class IlvAttachmentsHandler. To connect it to a view, use the IlvAttachmentsHandler::Set static member function.


Member Function Documentation

static IlvAttachmentsHandler* IlvAttachmentsHandler::Get ( const IlvView view  )  [static]

Returns the attachments handler instance associated with the specified view.

Parameters:
view The view.
Returns:
The attachments handler instance associated with view or 0 if there is none.
See also:
Set
IlvGraphicHolder* IlvAttachmentsHandler::getGraphicHolder (  )  const

Returns the graphic holder associated with the attachments handler.

Returns:
The graphic holder associated with the attachments handler, or 0 if there is none.
virtual void IlvAttachmentsHandler::handleResize ( const IlvRect rect  )  [virtual]

Is called when the view observed by the view handler is resized.

The default implementation does nothing.

Parameters:
rect The new size of the view.

Reimplemented from IlvViewHandler.

static IlvAttachmentsHandler* IlvAttachmentsHandler::Set ( IlvView view,
IlvAttachmentsHandler handler 
) [static]

Sets the specified attachments handler to the specified view.

Connects handler to view. If an instance of IlvAttachmentsHandler was already connected with view, it is removed, but not deleted.

Parameters:
view The view.
Returns:
The old attachments handler instance, if any, 0 otherwise.
See also:
Get
virtual void IlvAttachmentsHandler::setView ( IlvView view  )  [virtual]

Sets the view object observed by the view handler.

Parameters:
view The new view object observed by the view handler.
See also:
setView

Reimplemented from IlvViewHandler.


© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.