rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Gantt Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvGanttChartForm Class Reference

Gantt chart form class. More...

#include <ilviews/gantt/ganttfrm.h>

Inheritance diagram for IlvGanttChartForm:
IlvGanttChart IlvGadgetContainerRectangle IlvContainerRectangle IlvViewRectangle IlvFilledRectangle IlvRectangle IlvSimpleGraphic IlvGraphic

Public Member Functions

 IlvGanttChartForm (IlvDisplay *display, const IlvRect &rect, IlInt start, IlInt end, IlInt shownStart, IlInt shownEnd, IlUShort step, IlvDim rowsize, IlvDim lineInfoSize=0, IlvDim unitsize=20, IlvDim scaleH=32, IlvDim sbsize=16, IlUShort spacing=4, IlUShort vwspacing=20, IlUShort offset=0, IlvDim separsize=6, IlvPosition hasScale=IlvTop, IlvPosition hasHSB=IlvBottom, IlvPosition hasVSB=IlvRight, int numLayers=5, IlBoolean useacc=IlTrue, IlvPalette *palette=0)
 Constructor. More...
 
virtual void deleteAll (IlBoolean destroy, IlBoolean redraw=IlTrue)
 Removes all the objects stored in the chart. More...
 
IlvGraphicgetCompositeGrid () const
 Gets the composite grid currently being used. More...
 
IlvGraphicgetCompositeScale () const
 Gets the composite scale currently being used. More...
 
virtual IlvRectgetLineArea (IlvRect &area) const
 Returns the bounds of the Gantt lines. More...
 
IlvGanttResourceHeadergetResourceHeader () const
 Gets the resource header. More...
 
IlvScrollBargetResourceScrollBar () const
 Gets the resource table scroll bar. More...
 
IlvViewgetScaleView (IlUShort viewIndex) const
 Gets the scale view. More...
 
IlvSplitterGadgethorizontalSplitter (IlInt index) const
 Gets the horizontal splitter. More...
 
virtual void insertLine (IlvGanttLine *, IlUShort row, IlBoolean redraw=IlTrue, int layer=-1)
 Inserts a line before a row. More...
 
virtual void makeView (IlvPort *dst, const IlvTransformer *t)
 Creates the views. More...
 
virtual void moveSplitter (IlvDirection dir, IlUInt index, IlvPos pos)
 Moves a splitter to a given position. More...
 
IlvGraphicsetCompositeGrid (IlvGraphic *compoGrid, IlBoolean redraw=IlTrue)
 Sets the composite grid for the Gantt chart form. More...
 
IlvGraphicsetCompositeScale (IlvGraphic *compoScale, IlBoolean redraw=IlTrue, IlBoolean reshape=IlFalse)
 Sets the composite scale for the Gantt chart form. More...
 
virtual void setDoubleBuffering (IlBoolean doubleBuffer)
 Enables or disables double buffering. More...
 
virtual void updateScale (IlvScale *scale, IlBoolean redraw=IlTrue) const
 Updates the scale. More...
 
IlvSplitterGadgetverticalSplitter (IlInt index) const
 Gets the vertical splitter. More...
 
- Public Member Functions inherited from IlvGanttChart
 IlvGanttChart (IlvDisplay *display, const IlvRect &rect, IlInt start, IlInt end, IlInt shownStart, IlInt shownEnd, IlUShort step, IlvDim rowsize, IlvDim lineInfoSize=0, IlvDim unitsize=20, IlvDim scaleH=32, IlvDim sbsize=16, IlUShort spacing=4, IlUShort vwspacing=20, IlUShort offset=0, IlvDim handsize=8, IlvPosition hasScale=IlvTop, IlvPosition hasHSB=IlvBottom, IlvPosition hasVSB=IlvRight, int numLayers=5, IlBoolean useacc=IlTrue, IlvPalette *palette=0)
 Constructor. More...
 
virtual ~IlvGanttChart ()
 Destructor. More...
 
void addLine (IlvGanttLine *line, IlBoolean redraw=IlTrue, int layer=1)
 Appends a line to the Gantt chart. More...
 
virtual void addLink (IlvGanttLink *link, IlBoolean redraw=IlTrue, int layer=2)
 Adds a link to the Gantt chart. More...
 
