rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvWeekTimeScaleRow Class Reference

Time scale row class. More...

#include <ilviews/graphics/timescalerow.h>

Inheritance diagram for IlvWeekTimeScaleRow:
IlvTimeScaleRow

List of all members.

Public Member Functions

 IlvWeekTimeScaleRow (IlvTimeScale *parent)
 Constructor.
virtual IlvTimeScaleRowcopy () const
 Returns a copy of the current time scale row.
virtual
IlvTimeScaleRowFactory::rowtype 
getType () const
 Returns the type of the IlvTimeScaleRow.
virtual IlDate incrementTime (IlDate dateval)
 Increments the specified date by one week.
virtual IlDate previousUnitTime (IlDate dateval)
 Returns the previous unit value of the week relative to the specified date.
virtual void read (IlvInputFile &)
 Reads the time scale row description from an input file.
virtual void write (IlvOutputFile &) const
 Saves the time scale row in an output file.

Protected Member Functions

virtual IlvTimeScaleRowcloneType (IlvTimeScale *) const
 Returns an object of the same type.

Detailed Description

Time scale row class.

Library: views

This class implements methods of the class IlvTimeScaleRow to provide a complete scale displaying weekly intervals.


Constructor & Destructor Documentation

IlvWeekTimeScaleRow::IlvWeekTimeScaleRow ( IlvTimeScale parent  ) 

Constructor.

Creates and initializes an IlvWeekTimeScaleRow object.


Member Function Documentation

virtual IlvTimeScaleRow* IlvWeekTimeScaleRow::cloneType ( IlvTimeScale scale  )  const [protected, virtual]

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:
scale The 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.

virtual IlvTimeScaleRowFactory::rowtype IlvWeekTimeScaleRow::getType (  )  const [virtual]

Returns the type of the IlvTimeScaleRow.

Returns:
The type of the IlvTimeScaleRow.

Implements IlvTimeScaleRow.

virtual IlDate IlvWeekTimeScaleRow::incrementTime ( IlDate  dateval  )  [virtual]

Increments the specified date by one week.

For example, the incremented date of Friday 7th is Friday 14th.

Parameters:
dateval The date to increment.

Implements IlvTimeScaleRow.

virtual IlDate IlvWeekTimeScaleRow::previousUnitTime ( IlDate  dateval  )  [virtual]

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

For example, the previous unit time of Friday 7th is Sunday 2nd or Monday 3rd depending on the Locale

Parameters:
dateval The date to floor.
See also:
IlvTimeScale::setLocale

Implements IlvTimeScaleRow.

virtual void IlvWeekTimeScaleRow::read ( IlvInputFile infile  )  [virtual]

Reads the time scale row description from an input file.

Parameters:
infile The input file.

Reimplemented from IlvTimeScaleRow.

virtual void IlvWeekTimeScaleRow::write ( IlvOutputFile outfile  )  const [virtual]

Saves the time scale row in an output file.

Parameters:
outfile The 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.