rwlogo

Rogue Wave Views
Data Access Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

 All Classes Files Functions Variables Typedefs Enumerations Enumerator
List of all members | Public Member Functions | Static Public Member Functions
IliErrorReporter Class Reference

Error Class. More...

#include <ilviews/dataccess/errorrep.h>

Public Member Functions

 IliErrorReporter ()
 The constructor initializes an error reporter.
 
virtual void reportErrors (IlvDisplay *dpy, IlvAbstractView *anchor, const IliErrorList &list) const
 Displays the errors recorded in errorList, in a dialog box. More...
 

Static Public Member Functions

static const IliErrorReporterGetDefault ()
 Returns the default error reporter. More...
 
static void GetMessage (IlvDisplay *display, const IliErrorMessage &msg, IliString &trans)
 Returns a string which contains the translated error message. More...
 
static void SetDefault (const IliErrorReporter *reporter)
 Sets the default error reporter. More...
 

Detailed Description

Error Class.

Library: dataccess

The IliErrorReporter class is used by classes such as IliTableGadget and IliDataSource, to report error messages to the user. It is possible to customize the way errors are reported in the following way:

  1. Define a custom subclass of IliErrorReporter.
  2. In this subclass, override the reportErrors member function.
  3. Install an instance of this custom subclass as the error reporter for the table gadget or the data source.

The error messages are not translated. To get a translated message, you must use the GetMessage function.

See Also
IliDataSource, IliErrorList, IliTableGadget

Member Function Documentation

static const IliErrorReporter* IliErrorReporter::GetDefault ( )
static

Returns the default error reporter.

Returns
The default error reporter.
static void IliErrorReporter::GetMessage ( IlvDisplay display,
const IliErrorMessage msg,
IliString trans 
)
static

Returns a string which contains the translated error message.

Parameters
displayThe display.
msgThe error message.
transContains the translated error message.
virtual void IliErrorReporter::reportErrors ( IlvDisplay dpy,
IlvAbstractView anchor,
const IliErrorList list 
) const
virtual

Displays the errors recorded in errorList, in a dialog box.

The error message are not translated. To get the translated message, you must use the getMessage of the IlvDisplay class.

Parameters
dpyThe display.
anchorThe view.
listThe error list.
static void IliErrorReporter::SetDefault ( const IliErrorReporter reporter)
static

Sets the default error reporter.

Parameters
reporterThe error reporter.

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