virtual void addNode (IlvGanttNode *node, IlBoolean redraw=IlTrue, int layer=3)
 Adds a node to the Gantt chart. More...
 
virtual IlBoolean addSubNode (IlvGanttNode *node, IlvGanttSubNode *subnode, IlBoolean redraw=IlTrue, int layer=3)
 Adds a subnode to the Gantt chart node. More...
 
void addSubNodeToHiliteList (IlvGanttSubNode *subnode)
 Adds a subnode to the highlight list. More...
 
void allowDragDrop (IlBoolean flag)
 Specifies whether drag-and-drop operations are allowed. More...
 
virtual IlvPos compactRow (IlUShort row, IlBoolean redraw=IlTrue)
 Compresses the height of a given row. More...
 
void computeGridPoints (IlUShort index)
 Computes the grid points. More...
 
virtual IlvGanttGridViewHookcreateGridHook (IlvGrapher *grapher, IlvView *view)
 Creates the grid hook connected to the view of the grapher. More...
 
virtual IlvScalecreateScale (IlvDisplay *display, const IlvPoint &origin, IlvDim size, IlInt start, IlInt end, IlUShort step, IlvPosition p=IlvTop) const
 Creates a scale object. More...
 
virtual IlvGanttScrollViewHookcreateScrollHook (IlvGrapher *grapher, IlvView *view)
 Creates the scroll hook connected to the view. More...
 
virtual void deleteNodes (IlBoolean destroy, IlBoolean redraw=IlTrue)
 Deletes the Gantt nodes and links stored in the Gantt chart. More...
 
virtual void drawGrid (IlvPort *dst, IlUShort index, IlBoolean skipCompute=IlFalse, const IlvRegion *clip=0, IlvTransformer *trans=0, IlvDirection direction=(IlvDirection)(IlvHorizontal|IlvVertical))
 Draws the grid in the given port. More...
 
void emptyHiliteList ()
 Resets the highlight list to empty. More...
 
virtual void ensureVisible (IlvManager *manager, IlvView *view, const IlvPoint &point, IlBoolean redraw=IlTrue)
 Translates the working view according to the mouse position. More...
 
IlUShort firstVisibleRow (IlUShort index) const
 Gets the first visible row of the manager view. More...
 
virtual void fitViewsTransformerToContents (IlUShort index, IlvDirection dir, IlBoolean redraw=IlTrue)
 Computes the transformer so it shows every object stored in all the visible layers. More...
 
IlvGraphicgetBreakGraphicModel () const
 Gets the break graphic model currently used. More...
 
IlInt getEnd () const
 Gets the end time managed by the chart. More...
 
IlvGraphergetGrapher () const
 Gets the grapher stored in the chart. More...
 
IlvViewgetGrapherView (IlUShort index) const
 Returns the grapher view indicated by index. More...
 
IlvGanttGridViewHookgetGridHook (IlUShort index) const
 Returns the grid hook connected to the view indicated by index. More...
 
IlvPalettegetGridPalette () const
 Returns the palette used to draw the grid. More...
 
IlvFilledRectanglegetHandle () const
 Gets the handle box that controls the size of the views. More...
 
IlvPalettegetHiliteBackGroundPalette () const
 Gets the highlight background palette. More...
 
IlBoolean getHiliteState () const
 Gets the highlight state. More...
 
IlvScrollBargetHorizontalScrollBar (IlUShort index) const
 Gets the horizontal scroll bar. More...
 
IlvGanttLinegetLine (IlUShort row) const
 Gets a Gantt line. More...
 
IlvGraphicgetLineGraphicModel () const
 Gets the line graphic model of the Gantt chart. More...
 
IlvGraphicgetLineGrid () const
 Gets the line grid currently being used. More...
 
IlInt getLineLoad (IlUShort row, IlInt time) const
 Gets the difference between the capacity of a line and the sum of the capacities of all subnodes intersecting with a vertical axis. More...
 
IlUShort getLineRow (const IlvGanttLine *line) const
 Gets the row where the given Gantt line is located. More...
 
IlvGanttLine ** getLines (IlUShort &count) const
 Gets lines managed by the Gantt chart. More...
 
IlvGanttSubNode ** getLineSubNodes (IlUInt &count, IlUShort row) const
 Gets the subnodes associated with the Gantt line. More...
 
IlvGraphicgetLinkGraphicModel () const
 Gets the graphic model of the links. More...
 
