rwlogo

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
List of all members | Public Member Functions | Static Public Member Functions
IlvAttachmentsHandler Class Reference

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

#include <ilviews/graphics/attach.h>

Inheritance diagram for IlvAttachmentsHandler:
IlvViewHandler

Public Member Functions

 IlvAttachmentsHandler ()
 Constructor. More...
 
IlvGraphicHoldergetGraphicHolder () const
 Returns the graphic holder associated with the attachments handler. More...
 
virtual void handleResize (const IlvRect &rect)
 Is called when the view observed by the view handler is resized. More...
 
virtual void setView (IlvView *view)
 Sets the view object observed by the view handler. More...
 
- Public Member Functions inherited from IlvViewHandler
IlUInt getMask () const
 Returns the event mask of the view handler. More...
 
IlvViewgetView () const
 Returns the view object observed by the view handler. More...
 
virtual void handleDestroy ()
 Is called when the view observed by the view handler is being destroyed. More...
 
virtual void handleExpose (IlvEvent &event)
 Is called when the view observed by the view handler receives an expose event. More...
 
virtual void handleInput (IlvEvent &event)
 Is called when the view observed by the view handler receives an input event. More...
 
void setMask (IlUInt mask)
 Sets the event mask of the view handler. More...
 
virtual void viewDeleted ()
 Is called when the view observed by the view handler is deleted. More...
 

Static Public Member Functions

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

Additional Inherited Members

- Public Types inherited from IlvViewHandler
enum  EventType {
  NoEvent, InputEvent, ExposeEvent, ResizeEvent,
  DestroyEvent
}
 This enumeration defines the possible values for the event mask of an IlvViewHandler object. More...
 

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
viewThe 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
rectThe 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
viewThe view.
handlerThe attachements handler to set.
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
viewThe new view object observed by the view handler.
See Also
setView

Reimplemented from IlvViewHandler.


© Copyright 2015, 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.