IlvControlBrowser Class Reference

Class that encapsulate a dialog to select an ActiveX. More...

#include <ilviews/windows/cbrowser.h>

Public Member Functions
	IlvControlBrowser (IlvSystemView parent, const char *title=0)
	Constructor. More...
	~IlvControlBrowser ()
	Destructor. More...
void	setTitle (const char *title)
	Sets the title of the dialog. More...
const char *	show ()
	Shows the dialog. More...
const char *	show (IlvPos x, IlvPos y)
	Shows the dialog at a specified position. More...
const char *	showToMouse (IlvDisplay *display, IlvDirection justification=IlvCenter, IlvPos dx=0, IlvPos dy=0, IlBoolean ensureInScreen=IlTrue)
	This function shows the dialog at a position relative to the position of mouse pointer. More...
const char *	showToScreen (IlvDisplay *display, IlvDirection justification=IlvCenter, IlvPos dx=0, IlvPos dy=0, IlBoolean ensureInScreen=IlTrue)
	This function shows the dialog at a position relative to the working space screen. More...
const char *	showToView (const IlvView *view, IlvDirection justification=IlvCenter, IlvPos dx=0, IlvPos dy=0, IlBoolean ensureInScreen=IlTrue)
	This function shows the dialog at a position relative to the position of the view given as parameter. More...

Detailed Description

Class that encapsulate a dialog to select an ActiveX.

Library: ilvcom

Constructor & Destructor Documentation

IlvControlBrowser()

IlvControlBrowser::IlvControlBrowser	(	IlvSystemView	parent,
		const char *	title = 0
	)

Constructor.

This constructor initializes an ActiveX selector.

Parameters

parent	The parent system view.
title	The title of the dialog.

~IlvControlBrowser()

IlvControlBrowser::~IlvControlBrowser

(

)

Destructor.

The destructor releases the resources used by this object.

Member Function Documentation

setTitle()

void IlvControlBrowser::setTitle

(

const char *

title

)

Sets the title of the dialog.

Parameters

title

The title of the dialog.

show() [1/2]

const char* IlvControlBrowser::show

(

)

Shows the dialog.

Returns

A const pointer to a C-style string. This is either a null pointer when the user closed the dialog by clicking on Cancel or a pointer to a string that contains the CLSID of the control chosen by the user. This string is valid as long as the dialog is valid and one of theshow was not called.

show() [2/2]

const char* IlvControlBrowser::show	(	IlvPos	x,
		IlvPos	y
	)

Shows the dialog at a specified position.

Parameters

x	The horizontal position of the dialog.
y	The vertical position of the dialog.

Returns

A const pointer to a C-style string. This is either a null pointer when the user closed the dialog by clicking on Cancel or a pointer to a string that contains the CLSID of the control chosen by the user. This string is valid as long as the dialog is valid and one of theshow was not called.

showToMouse()

const char* IlvControlBrowser::showToMouse	(	IlvDisplay *	display,
		IlvDirection	justification = IlvCenter,
		IlvPos	dx = 0,
		IlvPos	dy = 0,
		IlBoolean	ensureInScreen = IlTrue
	)

This function shows the dialog at a position relative to the position of mouse pointer.

This function is similar to the function IlvView::moveToMouse, except that it shows the dialog and returns the value chosen by the user.
The dialog is shown at the position so that the point indicated by the position of the pointing device, with an offset of dx and dy.
The parameter justification specifies the point in the dialog that must be shown at the mouse location:

• IlvCenter: the center of the dialog.
• IlvTop: the middle of the top side of the dialog.
• IlvBottom: the middle of the bottom of the dialog.
• IlvLeft: the middle of the left side of the dialog.
• IlvRight: the middle of the right side of the dialog.
• IlvTopLeft: the top left corner of the dialog.
• IlvTopRight: the top right corner of the dialog.
• IlvBottomLeft: the bottom left corner of the dialog.
• IlvBottomRight: the bottom right corner of the dialog.

Parameters

display	A const pointer to an IlvDisplay.
justification	An IlvDirection that gives how the position must be computed relatively to the view.
dx	An IlvPos that gives the offset for the abscissa.
dy	An IlvPos that gives the offset for the ordinate.
ensureInScreen	An IlBoolean that indicates whether the dialog must be thoroughly inside the working space of the screen (if possible).

