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. More...

#include <ilmvpan/vwconpan.h>

Inherits IlsAbstractConnectionPanel.

Public Member Functions
virtual void	setRepresentationPattern (const IlsString &pat)
	Specifies the representation pattern that will be used when querying objects from the server. More...

Opening a View
void	setOpenViewCallback (IlsVwConnectionPanelOpenViewCallbackType cb, IlsAny arg=0)
	Installs a callback that is called as soon as the user tries to open a view through the connection panel. More...

void	removeOpenViewCallback ()
	Removes the callback installed by the member function `setOpenViewCallback()`.

virtual void	forceOpenView (IlvBoolean b)
	Sets the `forceOpenView` property to the Boolean value b. More...

IlsBoolean	forceOpenView ()
	Returns the boolean value of the `forceOpenView` property.

Showing/Hiding Connection Panel
virtual void	showConnectionPanel ()
	Displays the connection panel.

virtual void	hideConnectionPanel ()
	Hides the connection panel.

Static Public Member Functions
Initialization
static void	Initialize (IlvDisplay display, const IlsString &representationPattern="", IlvBoolean visible=IlvTrue, IlvBoolean createLogWindow=IlvTrue)
	Initializes the connection panel. More...

static IlsVwConnectionPanel *	GetSingleton ()
	Returns the unique instance of the connection panel if it has been initialized.

Log Window
virtual void	showLogWindow () const
	Shows the log window if a log window has been created.

virtual void	hideLogWindow () const
	Hides the log window if a log window has been created.

virtual void	clearLogWindow () const
	Deletes the contents of the log window if a log window has been created.

virtual void	saveLogWindow (const IlsString &filename) const
	Writes the contents of the log window to the file filename.

static void	HandleMessage (const IlsMvMessage::SvMsg &msg)
	Logs the received message into the log window, if such a log window has been created at panel initialization (see the function `Initialize()`).

Detailed 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: mvconpan

See also: IlsRepresentation, IlsSwComponent, IlsSwRepresentation.

Member Function Documentation

◆ forceOpenView()

virtual void IlsVwConnectionPanel::forceOpenView ( IlvBoolean b )

virtual

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.

◆ Initialize()

static void IlsVwConnectionPanel::Initialize	(	IlvDisplay *	display,
		const IlsString &	representationPattern = `"*"`,
		IlvBoolean	visible = `IlvTrue`,
		IlvBoolean	createLogWindow = `IlvTrue`
	)

static

Initializes the connection panel.

Parameters

display	pointer to the display
representationPattern	Specify the optional parameter `representationPattern` if you want only certain representation types to be queried on the server – for example, `IlsSwRepresentation` or `IlsRepresentation`.
visible	controls whether the connection panel is shown when it is created.
createLogWindow	if set to `IlvTrue`, the connection panel creates a log window and redirects all Server messages to the static member function `HandleMessage().

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

◆ setOpenViewCallback()

void IlsVwConnectionPanel::setOpenViewCallback	(	IlsVwConnectionPanelOpenViewCallbackType	cb,
		IlsAny	arg = `0`
	)

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.

◆ setRepresentationPattern()

virtual void IlsVwConnectionPanel::setRepresentationPattern ( const IlsString & pat )

virtual

Specifies the representation pattern that will be used when querying objects from the server.