Rogue Wave Views Foundation Package API Reference Guide |
Rogue Wave Views Documentation Home |
#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 |
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... | |
Library: xviews or winviews or mviews (mutually exclusive)
#define IlvDefaultMarkerSize |
The default size of an IlvMarker
.
#define IlvMarkerCircle |
A cross sign.
IlvMarkerType
. #define IlvMarkerCross |
A plus sign.
IlvMarkerType
. #define IlvMarkerDiamond |
A stroked diamond.
IlvMarkerType
. #define IlvMarkerFilledCircle |
A filled circle.
IlvMarkerType
. #define IlvMarkerFilledDiamond |
A filled diamond.
IlvMarkerType
. #define IlvMarkerFilledSquare |
A filled square.
IlvMarkerType
. #define IlvMarkerFilledTriangle |
A filled triangle.
IlvMarkerType
. #define IlvMarkerPlus |
A plus sign.
IlvMarkerType
. #define IlvMarkerSquare |
A stroked square.
IlvMarkerType
. #define IlvMarkerTriangle |
A stroked triangle.
IlvMarkerType
. 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.
userArg | The user argument that was provided when the callback was set. |
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.
config | The display configuration created by the constructor of IlvDisplay . |
The different aspects that an IlvMarker
can take.
A synonym for IlvPosition
.
A system-dependent type that holds a window.
IlvSystemView
to a HWND
to get the real Windows handle of that view. 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.
enum IlvLookStyle |
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
.
IlvDisplay::setCurrentLook
, IlvDisplay::setLookFeelHandler()
, IlvDisplay::getLookFeelHandler()
, IlvDisplay::getCurrentLook()
. enum IlvPosition |
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.
IlvDirection
. 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).
format | A 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). |
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.
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. IlvSetDefaultHome()
. const char* IlvGetMessage | ( | IlvDisplay * | display, |
const char * | label | ||
) |
Alias for IlvDisplay::getMessage()
display | The display. |
label | The message identifier. |
IlvDisplay::getMessage()
. IlvPosition IlvPositionFromString | ( | const char * | position | ) |
Converts a string value to an IlvPosition
.
position | The string you want to convert. |
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).
format | A 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). |
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
.
defaultHome | The new default Home setting. |
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.
locale | A platform dependent string specifying the locale. If 0 , the default user locale is used. |
0
. const char* IlvToString | ( | IlvPosition | position | ) |
Converts an IlvPosition
to a string value.
position | The value you want to convert. |
'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).
format | A 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). |
IlvError
, IlvFatalError
, IlvPrint
, IlvGetErrorHandler
, IlvSetErrorHandler
. © 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.