Views
Application Framework Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions | Protected Member Functions
IlvDvTreeView Class Reference

Application Framework text document view. More...

#include <ilviews/appframe/viewgadg.h>

Inheritance diagram for IlvDvTreeView:
IlvDvDocViewInterface IlvDvSerializable IlvDvInterface IlvDvProjectView

Public Member Functions

 IlvDvTreeView (IlvDisplay *display)
 Constructs an IlvDvTreeView object. More...
 
virtual IlvGraphicgetGraphic ()
 Gets the graphic object 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 IlvAbstractViewgetDvView ()
 Gets the IlvAbstractView 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...
 

Protected Member Functions

virtual void activateSelection ()
 Activates the selected items.
 
virtual IlvPopupMenugetPopupMenuForItem (const IlvTreeGadgetItem *item)
 Returns the popup menu shown when a right-click occurs on the item item.
More...
 
virtual const IlSymbolgetPopupMenuResourceId (const IlvTreeGadgetItem *item) const
 Returns the popup menu resource id that will allow you to construct the popup menu shown when a right-click occurs on the item item.
More...
 
virtual void rightClickOnItem (IlvTreeGadgetItem *item, const IlvPoint &pt)
 Called when the user right-clicks a tree gadget item. More...
 

Detailed Description

Application Framework text document view.

Library: ilvappframe

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

class MyTreeView
: public IlvDvTreeView {
IlvDvDeclareGadgetViewCreate();
public:
MyTreeView(IlvDisplay* display) : IlvDvTreeView(display) {}
virtual void initializeView();
...
};
// Implementation file
void
MyTreeView::initializeView()
{
// My initialization code here
}
...
IlvDvPreRegisterGadgetViewClass(MyTreeView, IlvDvTreeView);
IL_BEGINMODULEINITDEF(mymodule)
IlvDvPostRegisterDocIlvViewClass(MyTreeView, IlvDvTreeView);
IL_ENDMODULEINITDEF(mymodule)

Constructor & Destructor Documentation

◆ IlvDvTreeView()

IlvDvTreeView::IlvDvTreeView ( IlvDisplay display)

Constructs an IlvDvTreeView object.

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

Member Function Documentation

◆ getGraphic()

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

◆ getPopupMenuForItem()

virtual IlvPopupMenu* IlvDvTreeView::getPopupMenuForItem ( const IlvTreeGadgetItem item)
protectedvirtual

Returns the popup menu shown when a right-click occurs on the item item.

It is called by the method rightClickOnItem.

Parameters
itemThe item under the right-click.

◆ getPopupMenuResourceId()

virtual const IlSymbol* IlvDvTreeView::getPopupMenuResourceId ( const IlvTreeGadgetItem item) const
protectedvirtual

Returns the popup menu resource id that will allow you to construct the popup menu shown when a right-click occurs on the item item.

The resource id is the name entered for the corresponding popup menu in the application editor.
It is called by the method getPopupMenuForItem.

Parameters
itemThe item under the right-click.

Reimplemented in IlvDvProjectView.

◆ rightClickOnItem()

virtual void IlvDvTreeView::rightClickOnItem ( IlvTreeGadgetItem item,
const IlvPoint pt 
)
protectedvirtual

Called when the user right-clicks a tree gadget item.

By default, it gets a popup menu by calling method getPopupMenuForItem and then displays it.

Parameters
itemThe item under the right-click.
ptThe position of the mouse when the right-click occurs.
IlvDvDocViewInterface::initializeView
virtual void initializeView()
Initializes the document view.
IlvDvTreeView
Application Framework text document view.
Definition: viewgadg.h:326
IlvDisplay