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 | Protected Member Functions
IlvHourTimeScaleRow Class Reference

Time scale row class. More...

#include <ilviews/graphics/timescalerow.h>

Inheritance diagram for IlvHourTimeScaleRow:
IlvTimeScaleRow

Public Member Functions

 IlvHourTimeScaleRow (IlvTimeScale *parent)
 Constructor. More...
 
virtual IlvTimeScaleRowcopy () const
 Returns a copy of the current time scale row.
 
IlInt getHourStep ()
 Returns the number of hours in an interval. More...
 
virtual
IlvTimeScaleRowFactory::rowtype 
getType () const
 Returns the type of the IlvTimeScaleRow. More...
 
virtual IlDate incrementTime (IlDate dateval)
 Increments the specified date by one hour multiplied by the hour step. More...
 
virtual IlDate previousUnitTime (IlDate dateval)
 Returns the previous unit value of the hour relative to the specified date. More...
 
virtual void read (IlvInputFile &)
 Reads the time scale row description from an input file. More...
 
void setHourStep (IlInt value)
 Sets the number of hours for an interval. More...
 
virtual void write (IlvOutputFile &) const
 Saves the time scale row in an output file. More...
 
- Public Member Functions inherited from IlvTimeScaleRow
 IlvTimeScaleRow (IlvTimeScale *parent)
 Constructor. More...
 
IlString getAdditionalString () const
 Returns the additional text string displayed in the first interval. More...
 
IlCalendargetCalendar () const
 Gets the internal calendar of the parent scale.
 
IlCalendargetCalendar (IlDate time) const
 Gets the internal calendar of the parent scale set to the specified time. More...
 
IlvDisplaygetDisplay () const
 Returns the IlvDisplay of the parent scale.
 
IlInt getIntervalMinWidth () const
 Returns the minimal interval required to draw a text between two ticks. More...
 
IlvPalettegetPalette () const
 Returns the IlvPalette of the parent scale.
 
virtual IlInt getPreferredHeight () const
 Returns the preferred height of the time scale row.
 
IlvColorgetTextColor () const
 Gets the color of the row labels.
 
IlvFontgetTextFont () const
 Gets the font of the row labels.
 
IlvPalettegetTextPalette () const
 Gets the palette of the row labels.
 
TextPos getTextPosition () const
 Returns the position of labels. More...
 
IlvColorgetTickColor () const
 Gets the color of the row ticks.
 
IlvPalettegetTickPalette () const
 Gets the palette of the row ticks.
 
IlvTimeScalegetTimeScale () const
 Gets the referring time scale. More...
 
const IlTimeUnitgetTimeUnit () const
 Gets the internal time unit.
 
IlBoolean isOverlappingLabelAllowed () const
 Indicates whether overlapping labels are allowed. More...
 
IlBoolean isVisible ()
 Indicates whether the row is visible. More...
 
virtual IlDate nextUnitTime (IlDate dateval)
 Computes the next unit value after the specified date. More...
 
void setAdditionalString (IlString str)
 Sets the additional text string displayed in the first interval. More...
 
void setIntervalMinWidth (IlInt value)
 Sets the minimal interval required to draw a text between two ticks. More...
 
void setOverlappingLabelAllowed (IlBoolean overlap)
 Specifies whether overlapping labels are allowed. More...
 
void setTextColor (IlvColor *c)
 Sets the color of the row labels.
 
void setTextFont (IlvFont *f)
 Sets the font of the row labels.
 
void setTextPosition (TextPos pos)
 Sets the position of labels. More...
 
void setTickColor (IlvColor *c)
 Sets the colors of the row ticks.
 
void setTimeScale (IlvTimeScale *timescale)
 Sets the referring IlvTimeScale. More...
 
void setVisible (IlBoolean visible)
 Sets the visibility of the time scale row. More...
 

Protected Member Functions

virtual IlvTimeScaleRowcloneType (IlvTimeScale *) const
 Returns an object of the same type. More...
 
- Protected Member Functions inherited from IlvTimeScaleRow
virtual void draw (IlvPort *dst, const IlvTransformer *t, const IlvTimeScalePaintContext &context, const IlvRect &rect) const
 Draws the time scale row on a specified port. More...
 
virtual void drawLabel (IlvPort *dst, const IlvTransformer *t, const IlvPoint &prevPos, const IlvPoint &nextPos, IlString text) const
 Draws a label in a scale interval. More...
 
virtual void drawTick (IlvPort *dst, const IlvTransformer *t, const IlvPoint &pos, IlInt height) const
 Draws a scale row tick. More...
 

Additional Inherited Members

- Public Types inherited from IlvTimeScaleRow
enum  TextPos { LEFT, RIGHT, CENTER }
 Position of labels in a time scale row. This type indicates the predefined positions of the labels in a time scale row. More...
 

Detailed Description

Time scale row class.

Library: views

This class implements methods from the parent class IlvTimeScaleRow to provide a complete scale displaying hour intervals.

Constructor & Destructor Documentation

IlvHourTimeScaleRow::IlvHourTimeScaleRow ( IlvTimeScale parent)

Constructor.

Creates and initializes an IlvHourTimeScaleRow object.

Member Function Documentation

virtual IlvTimeScaleRow* IlvHourTimeScaleRow::cloneType ( IlvTimeScale scale) const
protectedvirtual

Returns an object of the same type.

This method should be implemented by subclasses. It must return an object of the same type as the object on which the method is called, attached to the given IlvTimeScale.

Parameters
scaleThe IlvTimeScale on which the row is attached.
Returns
A newly allocated object of the same type as the object on which the method is called.

Implements IlvTimeScaleRow.

IlInt IlvHourTimeScaleRow::getHourStep ( )

Returns the number of hours in an interval.

See Also
setHourStep
virtual IlvTimeScaleRowFactory::rowtype IlvHourTimeScaleRow::getType ( ) const
virtual

Returns the type of the IlvTimeScaleRow.

Returns
The type of the IlvTimeScaleRow.

Implements IlvTimeScaleRow.

virtual IlDate IlvHourTimeScaleRow::incrementTime ( IlDate  dateval)
virtual

Increments the specified date by one hour multiplied by the hour step.

For example, the incremented date of January 14th, 2002, 8:12:34 is January 14th 2002 8:13:34 if the hour step is 1 or January 14th 2002 8:16:34 if the hour step is 3.

Parameters
datevalThe date to increment.

Implements IlvTimeScaleRow.

virtual IlDate IlvHourTimeScaleRow::previousUnitTime ( IlDate  dateval)
virtual

Returns the previous unit value of the hour relative to the specified date.

For example, the previous unit time of January 14th, 2002, 8:12:34 is January 14th 2002 8:00:00 if the hour step in 1 or January 14th 2002 6:00:00 if the hour step is 3.

Parameters
datevalThe date to floor.

Implements IlvTimeScaleRow.

virtual void IlvHourTimeScaleRow::read ( IlvInputFile infile)
virtual

Reads the time scale row description from an input file.

Parameters
infileThe input file.

Reimplemented from IlvTimeScaleRow.

void IlvHourTimeScaleRow::setHourStep ( IlInt  value)

Sets the number of hours for an interval.

The default value is 1.

Parameters
valueThe number of hours. It should be a positive number and a divisor of 24.
virtual void IlvHourTimeScaleRow::write ( IlvOutputFile outfile) const
virtual

Saves the time scale row in an output file.

Parameters
outfileThe output file.

Reimplemented from IlvTimeScaleRow.


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