Rogue Wave Views Application Framework Package API Reference Guide |
Rogue Wave Views Documentation Home |
The IlvDvViewContainerInterface
class is an interface for windows that own document views.
More...
#include <ilviews/appframe/viewcont.h>
Public Member Functions | |
virtual IlBoolean | attachDocViews (IlvDvDocViewInterface **views, IlUInt viewsCount) |
Attaches the document views views to the container. More... | |
virtual IlvDvDocViewInterface * | getActiveDocView () const |
Gets the active view for the container. More... | |
virtual IlvGadgetContainer * | getClientContainer (IlBoolean create=IlFalse) |
Gets the client container. More... | |
virtual IlvDvContainerHandler * | getContainerHandler () const =0 |
Gets the container handler that handles this container. | |
virtual IlUInt | getContainerNumber () const =0 |
Gets the container number. More... | |
virtual const char * | getContainerTitle () const =0 |
Gets the title of the container. More... | |
IlvDvDocViewInterface * | getDocView (IlUInt index) const |
Gets the document view located at the position index. | |
IlUInt | getDocViewsCount () const |
Gets the document views count. More... | |
virtual IlvDvApplication * | getDvApplication () const =0 |
Gets the application in which the container is created. More... | |
virtual IlBoolean | isContainerVisible () const =0 |
Gets the visibility state of the container. More... | |
virtual IlBoolean | readMask (const char *pathName) |
Called to read the given pathName .ilv file as a mask for the container. More... | |
virtual void | setActiveDocView (IlvDvDocViewInterface *activeView, IlBoolean notify=IlTrue) |
Sets the active document view to the parameter activeView. More... | |
virtual void | setContainerNumber (IlUInt n, IlBoolean update=IlFalse)=0 |
Sets the container number. More... | |
virtual void | setDvApplication (IlvDvApplication *app)=0 |
Sets the application in which the container is created to the parameter app. | |
virtual void | updateTitle ()=0 |
Updates the container title. 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... | |
Protected Member Functions | |
virtual IlvArray & | getViewsArray ()=0 |
Gets the array of document views owned by the container. More... | |
virtual IlBoolean | isUsingMask () const =0 |
Returns IlTrue if the container uses an .ilv mask when attaching its document views. More... | |
virtual const IlvString & | makeTitle (IlvString &title) const |
Creates a title for the container, according to the title of the associated document, its modification state, and the window number of the container. These parameters are joined together as follows to create the container title:<DocumentTitle>[:<ContainerNumber>] [*] More... | |
virtual void | setUsingMask (IlBoolean useMask)=0 |
Specifies whether the container uses an .ilv mask when adding its document views. More... | |
virtual void | storeActiveDocView (IlvDvDocViewInterface *activeView)=0 |
Stores the document view activeView as the active view. | |
The IlvDvViewContainerInterface
class is an interface for windows that own document views.
Library: ilvappframe
Document view containers are created and handled by the document templates. The Application Framework package provides two types of document view containers that inherit from the IlvDvViewContainerInterface
interface:
IlvDvViewFrame
class. IlvDvViewPane
class.
|
virtual |
Attaches the document views views to the container.
The given views are created and given by the document template. If an .ilv
mask file was specified, objects from the client container with the names View0
, View1
, and so on, are replaced by the document views views[0]
, views[1]
, until viewsCount.
IlTrue
if the document views are attached to the container.
|
virtual |
Gets the active view for the container.
Returns the last document view that received the focus inside the container. The active view is set by a call to the method setActiveDocView
.
Reimplemented in IlvDvViewPane.
|
virtual |
Gets the client container.
create | If IlTrue , the client container is created (if it did not already exist). |
Reimplemented in IlvDvViewPane.
|
pure virtual |
Gets the container number.
Returns the number set by the document template by calling the method setContainerNumber
. This number is used to build different window titles for windows that contain views associated with the same document. For example, two windows that show the same document titled Document1
may have titles Document1
and Document1:2
.
Implemented in IlvDvViewPane.
|
pure virtual |
IlUInt IlvDvViewContainerInterface::getDocViewsCount | ( | ) | const |
Gets the document views count.
|
pure virtual |
Gets the application in which the container is created.
The application is set by a call to the method setDvApplication
.
Implemented in IlvDvViewPane.
|
protectedpure virtual |
Gets the array of document views owned by the container.
Implemented in IlvDvViewPane.
|
pure virtual |
Gets the visibility state of the container.
IlTrue
if the container is visible. Implemented in IlvDvViewPane.
|
protectedpure virtual |
Returns IlTrue
if the container uses an .ilv
mask when attaching its document views.
This flag is set when method setUsingMask
is called.
IlTrue
if the container uses an .ilv
mask when attaching its document views. Implemented in IlvDvViewPane.
|
protectedvirtual |
Creates a title for the container, according to the title of the associated document, its modification state, and the window number of the container. These parameters are joined together as follows to create the container title:
<DocumentTitle>[:<ContainerNumber>] [*]
title | Gets the title of the container. |
|
virtual |
Called to read the given pathName .ilv
file as a mask for the container.
This file is read by the client container and added document views replace client container objects of name View[nView]
.
Reimplemented in IlvDvViewPane.
|
virtual |
Sets the active document view to the parameter activeView.
activeView | Specifies the new active view. |
notify | If IlTrue , the activeView parameter is notified that it is becoming active. It is notified by calling its method setActive . |
|
pure virtual |
Sets the container number.
Called to set the container number to the given n parameter. This method is usually called when the document associated with the owned document views has its title changed.
n | The new container number. |
update | If param is IlTrue , the updateTitle method is called. |
Implemented in IlvDvViewPane.
|
protectedpure virtual |
Specifies whether the container uses an .ilv
mask when adding its document views.
The parameter useMask specifies if the container uses an .ilv
mask when adding its document views. This method is called by the readFile
method, with the useMask parameter set to IlTrue
if the file is valid. This file name was set previously by calling the readMask
method.
Implemented in IlvDvViewPane.
|
pure virtual |
Updates the container title.
Called when the title of the container needs to be updated. This usually occurs when the title of the document attached to the document view container changes.
Implemented in IlvDvViewPane.
© 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.