IlvManagergetManager () const
 Gets the manager stored in the chart. More...
 
IlvViewgetManagerView (IlUShort index) const
 Returns the manager view indicated by index. More...
 
IlvGanttNodeDrawMode getNodeDrawMode () const
 Gets the node presentation mode. More...
 
IlvGanttNode ** getNodes (IlUInt &count) const
 Gets the nodes managed by the chart. More...
 
IlvGanttAbstractObjectgetObject (const IlvGraphic *graphic) const
 Gets the Gantt object. More...
 
IlvGanttAbstractObjectgetObject (const char *name) const
 Gets the Gantt object with the given name. More...
 
const char * getObjectName (const IlvGanttAbstractObject *obj) const
 Gets the name of the Gantt object. More...
 
IlvGraphicgetRowGrid () const
 Gets the row grid currently being used. More...
 
IlvScalegetScale (IlUShort index) const
 Gets a scale object. More...
 
IlvGanttScrollViewHookgetScrollHook (IlUShort index) const
 Gets the scroll hook connected to the view. More...
 
IlInt getShownEnd (IlUShort index) const
 Gets the current shown end time for the grapher views. More...
 
IlInt getShownStart (IlUShort index) const
 Gets the current shown start time for the grapher views. More...
 
IlInt getStart () const
 Gets the start time managed by the chart. More...
 
IlUShort getStep (IlUShort index) const
 Gets the graduation step in the grapher views of the Gantt chart. More...
 
IlvGanttSubNodegetSubNode (const IlvGraphic *graphic) const
 Returns the Gantt subnode associated with the graphic object graphic in the Gantt chart. More...
 
void getSubNodeDrawnStartEnd (const IlvGanttNode *node, IlUShort index, IlInt &start, IlInt &end) const
 Gets the positions of the given subnode. More...
 
IlvGraphicgetSubNodeGraphicModel () const
 Gets the graphic model of the subnodes. More...
 
IlvGanttSubNodeHookgetSubNodeHook ()
 Gets the subnode hook installed in a Gantt chart. More...
 
IlInt getSubNodeMinimumSize () const
 Gets the minimum size of subnodes. More...
 
IlvScrollBargetVerticalScrollBar (IlUShort index) const
 Gets the vertical scroll bar. More...
 
IlvRectgetWorkArea (IlvRect &area) const
 Returns the work area. More...
 
void grapherViewsBBox (IlvRect &bbox) const
 Gets the bounding box of the four grapher views. More...
 
virtual void handleReshape (const IlvPoint &handlePosition)
 Handles the resizing of views. More...
 
virtual void handleResize (const IlvRect &newsize)
 Handles the resizing of Gantt chart components. More...
 
virtual void installAccelerators ()
 Adds default accelerators to the manager and the grapher event handlers. More...
 
IlBoolean isDoubleBuffering () const
 Returns whether double buffering is enabled.
 
IlBoolean isManaged (const IlvGanttAbstractObject *object) const
 Indicates whether the given object is managed by the Gantt chart. More...
 
IlBoolean isShowingFreeNodes () const
 Indicates whether the chart shows free nodes. More...
 
IlBoolean isShowingGrapherViewBorders () const
 Indicates whether the borders of the grapher views are drawn. More...
 
IlBoolean isShowingGrid () const
 Indicates whether a grid is drawn in the grapher views. More...
 
IlUShort lastVisibleRow (IlUShort index) const
 Gets the last visible row of the manager view. More...
 
virtual void lineBBox (IlUShort row, IlvRect &bbox) const
 Gets the bounding box of a graphic object associated with a Gantt line. More...
 
virtual void loadObjects (IlvInputFile &file)
 Loads a set of objects from the input file. More...
 
void moveHandle (const IlvPoint &position)
 Moves the handle box to a new position. More...
 
virtual IlBoolean moveLine (IlvGanttLine *line, IlUShort row, IlBoolean redraw=IlTrue)
 Moves the line to the given row. More...
 
virtual IlBoolean prettyRowBBox (IlUShort &row, IlvRect &prettyBox, IlBoolean redraw=IlTrue)
 Compresses the height of a given row. More...
 
virtual void prettySubNodeBBox (IlvGanttNode *node, IlUShort index, IlvRect &bbox, IlBoolean redraw=IlTrue)
 Gets the prettied bounding box of a subnode. More...
 
