rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvDrawingView Class Reference

View class. More...

#include <ilviews/util/drview.h>

Inheritance diagram for IlvDrawingView:
IlvView IlvAbstractView IlvSystemPort IlvPort IlvContainer

List of all members.

Public Member Functions

 IlvDrawingView (IlvDisplay *display, const char *name, const char *title, const IlvRect &size, IlUInt properties, IlBoolean visible=((IlBoolean) 1), IlvSystemView transientFor=0)
 Constructor.
 IlvDrawingView (IlvDisplay *display, const char *name, const char *title, const IlvRect &size, IlBoolean visible=((IlBoolean) 1))
 Constructor.
 IlvDrawingView (IlvDisplay *display, IlvSystemView available)
 Constructor.
 IlvDrawingView (IlvDisplay *display, IlvSystemView parent, const IlvRect &size, IlBoolean visible=((IlBoolean) 1))
 Constructor.
 IlvDrawingView (IlvAbstractView *parent, const IlvRect &size, IlBoolean visible=((IlBoolean) 1))
 Constructor.
virtual void draw (const IlvRegion *clip=0)
 Draws the view contents.
virtual void handleExpose (IlvEvent &event)
 Handles a newly exposed region.
virtual void handleInput (IlvEvent &event)
 Handles an input event.
virtual void reDraw (const IlvRegion *clip=0)
 Redraws the entire view.

Detailed Description

View class.

Library: display

When using the IlvView class hierarchy, you must specify the callback functions used to handle incoming events. The IlvDrawingView class has predefined member functions for this purpose.


Constructor & Destructor Documentation

IlvDrawingView::IlvDrawingView ( IlvAbstractView parent,
const IlvRect size,
IlBoolean  visible = ((IlBoolean) 1) 
)

Constructor.

This constructor initializes a view object that is a child of the parent view.

Parameters:
parent The parent view.
size The initial location and size of the view, in the coordinate system of parent.
visible Can be set to IlFalse to initially hide the window.
IlvDrawingView::IlvDrawingView ( IlvDisplay display,
IlvSystemView  parent,
const IlvRect size,
IlBoolean  visible = ((IlBoolean) 1) 
)

Constructor.

This constructor creates a view that is a child of the existing system view indicated by parent.

Parameters:
display The display instance.
parent The parent system view.
size The initial location and size of the view, in the coordinate system of the existing system view.
visible Can be set to IlFalse to initially hide the window.
IlvDrawingView::IlvDrawingView ( IlvDisplay display,
IlvSystemView  available 
)

Constructor.

This constructor creates a new view object by actually using the existing system view indicated by available.

Parameters:
display The display instance.
available The system view on which this IlvDrawingView is based.
IlvDrawingView::IlvDrawingView ( IlvDisplay display,
const char *  name,
const char *  title,
const IlvRect size,
IlBoolean  visible = ((IlBoolean) 1) 
)

Constructor.

This constructor initializes a view object that is a new top window.

Parameters:
display The display instance.
name The name of this view (used by the resource association mechanism).
title The title of this top window.
size The initial location and size of the view, relative to the root window of display.
visible Can be set to IlFalse to initially hide the window.
IlvDrawingView::IlvDrawingView ( IlvDisplay display,
const char *  name,
const char *  title,
const IlvRect size,
IlUInt  properties,
IlBoolean  visible = ((IlBoolean) 1),
IlvSystemView  transientFor = 0 
)

Constructor.

This constructor creates a top window, with an optional parameter properties that makes it possible to tune its aspect.

Parameters:
display The display instance.
name The name of this view (used by the resource association mechanism).
title The title of this top window.
size The initial location and size of the view, relative to the root window of display.
properties The properties of that view (see above).
visible Can be set to IlFalse to initially hide the window.
transientFor The possible system view for which this view is transient. If unspecified or set to 0, this view will not be transient for any view.

Member Function Documentation

virtual void IlvDrawingView::draw ( const IlvRegion clip = 0  )  [virtual]

Draws the view contents.

This is the member function you will overload to perform the different drawing tasks that are needed by your application.

The default implementation does nothing.

Parameters:
clip The clipping region where the drawing must take place. If 0, there is no clipping region to be used.

Reimplemented in IlvContainer.

virtual void IlvDrawingView::handleExpose ( IlvEvent event  )  [virtual]

Handles a newly exposed region.

This member function is called when this view reveals new regions that must be updated.

The default implementation calls reDraw with the relevant exposed region.

Parameters:
event The event that is received for this expose event.

Reimplemented in IlvContainer.

virtual void IlvDrawingView::handleInput ( IlvEvent event  )  [virtual]

Handles an input event.

This member function is called when an input event (keystrokes or mouse events) is received by this view.

Its default implementation does nothing.

Parameters:
event The input event that is received.

Reimplemented in IlvContainer.

virtual void IlvDrawingView::reDraw ( const IlvRegion clip = 0  )  [virtual]

Redraws the entire view.

The default implementation erases, if necessary, the background of the window then calls draw.

Parameters:
clip The clipping region to be refreshed.

Reimplemented in IlvContainer.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

© 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.