rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Application Framework Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvDvHierarchicalSheetView Class Reference

Application Framework text document view. More...

#include <ilviews/appframe/viewgadg.h>

Inheritance diagram for IlvDvHierarchicalSheetView:
IlvHierarchicalSheet IlvDvDocViewInterface IlvSheet IlvDvSerializable IlvDvInterface IlvMatrix IlvAbstractMatrix IlvGadgetItemHolder IlvScrolledGadget IlvGadget IlvSimpleGraphic IlvGraphic

List of all members.

Public Member Functions

 IlvDvHierarchicalSheetView (IlvDisplay *display)
 Constructs an IlvDvHierarchicalSheetView object.
virtual IlvGraphicgetGraphic ()
 Gets the graphic object of the document view.

Detailed Description

Application Framework text document view.

Library: ilvappframe

IlvDvHierarchicalSheetView is a subclass of IlvHierarchicalSheet that implements the IlvDvDocViewInterface interface. It is used for displaying the text of the document in an IlvHierarchicalSheet gadget.
Classes that inherit from the IlvDvHierarchicalSheetView class must be declared and implemented with specific macros, which allows instances of these classes to be created automatically by the document templates.
The following code sample shows how to derive from IlvDvHierarchicalSheetView:

 class MyHierarchicalSheetView
 : public IlvDvHierarchicalSheetView {
     IlvDvDeclareGadgetViewCreate();
 public:
     MyHierarchicalSheetView(IlvDisplay* display)
     : IlvDvHierarchicalSheetView(display) {}
     virtual void initializeView();
     ...
 };

 // Implementation file
 void
 MyHierarchicalSheetView::initializeView()
 {
     IlvDvHierarchicalSheetView::initializeView();
     // My initialization code here
 }
 ...
 IlvDvPreRegisterGadgetViewClass(MyHierarchicalSheetView,
                                 IlvDvHierarchicalSheetView);
 IL_BEGINMODULEINITDEF(mymodule)
     IlvDvPostRegisterDocIlvViewClass(MyHierarchicalSheetView,
                                      IlvDvHierarchicalSheetView);
 IL_ENDMODULEINITDEF(mymodule)

Constructor & Destructor Documentation

IlvDvHierarchicalSheetView::IlvDvHierarchicalSheetView ( IlvDisplay display  ) 

Constructs an IlvDvHierarchicalSheetView object.

This constructor creates an instance of IlvDvHierarchicalSheetView whose display is given by the parameter display.


Member Function Documentation

virtual IlvGraphic* IlvDvHierarchicalSheetView::getGraphic (  )  [virtual]

Gets the graphic object of the document view.

Must be redefined by the class that implements the interface if the class inherits from the IlvGraphic class. In this case, the redefined method only returns this object. For example, the IlvDvTextView class redefines this method to return (IlvText*)this object. By default, the method returns 0.

Returns:
The graphic object of the document view.

Reimplemented from IlvDvDocViewInterface.


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