virtual void psDump (const char *filename, IlUInt xmargin=20, IlUInt ymargin=20, IlBoolean rotate=IlTrue) const
 Creates a dump file for PostScript printing. More...
 
void readObjectFile (IlBoolean redraw=IlTrue)
 Reads a set of IlvGraphic, IlvGanttLine, IlvGanttNode, and IlvGanttLink objects from the file associated with the Gantt chart. More...
 
virtual void removeHooks ()
 Removes the hooks from the grapher. More...
 
virtual IlBoolean removeLine (IlUShort row, IlBoolean redraw=IlTrue, IlBoolean destroy=IlTrue)
 Removes a line located at a row from the Gantt chart object set. More...
 
virtual IlBoolean removeLink (IlvGanttLink *link, IlBoolean redraw=IlTrue, IlBoolean destroy=IlTrue)
 Removes a link from the Gantt chart object set. More...
 
virtual IlBoolean removeNode (IlvGanttNode *node, IlBoolean redraw=IlTrue, IlBoolean destroy=IlTrue)
 Removes a node from the Gantt chart object set. More...
 
virtual IlBoolean removeSubNodes (IlvGanttNode *node, IlUShort *indexArray, IlUShort num, IlBoolean redraw=IlTrue, IlBoolean destroy=IlTrue)
 Removes subnodes from the Gantt chart node. More...
 
virtual void resetViewsTransformer (IlUShort index, IlBoolean redraw=IlTrue)
 Resets the transformer so that the initial transformer can be applied. More...
 
void rowBBox (IlUShort row, IlvRect &bbox) const
 Gets the bounding box of a region that contains the graphic object associated with a Gantt line. More...
 
virtual void rowResized (IlUShort row, IlvPos dh) const
 Used to indicate that a Gantt row has been resized. More...
 
IlUShort rows () const
 Gets the number of rows in the Gantt chart. More...
 
virtual void saveObjects (IlvOutputFile &file) const
 Writes the descriptions of the objects stored in the manager to the output file. More...
 
void setBreakGraphicModel (IlvGraphic *model, IlBoolean destroyOld=IlTrue)
 Sets the break graphic model. More...
 
void setGridPalette (IlvPalette *palette)
 Sets the palette used to draw the grid. More...
 
void setHiliteBackGroundPalette (IlvPalette *bgPal)
 Sets the highlight background palette. More...
 
void setHiliteState (IlBoolean hilite=IlTrue)
 Sets the highlight state. More...
 
IlvGraphicsetLineGraphicModel (IlvGraphic *model, IlBoolean deleteOld=IlTrue)
 Sets the line graphic model for the Gantt chart. More...
 
IlvGraphicsetLineGrid (IlvGraphic *compoGrid, IlBoolean redraw=IlTrue, IlInt layer=0)
 Sets the grid for the Gantt lines. More...
 
void setLinkGraphicModel (IlvGraphic *model, IlBoolean deleteOld=IlTrue)
 Sets the graphic model for links. More...
 
virtual void setNodeDrawMode (IlvGanttNode *node, IlvGanttNodeDrawMode mode, IlBoolean redraw=IlTrue)
 Sets the node presentation mode. More...
 
void setNodeDrawMode (IlvGanttNodeDrawMode mode, IlBoolean redraw=IlTrue)
 Sets the node presentation mode. More...
 
void setObjectFileName (const char *name)
 Sets the name of the file associated with the chart. More...
 
IlBoolean setObjectName (IlvGanttAbstractObject *object, const char *name, IlBoolean redraw=IlTrue)
 Sets the name of the Gantt object. More...
 
IlvGraphicsetRowGrid (IlvGraphic *compoGrid, IlBoolean redraw=IlTrue, IlInt layer=0)
 Sets the grid for the Gantt rows. More...
 
void setShowingGrapherViewBorders (IlBoolean flag, IlBoolean redraw=IlTrue)
 Sets the visibility of the borders of the grapher views. More...
 
IlBoolean setStep (IlUShort index, IlUShort step, IlBoolean redraw=IlTrue)
 Sets the graduation step. More...
 
IlvGraphicsetSubNodeGraphicModel (IlvGraphic *model, IlBoolean deleteOld=IlTrue)
 Sets the graphic model for subnodes. More...
 
