rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions | Friends
IlvLineStyle Class Reference

Resource class. More...

#include <ilviews/base/resource.h>

Inheritance diagram for IlvLineStyle:
IlvResource

Public Member Functions

IlUShort getCount () const
 Returns the length of the dash array. More...
 
unsigned char * getDashes () const
 Returns the dash array. More...
 
IlUShort getOffset () const
 Returns the dash offset. More...
 
- Public Member Functions inherited from IlvResource
IlvDisplaygetDisplay () const
 Gets the IlvDisplay instance. More...
 
const char * getName () const
 Gets the resource name. More...
 
void lock ()
 Locks the resource. More...
 
virtual void setName (const char *name)
 Sets the name of the resource. More...
 
virtual void unLock ()
 Unlocks the resource. More...
 

Friends

class IlvDisplay
 

Detailed Description

Resource class.

Library: display

The class IlvLineStyle represents the line style resources. A line style is an array of unsigned characters returned by the member function getDashes. The length of the array is returned by the getCount member function. Other line styles are predefined and may be accessed through the naming mechanism:


- IlvLineStyle -

Although this class does not have any public constructor, you may define your own line styles by means of calls to the member function IlvDisplay::getLineStyle. You can name these new line styles to access them by name.

See Also
IlvDisplay::defaultLineStyle, IlvDisplay::getLineStyle.

Member Function Documentation

IlUShort IlvLineStyle::getCount ( ) const

Returns the length of the dash array.

Returns
The length of the dash array.
unsigned char* IlvLineStyle::getDashes ( ) const

Returns the dash array.

When a line is drawn using this line style, the number of foreground-colored pixels is indicated by the elements of the returned array. This array must not be modified or deleted.

IlUShort IlvLineStyle::getOffset ( ) const

Returns the dash offset.

Returns
The number of pixels to be skipped when the drawing loop starts.

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