rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions | Friends
IlvWindowsDisplayConfig Class Reference

Display configuration class for Windows applications. More...

#include <ilviews/windows/config.h>

Inheritance diagram for IlvWindowsDisplayConfig:
IlvDisplayConfig

Public Member Functions

HINSTANCE getHInstance () const
 Gets the HINSTANCE associated with the IlvDisplay. More...
 
HPALETTE getHPalette () const
 Gets the HPALETTE currently used by the drawing functions of Rogue Wave Views. More...
 
void setHPalette (HPALETTE hPalette, IlBoolean owner=IlFalse)
 
- Public Member Functions inherited from IlvDisplayConfig
IlvDisplaygetDisplay () const
 Gets the display instance. More...
 
IlAny getUserArg () const
 Gets the user argument. More...
 
void setDefaultBackground (const char *bgName, IlBoolean isMutable=IlFalse)
 Sets the default background color. More...
 
void setDefaultBackground (IlvIntensity r, IlvIntensity g, IlvIntensity b, IlBoolean isMutable)
 Sets the default background color. More...
 
void setDefaultForeground (const char *bgName, IlBoolean isMutable=IlFalse)
 Sets the default foreground color. More...
 
void setDefaultForeground (IlvIntensity r, IlvIntensity g, IlvIntensity b, IlBoolean isMutable)
 Sets the default foreground color. More...
 

Friends

class IlvDisplay
 

Detailed Description

Display configuration class for Windows applications.

Library: winviews

This class is a predefined subtype of IlvDisplayConfig that is dedicated for Rogue Wave Views applications running on Windows. The display configuration callback of these applications will actually receive an instance of this class (see IlvDisplay constructors for details).

Member Function Documentation

HINSTANCE IlvWindowsDisplayConfig::getHInstance ( ) const

Gets the HINSTANCE associated with the IlvDisplay.

Returns
The pointer to the HINSTANCE used to create the IlvDisplay instance.
HPALETTE IlvWindowsDisplayConfig::getHPalette ( ) const

Gets the HPALETTE currently used by the drawing functions of Rogue Wave Views.

Returns
The HPALETTE used by the drawing functions.
void IlvWindowsDisplayConfig::setHPalette ( HPALETTE  hPalette,
IlBoolean  owner = IlFalse 
)

short Sets the HPALETTE used by the drawing functions.

Parameters
hPaletteAn HPALETTE that will be used by the drawing functions.
ownerAn IlBoolean, whose default value is IlFalse, that specifies whether Rogue Wave Views may release this palette (if the value is IlTrue) or not.

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