rwlogo

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Classes | Macros | Typedefs | Enumerations | Functions
ilv.h File Reference
#include <ilviews/base/list.h>
#include <ilviews/base/array.h>
#include <ilviews/base/stylist.h>
#include <ilviews/base/resource.h>
#include <ilviews/base/event.h>
#include <ilviews/base/iostream.h>
#include <ilviews/base/port.h>

Classes

class  IlvDisplay
 Display class. More...
 
class  IlvTransformer
 Geometric transformation class. More...
 

Macros

#define IlvDefaultMarkerSize
 
#define IlvMarkerCircle
 
#define IlvMarkerCross
 
#define IlvMarkerDiamond
 
#define IlvMarkerFilledCircle
 
#define IlvMarkerFilledDiamond
 
#define IlvMarkerFilledSquare
 
#define IlvMarkerFilledTriangle
 
#define IlvMarkerPlus
 
#define IlvMarkerSquare
 
#define IlvMarkerTriangle
 

Typedefs

typedef IlvPosition IlvAlignment
 
typedef IlvPosition IlvDirection
 
typedef void(* IlvDisplayCallback )(IlAny userArg)
 
typedef void(* IlvDisplayConfigCallback )(IlvDisplayConfig *config)
 
typedef IlUShort IlvMarkerType
 
typedef IlvPosition IlvOrientation
 
typedef SystemWindowType IlvSystemView
 A system-dependent type that holds a window. More...
 
typedef IlDouble IlvTransfoParam
 The type of the internal values of all IlvTransformers. More...
 

Enumerations

enum  IlvLookStyle {
  IlvOtherLook, IlvMotifLook, IlvWindowsLook, IlvWindows95Look,
  IlvWindowsXPLook, IlvVXLook
}
 Predefined positioning and direction values. More...
 
enum  IlvPosition {
  IlvBadPosition, IlvLeft, IlvRight, IlvTop,
  IlvBottom, IlvTopLeft, IlvBottomLeft, IlvTopRight,
  IlvBottomRight, IlvCenter, IlvHorizontalCenter, IlvVerticalCenter,
  IlvHorizontal, IlvVertical
}
 Predefined positioning and direction values. More...
 

Functions

void IlvFatalError (const char *format,...)
 Outputs an error message. More...
 
const char * IlvGetDefaultHome ()
 Retrieves the default Rogue Wave Views Home directory. More...
 
const char * IlvGetMessage (IlvDisplay *display, const char *label)
 Alias for IlvDisplay::getMessage() More...
 
IlvPosition IlvPositionFromString (const char *position)
 Converts a string value to an IlvPosition. More...
 
void IlvPrint (const char *format,...)
 Outputs a message. More...
 
void IlvSetDefaultHome (const char *defaultHome)
 Sets the default Rogue Wave Views Home directory. More...
 
IlvLocaleExtension * IlvSetLocale (const char *locale=0)
 Sets the language of the application according to the locale environment. More...
 
const char * IlvToString (IlvPosition position)
 Converts an IlvPosition to a string value. More...
 
void IlvWarning (const char *format,...)
 Outputs a warning message. More...
 

Detailed Description

Library: display

Macro Definition Documentation

#define IlvDefaultMarkerSize

The default size of an IlvMarker.

#define IlvMarkerCircle

A cross sign.

See Also
IlvMarkerType.
#define IlvMarkerCross

A plus sign.

See Also
IlvMarkerType.
#define IlvMarkerDiamond

A stroked diamond.

See Also
IlvMarkerType.
#define IlvMarkerFilledCircle

A filled circle.

See Also
IlvMarkerType.
#define IlvMarkerFilledDiamond

A filled diamond.

See Also
IlvMarkerType.
#define IlvMarkerFilledSquare

A filled square.

See Also
IlvMarkerType.
#define IlvMarkerFilledTriangle

A filled triangle.

See Also
IlvMarkerType.
#define IlvMarkerPlus

A plus sign.

See Also
IlvMarkerType.
#define IlvMarkerSquare

A stroked square.

See Also
IlvMarkerType.
#define IlvMarkerTriangle

A stroked triangle.

See Also
IlvMarkerType.

Typedef Documentation

A synonym for IlvPosition.

A synonym for IlvPosition.

IlvDisplayCallback

This type defines the prototype of the functions used as callbacks when the look or the language are dynamically changed.

Parameters
userArgThe user argument that was provided when the callback was set.
See Also
IlvDisplay::addChangeLookCallback(), IlvDisplay::addChangeLanguageCallback().
IlvDisplayConfigCallback

This type defines the prototype of the function that can be used as a display configuration callback, which is used in the IlvDisplay constructors.

Parameters
configThe display configuration created by the constructor of IlvDisplay.

A synonym for IlvPosition.

A system-dependent type that holds a window.

  • On Windows, you can safely cast an IlvSystemView to a HWND to get the real Windows handle of that view.
  • On Unix, you can safely cast an IlvSystemView to a Window to get the real X11 Window identifier.

The type of the internal values of all IlvTransformers.

The IlvTransformer API is based on the IlvTransfoParam type, which stores floating point data. The manner in which data is stored depends on the machine.

Enumeration Type Documentation

Predefined positioning and direction values.