IlvGanttSubNodeHooksetSubNodeHook (IlvGanttSubNodeHook *hook)
 Installs a subnode hook. More...
 
void setSubNodeMinimumSize (IlInt size)
 Sets the minimum size of subnodes. More...
 
virtual void setSubNodeValues (IlvGanttNode *node, IlUShort index, IlInt startMin, IlInt startMax, IlInt endMin, IlInt endMax, IlvGanttLine *line, IlUShort capacity, IlBoolean redraw=IlTrue)
 Sets the values of the subnodes. More...
 
void showFreeNodes (IlBoolean flag, IlBoolean redraw=IlTrue)
 Sets the display flag of the free nodes. More...
 
void showGrid (IlBoolean flag, IlBoolean redraw=IlTrue)
 Sets the grid display. More...
 
void showInterval (IlUShort index, IlInt shownStart, IlInt shownEnd, IlBoolean redraw=IlTrue)
 Modifies the shown start and end times in the grapher views. More...
 
virtual void subNodeBBox (const IlvGanttNode *node, IlUShort index, IlvRect &bbox) const
 Gets the bounding box of a subnode. More...
 
virtual IlBoolean swapLines (IlvGanttLine *line1, IlvGanttLine *line2, IlBoolean redraw=IlTrue)
 Swaps two Gantt lines. More...
 
virtual void translateViews (IlUShort index, IlvPos deltaCol, IlvPos deltaRow, IlBoolean redraw=IlTrue)
 Translates the given view. More...
 
IlUShort yToClosestRow (IlvPos y) const
 Gets the closest row to a given location. More...
 
IlBoolean yToRow (IlvPos y, IlUShort &row) const
 Gets the row located at a given location. More...
 
virtual IlBoolean zoomViews (IlUShort index, IlvDirection dir, IlUShort fromCol, IlUShort toCol, IlUShort fromRow, IlUShort toRow, IlBoolean redraw=IlTrue)
 Zooms in or out of the given view. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvGanttChart
static IlSymbolWorkAreaCallbackType ()
 Returns the callback type for the "Work Area" callback. More...
 

Detailed Description

Gantt chart form class.

Library: ilvgantt

IlvGanttChartForm is a subclass of IlvGanttChart. It has the following additional features:

<align="center">


An IlvGanttChartForm

The resource table has three parts:

  1. The resource header is at the top of the table. It is mainly used to show the titles of each column of the resource table. In addition, you can adjust the widths of the columns in the same way as you would resize the columns of an IlvSheet. The resource header is an object of the class IlvGanttResourceHeader, which is a subclass of IlvSheet. An IlvGanttResourceHeader is a single row IlvSheet that can be used in exactly the same way as an IlvSheet.
  2. The resources are listed in the main part of the table. Each line displays a resource and is a separate object of the class IlvGanttResourceLine. An IlvGanttResourceLine is a single row IlvScrolledMatrix.
  3. At the bottom of the table is a horizontal scroll bar.

After an IlvGanttChartForm is created, you must create an IlvGanttResourceLine and call the setLineGraphicModel() method in order to specify the IlvGanttResourceLine as the line graphic mode of the IlvGanttChartForm.

For more information on the Gantt chart form, read the <ilvhome>/samples/gantt/calendar/readme.txt file.

See Also
IlvGanttChart.

Constructor & Destructor Documentation

IlvGanttChartForm::IlvGanttChartForm ( IlvDisplay display,
const IlvRect rect,
IlInt  start,
IlInt  end,
IlInt  shownStart,
IlInt  shownEnd,
IlUShort  step,
IlvDim  rowsize,
IlvDim  lineInfoSize = 0,
IlvDim  unitsize = 20,
IlvDim  scaleH = 32,
IlvDim  sbsize = 16,
IlUShort  spacing = 4,
IlUShort  vwspacing = 20,
IlUShort  offset = 0,
IlvDim  separsize = 6,
IlvPosition  hasScale = IlvTop,
IlvPosition  hasHSB = IlvBottom,
IlvPosition  hasVSB = IlvRight,
int  numLayers = 5,
IlBoolean  useacc = IlTrue,
IlvPalette palette = 0 
)

Constructor.

The constructor initializes a new IlvGanttChartForm object. The scales and scroll bars are positioned by default.