Returns

A const pointer to a C-style string. This is either a null pointer when the user closed the dialog by clicking on Cancel or a pointer to a string that contains the CLSID of the control chosen by the user. This string is valid as long as the dialog is valid and one of theshow was not called.

showToScreen()

const char* IlvControlBrowser::showToScreen	(	IlvDisplay *	display,
		IlvDirection	justification = IlvCenter,
		IlvPos	dx = 0,
		IlvPos	dy = 0,
		IlBoolean	ensureInScreen = IlTrue
	)

This function shows the dialog at a position relative to the working space screen.

This function is similar to the function IlvView::moveToScreen, except that it shows the dialog and returns the value chosen by the user.
The dialog is shown at the position indicated by justification, relative to the screen, with an offset of dx and dy.
Valid values for justification are:

• IlvCenter: the center of the dialog is at the center of the screen.
• IlvTop: the top side of the dialog is at the top of the screen.
• IlvBottom: the bottom side of the dialog is at the bottom of the screen.
• IlvLeft: the left side of the dialog is at the left of the screen.
• IlvRight: the right side of the dialog is at the right of the screen.
• IlvTopLeft: the top left corner of the dialog is at the top left of the screen.
• IlvTopRight: the top right corner of the dialog is at the top right of the screen.
• IlvBottomLeft: the bottom left corner of the dialog is at the bottom left of the screen.
• IlvBottomRight: the bottom right corner of the dialog is at the bottom right of the screen.

Parameters

display	A const pointer to an IlvDisplay.
justification	An IlvDirection that gives how the position must be computed relatively to the view.
dx	An IlvPos that gives the offset for the abscissa.
dy	An IlvPos that gives the offset for the ordinate.
ensureInScreen	An IlBoolean that indicates whether the dialog must be thoroughly inside the working space of the screen (if possible).

Returns

A const pointer to a C-style string. This is either a null pointer when the user closed the dialog by clicking on Cancel or a pointer to a string that contains the CLSID of the control chosen by the user. This string is valid as long as the dialog is valid and one of theshow was not called.

showToView()

const char* IlvControlBrowser::showToView	(	const IlvView *	view,
		IlvDirection	justification = IlvCenter,
		IlvPos	dx = 0,
		IlvPos	dy = 0,
		IlBoolean	ensureInScreen = IlTrue
	)

This function shows the dialog at a position relative to the position of the view given as parameter.

This function is similar to the function IlvView::moveToView, except that it shows the dialog and returns the value chosen by the user.
The dialog is shown at the position indicated by justification, relative to the position and size of view, that must be a top view, with an offset of dx and dy. These offset are relative to view, that means, for example, that when the dialog is justified with IlvLeft, the offset dx will be subtracted to the abscissa, and when the dialog is justified with IlvRight, the offset dx will be added to the abscissa. The principle is the same for the offset dy.
Valid values for justification are:

• IlvCenter: the center of the dialog is at the center of view.
• IlvTop: the bottom of the dialog is at the top of view.
• IlvBottom: the top of the dialog is at the bottom of view.
• IlvLeft: the right side of the dialog is at the left side of view.
• IlvRight: the left side of the dialog is at the right side of view.
• IlvTopLeft: the bottom right corner of the dialog is at the top left corner of view.
• IlvTopRight: the bottom left corner of the dialog is at the top right corner of view.
• IlvBottomLeft: the top right corner of the dialog is at the bottom left corner of view.
• IlvBottomRight: the top left corner of the dialog is at the bottom right corner of view.

Parameters

view	A const pointer to an IlvView. This parameter references the view from which the position is computed.
justification	An IlvDirection that gives how the position must be computed relatively to the view.
dx	An IlvPos that gives the offset for the abscissa.
dy	An IlvPos that gives the offset for the ordinate.
ensureInScreen	An IlBoolean that indicates whether the dialog must be thoroughly inside the working space of the screen (if possible).

Returns

A const pointer to a C-style string. This is either a null pointer when the user closed the dialog by clicking on Cancel or a pointer to a string that contains the CLSID of the control chosen by the user. This string is valid as long as the dialog is valid and one of theshow was not called.