IlvDvTextView Class Reference

Application Framework text document view. More...

#include <ilviews/appframe/viewgadg.h>

Inheritance diagram for IlvDvTextView:

Public Member Functions
	IlvDvTextView (IlvDisplay *display)
	Constructs an IlvDvTextView object. More...
virtual IlvGraphic *	getGraphic ()
	Gets the graphic object of the document view. More...
virtual void	initializeView ()
	Initializes the text view. More...
Public Member Functions inherited from IlvDvDocViewInterface
IlvDvDocument *	getDocument () const
	Gets the document associated with the view. More...
IlvDvApplication *	getDvApplication () const
	Gets the application in which the document view is displayed. More...
virtual IlvAbstractView *	getDvView ()
	Gets the IlvAbstractView of the document view. More...
IlvDvViewContainerInterface *	getViewContainer () const
	Gets the document view container that owns the 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...
IlvDvValue &	getFieldValue (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 text document view.

Library: ilvappframe

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

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

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

Constructor & Destructor Documentation

IlvDvTextView()

IlvDvTextView::IlvDvTextView

(

IlvDisplay *

display

)

Constructs an IlvDvTextView object.

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

Member Function Documentation

getGraphic()

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

initializeView()

virtual void IlvDvTextView::initializeView ( )

virtual

Initializes the text view.

Called by the document associated with the view to initialize its contents. By default, this method sends the generic message GetText to the document in order to retrieve the document text. If the document class inherits from the IlvDvTextDocument class, this message is processed automatically. Otherwise, the method defined for processing this generic message must return a const char* value. This is illustrated in the following code sample:

IlvDvBeginInterface(MyTextDocument)
        TypedMethod(GetText, getText, const char*)
IlvDvEndInterface1(IlvDvDocument)
...
const char*
MyTextDocument::getText() const
{
        return _myText;
}

Reimplemented from IlvDvDocViewInterface.