Parameters
displayThe display.
rectThe size of the Gantt chart.
startThe start time in the interval managed by the Gantt chart, given as an integer.
endThe end time in the interval managed by the Gantt chart, given as an integer.
shownStartThe shown start time, given as an integer.
shownEndThe shown end time, given as an integer.
stepThe graduation step on all the Gantt chart views.
rowSizeThe initial width of the manager views.
lineInfoSizeThe width of user-defined regions.
unitSizeSpecifies the line-unit height and subnode height.
scaleHIndicates the scale height.
sbsizeSpecifies the height of the horizontal scroll bars and the width of the vertical scroll bars.
spacingIndicates the spacing between Gantt lines and the left, top, right, and bottom sides of the manager views.
vwspacingIndicates the grapher view spacing.
offsetSpecifies the spacing in pixels between the left, right, top, or bottom edge of Gantt chart and any scale, scroll bar, or view.
separsizeSpecifies the width or height in pixels of a square box positioned on the middle of the grapher views. This box allows users to adjust the size of the manager and the grapher views by using the mouse.
hasScaleThis parameter is ignored. The scales are always on the top.
hasHSBThis parameter is ignored. The horizontal scroll bars are always at the bottom.
hasVSBThis parameter is ignored. The vertical scroll bars are always on the right.
numLayersIndicates the number of layers to be handled by the grapher.
useaccAn IlBoolean indicating whether the default accelerators are to be set (for a list of the default accelerators, see Table "Default manager and grapher accelerators").
paletteSpecifies the graphic resources of different Gantt chart components (views, scales, scroll bars, handle box). An inverted palette is computed from the given palette and used to draw the lines and nodes added to the Gantt chart.

Member Function Documentation

virtual void IlvGanttChartForm::deleteAll ( IlBoolean  destroy,
IlBoolean  redraw = IlTrue 
)
virtual

Removes all the objects stored in the chart.

If the destroy parameter is set to IlTrue, the objects are destroyed. If this parameter is set to IlFalse, the objects are removed but not destroyed. In both cases, graphic objects are destroyed.

Parameters
destroySpecifies whether objects are destroyed after they are removed.
redrawSpecifies whether you want the manager and the grapher to redraw their views.

Reimplemented from IlvGanttChart.

IlvGraphic* IlvGanttChartForm::getCompositeGrid ( ) const

Gets the composite grid currently being used.

Returns the composite grid currently used in the Gantt chart form.

Warning
[note] This function has been changed since Views 5.0.

This method is deprecated. Use IlvGanttChart::getRowGrid() instead.

Returns
The composite grid currently used. It returns null if no composite grid has been set.
IlvGraphic* IlvGanttChartForm::getCompositeScale ( ) const

Gets the composite scale currently being used.

Returns the composite scale currently used in the Gantt chart form.

Warning
[note] This function has been changed since Views 5.0.
Returns
The composite scale currently used. It returns null if no composite scale has been set.
virtual IlvRect& IlvGanttChartForm::getLineArea ( IlvRect area) const
virtual

Returns the bounds of the Gantt lines.

This function computes the bounding box of the Gantt lines.

Parameters
areaThe bounds of the Gantt lines.
Returns
The reference to area.

Reimplemented from IlvGanttChart.

IlvGanttResourceHeader* IlvGanttChartForm::getResourceHeader ( ) const

Gets the resource header.

Returns the resource header that is on the top left of the Gantt chart form.

Returns
The resource header. It returns null if the makeView method has not been called.
IlvScrollBar* IlvGanttChartForm::getResourceScrollBar ( ) const

Gets the resource table scroll bar.

Returns the resource table scroll bar that is on the bottom left of the Gantt chart form.

Returns
The resource table scroll bar. It returns null if the makeView method has not been called.
IlvView* IlvGanttChartForm::getScaleView ( IlUShort  viewIndex) const

Gets the scale view.

Returns the scale view that is on the top right of the Gantt chart form.

Parameters
viewIndexValid values are 0 and 1.
Returns
The scale view. It returns null if the makeView method has not been called.
IlvSplitterGadget* IlvGanttChartForm::horizontalSplitter ( IlInt  index) const

Gets the horizontal splitter.

Returns the horizontal splitter of the Gantt chart form.

