rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Application Framework Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvDvMatrixView Class Reference

Application Framework text document view. More...

#include <ilviews/appframe/viewgadg.h>

Inheritance diagram for IlvDvMatrixView:
IlvMatrix IlvDvDocViewInterface IlvAbstractMatrix IlvGadgetItemHolder IlvDvSerializable IlvDvInterface IlvScrolledGadget IlvGadget IlvSimpleGraphic IlvGraphic

List of all members.

Public Member Functions

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

Detailed Description

Application Framework text document view.

Library: ilvappframe

IlvDvMatrixView is a subclass of IlvMatrix that implements the IlvDvDocViewInterface interface. It is used for displaying the text of the document in an IlvMatrix gadget.
Classes that inherit from the IlvDvMatrixView 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 IlvDvMatrixView:

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

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

Constructor & Destructor Documentation

IlvDvMatrixView::IlvDvMatrixView ( IlvDisplay display  ) 

Constructs an IlvDvMatrixView object.

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


Member Function Documentation

virtual IlvGraphic* IlvDvMatrixView::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.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

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