This enum type defines the look and feel used by graphic objects in an IlvDisplay instance. By default, only one style is available in a Rogue Wave Views program, and that is the standard style of the current computer system.
To use more than one style in your program, use the corresponding compiler flag, or add the corresponding style header file directive to your implementation file (before any other #include directive). The header files are ilviews/motif.h, ilviews/windows.h, ilviews/win95.h, ilviews/winxp.h and ilviews/vx.h.

See Also
IlvDisplay::setCurrentLook, IlvDisplay::setLookFeelHandler(), IlvDisplay::getLookFeelHandler(), IlvDisplay::getCurrentLook().
Enumerator
IlvOtherLook 

This value is used to describe a user defined look and feel.

IlvMotifLook 

The Motif look and feel.

IlvWindowsLook 

The Windows 3.1 look and feel.

IlvWindows95Look 

The Windows 95 look and feel. This also covers Windows 98, Windows NT 4.0, and Windows 2000.

IlvWindowsXPLook 

The Windows XP look and feel. This look is available only on machines running Windows XP.

IlvVXLook 

The ViewsX look and feel.

Predefined positioning and direction values.

A set of useful terms that are associated with the IlvPosition enumeration type is defined. IlvDirection is a synonym for this same enum type, as these values can be used in a positioning context as well as in a direction context.

See Also
IlvDirection.
Enumerator
IlvBadPosition 

An invalid position or direction.

IlvLeft 

The left position or direction.

IlvRight 

The right position or direction.

IlvTop 

The top position or the upwards direction.

IlvBottom 

The bottom position or the downwards direction.

IlvTopLeft 

The top-left position or direction.

IlvBottomLeft 

The bottom-left position or direction.

IlvTopRight 

The top-right position or direction.

IlvBottomRight 

The bottom-right position or direction.

IlvCenter 

The center position or direction.

IlvHorizontalCenter 

The horizontal direction, used in alignment.

IlvVerticalCenter 

The vertical direction, used in alignment.

IlvHorizontal 

The horizontal direction, used in alignment.

IlvVertical 

The vertical direction, used in alignment.

Function Documentation

void IlvFatalError ( const char *  format,
  ... 
)

Outputs an error message.

This function calls the fatal member function of the error handler that is installed, if there is one.
The default behavior outputs the message on the standard output stream (or the output TTY on Windows).

Parameters
formatA formatting string that is interpreted as the regular C function printf. This function expects its parameters in the same way as printf does (function with a variable number of arguments).
See Also
IlvError, IlvWarning, IlvPrint, IlvGetErrorHandler, IlvSetErrorHandler.
const char* IlvGetDefaultHome ( )

Retrieves the default Rogue Wave Views Home directory.

This function allows you to check the setting of ILVHOME, which is used as the base directory of many default resource files.

Returns
The current setting of the default ILVHOME value. For Rogue Wave Views <X.Y>, the default value is "C:\Program Files\Rogue Wave\Views X.Y" on Windows systems, and "/usr/local/roguewave/viewsXY" on Unix systems.
See Also
IlvSetDefaultHome().
const char* IlvGetMessage ( IlvDisplay display,
const char *  label 
)

Alias for IlvDisplay::getMessage()

Parameters
displayThe display.
labelThe message identifier.
See Also
IlvDisplay::getMessage().
IlvPosition IlvPositionFromString ( const char *  position)

Converts a string value to an IlvPosition.

Parameters
positionThe string you want to convert.
Returns
The IlvPosition enum value whose symbol equals position, even if position does not have the 'Ilv' prefix.
If position is 0 or matches none of the IlvPosition values, this function returns IlvBadPosition.
void IlvPrint ( const char *  format,
  ... 
)

Outputs a message.

This function outputs the message on the standard output stream (or the output TTY on Windows).

Parameters
formatA formatting string that is interpreted as the regular C function printf. This function expects its parameters in the same way as printf does (function with a variable number of arguments).
See Also
IlvFatalError, IlvWarning.
void IlvSetDefaultHome ( const char *  defaultHome)

Sets the default Rogue Wave Views Home directory.

This global function sets the setting of the default ILVHOME value to a copy of the string defaultHome.
You may want to force this setting if you want to provide a reasonable default value for a specific application without requesting the user to set the environment variable ILVHOME or the display resource Home.

Parameters
defaultHomeThe new default Home setting.
See Also
IlvGetDefaultHome.
IlvLocaleExtension* IlvSetLocale ( const char *  locale = 0)

Sets the language of the application according to the locale environment.

IlvSetLocale() must be called before creating an instance of IlvDisplay. The implementation of this function is platform dependent but is usually carried out by calling setlocale(LC_ALL, "");

Please check the User's Manual for a list of supported locales.

Parameters
localeA platform dependent string specifying the locale. If 0, the default user locale is used.
Returns
A pointer to an internal class. If success, the returned value is not 0.
const char* IlvToString ( IlvPosition  position)

Converts an IlvPosition to a string value.

Parameters
positionThe value you want to convert.
Returns
A string representation of position. It returns a string that is the same as the enum value, with the prefix 'Ilv' removed.
"UnknownPosition" is return if position is unknown enum value.
Note that IlvHorizontalCenter is converted to "Horizontal" and IlvVerticalCenter is converted to "Vertical".
The return string must not be deleted.
void IlvWarning ( const char *  format,
  ... 
)

Outputs a warning message.

This function calls the warning member function of the error handler that is installed, if there is one.
The default behavior outputs the message on the standard output stream (or the output TTY on Windows).

Parameters
formatA formatting string that is interpreted as the regular C function printf. This function expects its parameters in the same way as printf does (function with a variable number of arguments).
See Also
IlvError, IlvFatalError, IlvPrint, IlvGetErrorHandler, IlvSetErrorHandler.

© Copyright 2015, 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.