Parameters
indexValid values are 0 and 1.
Returns
The horizontal splitter of the Gantt chart form. It returns null if the makeView method has not been called.
virtual void IlvGanttChartForm::insertLine ( IlvGanttLine line,
IlUShort  row,
IlBoolean  redraw = IlTrue,
int  layer = -1 
)
virtual

Inserts a line before a row.

If this line already encapsulates a graphic object, this object is added to the Gantt manager. Otherwise, the Gantt chart creates a default graphic object, either by copying a graphic model provided by the user (if any), or by using the IlvMessageLabel constructor, and then adds it to the manager.

If row is greater than the actual number of lines in the chart, the line is added after the last row if the chart does not have a hidden line containing free nodes (see showFreeNodes), or before the last row if there is such a line.

Parameters
lineThe line to insert.
rowThe row to insert the line into.
redrawIndicates whether you want the manager and the grapher to redraw the invalidated area of the display.
layerSpecifies, if necessary, the layer where this object is to be inserted.

Reimplemented from IlvGanttChart.

virtual void IlvGanttChartForm::makeView ( IlvPort dst,
const IlvTransformer t 
)
virtual

Creates the views.

Creates the gadget container, the manager and the grapher, the two manager views, the four grapher views, and the scale objects.

Parameters
dstThe port.
tThe transformer.

Reimplemented from IlvGanttChart.

virtual void IlvGanttChartForm::moveSplitter ( IlvDirection  dir,
IlUInt  index,
IlvPos  pos 
)
virtual

Moves a splitter to a given position.

Moves the given splitter of the Gantt chart form to the position pos. It should not be called if the makeView method has not been called.

This function is used to adjust the size of a pane. It can also be used to collapse or expand a pane.

Parameters
dirSpecifies in which direction the splitter will be moved (IlvHorizontal or IlvVertical).
indexValid values are 0 and 1.
posThe new position for the splitter.
IlvGraphic* IlvGanttChartForm::setCompositeGrid ( IlvGraphic compoGrid,
IlBoolean  redraw = IlTrue 
)

Sets the composite grid for the Gantt chart form.

The composite grid is an IlvGraphic displayed in the grapher views to the right of the Gantt chart form.

The IlvGanttChart::makeView member function will add this composite grid to the grapher of the Gantt chart form.

Warning
[note] This function has been changed since Views 5.0.

This method is deprecated. Use IlvGanttChart::setRowGrid() instead.

Parameters
compoGridThe composite grid.
redrawIlTrue to redraw after setting the composite grid.
Returns
The old scale.
IlvGraphic* IlvGanttChartForm::setCompositeScale ( IlvGraphic compoScale,
IlBoolean  redraw = IlTrue,
IlBoolean  reshape = IlFalse 
)

Sets the composite scale for the Gantt chart form.

The composite scale is an IlvGraphic displayed in the scale views at the top of the Gantt chart form. This function does not delete the composite scale of the IlvGanttChart.

See the <ilvhome>/samples/gantt/calendar sample for more information on the composite scale.

Warning
[note] This function has been changed since Views 5.0.
Parameters
compoScaleThe composite scale.
redrawIlTrue to redraw after setting the composite scale.
reshapeIndicates whether the scale should be reshaped to fit into the total range (start, end) of the Gantt chart.
Returns
The old scale.
virtual void IlvGanttChartForm::setDoubleBuffering ( IlBoolean  doubleBuffer)
virtual

Enables or disables double buffering.

When double buffering is enabled, the manager views and the grapher views of the Gantt chart use double buffering to refresh themselves.

Parameters
doubleBufferIndicates whether double buffering should be enabled.

Reimplemented from IlvGanttChart.

virtual void IlvGanttChartForm::updateScale ( IlvScale scale,
IlBoolean  redraw = IlTrue 
) const
virtual

Updates the scale.

This function is called when a new transformation is applied to the corresponding grapher views. You can set the parameter redraw to IlFalse if you do not want to refresh the view contents.

Parameters
scaleThe scale to update.
redrawIlTrue to refresh the view contents.

Reimplemented from IlvGanttChart.

IlvSplitterGadget* IlvGanttChartForm::verticalSplitter ( IlInt  index) const

Gets the vertical splitter.

Returns the horizontal splitter of the Gantt chart form.

Parameters
indexValid values are 0 and 1.
Returns
The vertical splitter of the Gantt chart form. It returns null if the makeView method has not been called.

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