Views
Foundation Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvPushClip Class Reference

This class is used to temporarily modify the clip of an IlvPalette. More...

#include <ilviews/base/resource.h>

Public Member Functions

 IlvPushClip (IlvPalette const &palette, IlvRect const &newClip, IlvRegion const *globalClip)
 This constructor sets the clip to the intersection of the current clip, and the region and the rectangle given as parameter. More...
 
 IlvPushClip (IlvPalette const &palette, IlvRect const *newClip)
 Constructor from an IlvRect. More...
 
 IlvPushClip (IlvPalette const &palette, IlvRegion const *newClip)
 Constructor from an IlvRegion. More...
 
 ~IlvPushClip ()
 The destructor. It restores the previous clip on the palette.
 

Detailed Description

This class is used to temporarily modify the clip of an IlvPalette.

Library: xviews or winviews or mviews (mutually exclusive)

If the pointer to the new clip is not 0, the constructor modifies the clip of the palette with the intersection of the current clip and the new one, while the destructor restores the previous value. Otherwise the clip remains unchanged.

Constructor & Destructor Documentation

◆ IlvPushClip() [1/3]

IlvPushClip::IlvPushClip ( IlvPalette const &  palette,
IlvRect const *  newClip 
)

Constructor from an IlvRect.

Parameters
paletteThe palette whose clip will be modified.
newClipA pointer to the new clip to intersect with the current clip. If this pointer is 0, nothing is done.

◆ IlvPushClip() [2/3]

IlvPushClip::IlvPushClip ( IlvPalette const &  palette,
IlvRegion const *  newClip 
)

Constructor from an IlvRegion.

Parameters
paletteThe palette whose clip will be modified.
newClipA pointer to the new clip to intersect with the current clip. If this pointer is 0, nothing is done.

◆ IlvPushClip() [3/3]

IlvPushClip::IlvPushClip ( IlvPalette const &  palette,
IlvRect const &  newClip,
IlvRegion const *  globalClip 
)

This constructor sets the clip to the intersection of the current clip, and the region and the rectangle given as parameter.

Parameters
paletteThe palette whose clip will be modified.
newClipA rectangle to intersect with the region globalClip and the current clip of the palette.
globalClipA pointer to a region to intersect with the current clip and rect.