Rogue Wave Views
Application Framework Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvDvView Class Reference

Application Framework implementation of the Document View interface for the IlvView class. More...

#include <ilviews/appframe/view.h>

Inheritance diagram for IlvDvView:
IlvView IlvDvDocViewInterface IlvAbstractView IlvDvSerializable IlvDvInterface IlvSystemPort IlvStylable IlvPort IlvValueInterface IlvDvManagerView IlvDvGrapherView

Public Member Functions

 IlvDvView (IlvGadgetContainer *parent)
 Constructs an IlvDvView object. More...
 
virtual IlvAbstractViewgetDvView ()
 Gets the IlvAbstractView of the document view. More...
 
- Public Member Functions inherited from IlvDvDocViewInterface
IlvDvDocumentgetDocument () const
 Gets the document associated with the view. More...
 
IlvDvApplicationgetDvApplication () const
 Gets the application in which the document view is displayed. More...
 
virtual IlvGraphicgetGraphic ()
 Gets the graphic object of the document view. More...
 
IlvDvViewContainerInterfacegetViewContainer () const
 Gets the document view container that owns the view. More...
 
virtual void initializeView ()
 Initializes the document view. More...
 
virtual void serialize (IlvDvStream &)
 Serializes the object in the stream stream.
Typically, the body of the method has the following form:
More...
 
- Public Member Functions inherited from IlvDvInterface
IlBoolean callMethod (const IlSymbol *methodName, IlvDvValue *returnedValue,...)
 Generic method for calling a method that is exported in a class interface. More...
 
IlvDvValuegetFieldValue (const IlSymbol *fieldName, IlvDvValue &value) const
 Gets a field value. More...
 
virtual IlBoolean isProcessingAction (const IlSymbol *methodName) const
 Returns IlTrue if the given action can be processed by the class. More...
 
virtual IlBoolean processAction (const IlSymbol *actionName)
 Processes an action. More...
 
virtual IlBoolean refreshAction (const IlSymbol *actionName, IlvDvActionDescriptor *desc) const
 Refresh all the menu items that reference the action given by the parameter actionName. More...
 
void setFieldValue (const IlSymbol *fieldName, const IlvDvValue &value)
 Sets a field value. More...
 

Detailed Description

Application Framework implementation of the Document View interface for the IlvView class.

Library: ilvappframe

IlvDvView is a subclass of IlvView and implements the IlvDvDocViewInterface interface. It is used for displaying document data in an IlvView view. For example, the IlvDvManagerView class inherits from this class to display the manager of its associated document.
Subclasses of IlvDvView must be declared and implemented with specific macros, therefore allowing instances of these classes to be created automatically by the document templates. Here is a schematic sample that shows how macros must be used:

class MyViewClass
: public IlvDvView {
IlvDvDeclareViewCreate();
public:
MyViewClass(IlvGadgetContainer* parent) : IlvDvView(parent) {}
...
};
// Implementation file
IlvDvPreRegisterViewClass(MyViewClass, IlvDvView);
IL_BEGINMODULEINITDEF(mymodule)
IlvDvPostRegisterViewClass(MyViewClass, IlvDvView);
IL_ENDMODULEINITDEF(mymodule)

Constructor & Destructor Documentation

IlvDvView::IlvDvView ( IlvGadgetContainer parent)

Constructs an IlvDvView object.

This constructor creates an instance of IlvDvView.

Parameters
parentSpecifies the parent of the IlvView object.

Member Function Documentation

virtual IlvAbstractView* IlvDvView::getDvView ( )
virtual

Gets the IlvAbstractView of the document view.

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

Returns
The abstract view of the document view.

Reimplemented from IlvDvDocViewInterface.


© Copyright 2016, 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.