IlsVwConnectionPanel

Category

Dynamic view-related class

Inheritance Path

Description

This class defines a Rogue Wave Views connection panel, allowing the user to connect to one or more servers, query the objects that were declared on them, and open views.

Library

Header File

#include <ilmvpan/vwconpan.h>

Synopsis

class IlsVwConnectionPanel {

public:

Initialization

static void Initialize

(IlvDisplay*,

const IlsString& representationPattern = "*",

IlvBoolean visible = IlvTrue,

IlvBoolean createLogWindow = IlvTrue);

static IlsVwConnectionPanel* GetSingleton();

Showing/Hiding Connection Panel

virtual void showConnectionPanel();

virtual void hideConnectionPanel();

Opening a View

virtual void forceOpenView(IlvBoolean b);

IlsBoolean forceOpenView();

void setOpenViewCallback

(IlsVwConnectionPanelOpenViewCallbackType cb,

IlsAny arg=0);

void removeOpenViewCallback();

Log Window

static void HandleMessage(const IlsMvMessage::SvMsg& msg);

virtual void showLogWindow() const;

virtual void hideLogWindow() const;

virtual void clearLogWindow() const;

virtual void saveLogWindow(const IlsString& filename) const;

Other Function

void setRepresentationPattern(IlsString pattern);

};

Member Functions

Initialization

[static] void Initialize(IlvDisplay*,

const IlsString& representationPattern = "*",

IlvBoolean visible = IlvTrue,

IlvBoolean createLogWindow = IlvTrue);

This static member function initializes the connection panel. It takes the following parameters:

Specify the optional parameter representationPattern if you want only certain representation types to be queried on the server —for example, IlsSwRepresentation or IlsRepresentation.

The parameter visible controls whether the connection panel is shown when it is created.

If the Boolean argument createLogWindow is set to IlvTrue, the connection panel creates a log window and redirects all Server messages to the static member function HandleMessage, documented below.


Note: Messages will not be redirected if the ILS_LOGFILE environment variable is set.

[static] IlsVwConnectionPanel* GetSingleton();

This static member function returns the unique instance of the connection panel if it has been initialized.

Showing/Hiding Connection Panel

[virtual] void showConnectionPanel();

This virtual member function displays the connection panel.

[virtual] void hideConnectionPanel();

This virtual member function hides the connection panel.

Opening a View

[virtual] void forceOpenView(IlvBoolean b);

This virtual member function sets the forceOpenView property to the Boolean value b. If this property is set to IlsTrue, the view opened from the connection panel will be opened in force mode. By default, this property is set to IlsFalse.

IlsBoolean forceOpenView();

This member function returns the Boolean value of the forceOpenView property.

void setOpenViewCallback(IlsVwConnectionPanelOpenViewCallbackType cb,

IlsAny arg=0);

This member function installs a callback that is called as soon as the user tries to open a view through the connection panel. See the type definition of IlsVwConnectionPanelOpenViewCallbackType.

void removeOpenViewCallback();

This member function removes the callback installed by the member function setOpenViewCallback, documented above.

Log Window

[static] void HandleMessage(const IlsMvMessage::SvMsg& msg);

This static member function logs the received message into the log window, if such a log window has been created at panel initialization (see the function Initialize above).

[virtual] void showLogWindow() const;

This virtual member function shows the log window if a log window has been created.

[virtual] void hideLogWindow() const;

This virtual member function hides the log window if a log window has been created.

[virtual] void clearLogWindow() const;

This virtual member function deletes the contents of the log window if a log window has been created.

[virtual] void saveLogWindow(const IlsString& filename) const;

This virtual member function writes the contents of the log window to the file filename.

Other Function

void setRepresentationPattern(IlsString pattern);

This member function specifies the representation pattern that will be used when querying objects from the server. The pattern must be a “wildmat” style pattern, such as IlsSwRep*.