rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions
IlvMapRenderingStyle Class Referenceabstract

This abstract class is the base class of the rendering styles. More...

#include <ilviews/maps/rendering/rdrstyle.h>

Inheritance diagram for IlvMapRenderingStyle:
IlvMapAreaRenderingStyle IlvMapLineRenderingStyle

Public Member Functions

virtual IlvMapRenderingStylecopy () const =0
 Copies the object. More...
 
IlvDisplaygetDisplay () const
 Returns the display that is used to create the graphic settings. More...
 
void lock ()
 Locks the object and prevents it from being deleted. More...
 
void save (IlvOutputFile &file) const
 Saves the object to an IlvOutputFile. More...
 
void unLock ()
 Unlocks the object. More...
 

Static Public Member Functions

static IlvMapRenderingStyleLoad (IlvInputFile &file)
 Loads a rendering style from an IlvInputFile. More...
 

Protected Member Functions

 IlvMapRenderingStyle (IlvDisplay *display)
 The constructor of this abstract class is protected. More...
 
 IlvMapRenderingStyle (const IlvMapRenderingStyle &source)
 Creates a renderer by copying an existing one. More...
 
virtual ~IlvMapRenderingStyle ()
 Destructor. More...
 

Detailed Description

This abstract class is the base class of the rendering styles.

A rendering style is used by the renderers to define the graphic style of the graphic objects representing vector map features. Instances of IlvMapRenderingStyle are shared objects. As a consequence, they should never be deleted. The memory management should be performed using the lock and unLock mechanism. Library: ilvmaps

Constructor & Destructor Documentation

IlvMapRenderingStyle::IlvMapRenderingStyle ( IlvDisplay display)
protected

The constructor of this abstract class is protected.

Parameters
displayThe display used to create the graphic palettes.
IlvMapRenderingStyle::IlvMapRenderingStyle ( const IlvMapRenderingStyle source)
protected

Creates a renderer by copying an existing one.

Since this class is abstract, this copy constructor is protected.

Parameters
sourceThe object to be copied.
virtual IlvMapRenderingStyle::~IlvMapRenderingStyle ( )
protectedvirtual

Destructor.

The destructor of this class is protected, because instances of IlvMapRenderingStyle are potentially shared by several objects.

See Also
lock, unLock.

Member Function Documentation

virtual IlvMapRenderingStyle* IlvMapRenderingStyle::copy ( ) const
pure virtual

Copies the object.

Returns
A copy of this IlvMapRenderingStyle.
IlvDisplay* IlvMapRenderingStyle::getDisplay ( ) const

Returns the display that is used to create the graphic settings.

Returns
The display.
static IlvMapRenderingStyle* IlvMapRenderingStyle::Load ( IlvInputFile file)
static

Loads a rendering style from an IlvInputFile.

Parameters
fileThe input file.
Returns
An IlvMapRenderingStyle object or a null pointer if the load operation fails.
void IlvMapRenderingStyle::lock ( )

Locks the object and prevents it from being deleted.

See Also
unLock
void IlvMapRenderingStyle::save ( IlvOutputFile file) const

Saves the object to an IlvOutputFile.

Parameters
fileThe output file.
See Also
Load
void IlvMapRenderingStyle::unLock ( )

Unlocks the object.

If the object does not have any lock, it is deleted.

See Also
lock

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