Rogue Wave Views Foundation Package API Reference Guide |
Rogue Wave Views Documentation Home |
Resource class. More...
#include <ilviews/base/resource.h>
Public Member Functions | |
IlvPalette (IlvDisplay *display) | |
Constructor. More... | |
IlvPalette (IlvDisplay *display, IlvColor *background, IlvColor *foreground, IlvFont *font, IlvPattern *pattern) | |
Constructor. More... | |
IlvPalette (IlvPalette const *palette) | |
Constructor. More... | |
IlvPalette (IlvPalette const &palette) | |
Copy Constructor. More... | |
IlvIntensity | getAlpha () const |
Gets the alpha value. More... | |
IlvAntialiasingMode | getAntialiasingMode () const |
Gets the anti-aliasing mode. More... | |
IlvArcMode | getArcMode () const |
Gets the arc mode. More... | |
IlvColor * | getBackground () const |
Gets the background color. More... | |
IlvColorPattern * | getColorPattern () const |
Gets the color pattern. More... | |
IlvFillRule | getFillRule () const |
Gets the fill rule. More... | |
IlvFillStyle | getFillStyle () const |
Gets the fill style. More... | |
IlvFont * | getFont () const |
Gets the font. More... | |
IlvColor * | getForeground () const |
Gets the foreground color. More... | |
IlvGradientPattern * | getGradientPattern () const |
Gets the gradient pattern. More... | |
IlvLineStyle * | getLineStyle () const |
Gets the line style. More... | |
IlUShort | getLineWidth () const |
Gets the line width. More... | |
IlvDrawMode | getMode () const |
Gets the drawing mode. More... | |
IlBoolean | getOverwrite () const |
Gets the overwrite flag. More... | |
IlvPattern * | getPattern () const |
Gets the pattern. More... | |
void | invert () |
Swaps the foreground and background of the palette. More... | |
void | setAlpha (IlvIntensity alpha) |
Sets the alpha value. More... | |
void | setAntialiasingMode (IlvAntialiasingMode antialias) |
Sets the anti-aliasing mode. More... | |
void | setArcMode (IlvArcMode arcMode) |
Sets the arc mode. More... | |
void | setBackground (IlvColor *color) |
Sets the background color. More... | |
void | setClip (const IlvRect *rect=0) const |
Set or reset clipping rectangle. More... | |
void | setClip (const IlvRegion *clip) const |
Set clipping region. More... | |
void | setColorPattern (IlvColorPattern *pattern) |
Sets the color pattern. More... | |
void | setFillRule (IlvFillRule fillRule) |
Sets the fill rule. More... | |
void | setFillStyle (IlvFillStyle fillStyle) |
Sets the fill style. More... | |
void | setFont (IlvFont *font) |
Sets the font. More... | |
void | setForeground (IlvColor *color) |
Sets the foreground color. More... | |
void | setGradientPattern (IlvGradientPattern *pattern) |
Sets the gradient pattern. More... | |
void | setLineStyle (IlvLineStyle *style, IlUShort width) |
Sets the line style and width. More... | |
void | setLineStyle (IlvLineStyle *style) |
Sets the line style. More... | |
void | setLineWidth (IlUShort width) |
Sets the line width. More... | |
void | setMode (IlvDrawMode drawMode) const |
Sets the drawing mode. More... | |
void | setOverwrite (IlBoolean over) const |
Sets the overwrite flag. More... | |
void | setPattern (IlvPattern *pattern) |
Sets the pattern. More... | |
virtual void | unLock () |
Unlocks the resource. More... | |
Public Member Functions inherited from IlvResource | |
IlvDisplay * | getDisplay () const |
Gets the IlvDisplay instance. More... | |
const char * | getName () const |
Gets the resource name. More... | |
void | lock () |
Locks the resource. More... | |
virtual void | setName (const char *name) |
Sets the name of the resource. More... | |
Friends | |
class | IlvDisplay |
Resource class.
Library: xviews or winviews or mviews (mutually exclusive)
IlvPalette
groups together the graphic resources used in drawing primitives:
IlvColor
is used as a second color when filling a shape with patterns. It is also used for filling the background of character strings when they are drawn with the member function IlvPort::drawIString()
.IlvDisplay::defaultBackground()
. IlvColor
is used for drawing outline shapes (dot, line, rectangle, polyline, arc, curve, ...) and character strings. For example, IlvPort::drawRectangle()
, IlvPort::drawString()
.IlvPort::fillRectangle()
.IlvDisplay::defaultForeground()
. IlvPattern
. We are referring to the pattern used to fill surfaces when the fill mode is IlvFillPattern
or IlvFillMaskPattern
. This IlvPattern
can be created by the user or returned by specific member functions of the IlvDisplay
class, which offers sixteen ready-to-use patterns.IlvDisplay::defaultPattern()
member function. IlvColorPattern
. We use the expression "color pattern" for the colored pattern used to fill shapes when the fill mode is IlvFillColorPattern
. The default value for the color pattern is IlvNil
, indicating that no color pattern is to be used. IlvFont
. It is used when drawing text. Fonts are obtained by means of IlvDisplay
member functions that return a valid font object depending on user-required characteristics. IlvLineStyle
. The line style and width define the exact visible aspect of all lines, polylines, and spline drawings.IlvLineStyle
resource objects from your IlvDisplay
object, and specifying the way that dashes are to be drawn. IlvFillStyle
enumeration type: IlvFillPattern:
A shape is filled by being copied with the chosen pattern. Graphic objects have a pattern property referring to an object of the IlvPattern
class. To fill a shape with a given pattern, each 0
pixel in the relevant IlvPattern
object produces a colored pixel with the current background color, and each 1
pixel in the IlvPattern
object produces a colored pixel with the current foreground color. This is the default value of the fill-style property of an IlvPalette
object. IlvFillMaskPattern:
This is similar to the IlvFillPattern
style except that 0
pixels in the relevant IlvPattern
object have no effect on the corresponding pixels in the destination port. That is, the drawing can be thought of as masking its destination. IlvFillColorPattern:
In this case, the pattern used to fill a shape is indicated, not by the pattern property of this IlvPalette
object, but rather by its colored pattern property. It is used when you wish to fill a region with a full-color pattern, that is, an actual object of the IlvColorPattern
class. The pattern property plays no role in the case of this filling mode. Arc mode: The arc mode indicates the way in which filled arcs are to be drawn. It is represented by the IlvArcMode
enumeration type and has two possible values:
IlvArcPie:
The arc is closed by adding two lines, from the center of the complete circle to the start and end points of the arc. This is the default mode. IlvArcChord:
The arc is closed by adding a line from the start point to the end point.
- Arc Modes -
Fill rule: The fill rule indicates which points are to be considered as inside a polygon that is to be filled, depending on the count of crossing segments that define the shape of the area to be filled. It is represented by the IlvFillRule
enumeration type and has two possible values:
IlvEvenOddRule:
According to this rule, in the case of the complex polygon shown below, the central area of the star is not considered to lie inside the polygon, and therefore is not filled. This is the default value. IlvWindingRule:
According to this rule, the central area of the star is considered to lie inside the polygon, and therefore is filled.
- IlvFillRule -
IlvModeXor
value may be used for temporary drawing.IlvDrawMode
enumeration type: IlvModeSet:
The resulting pixel is a copy of the source pixel. IlvModeOr:
The resulting pixel is the result of an OR operation upon the source and destination pixels. IlvModeAnd:
The resulting pixel is the result of an AND operation upon the source and destination pixels. IlvModeXor:
The resulting pixel is the result of an XOR (exclusive or) operation upon the source and destination pixels. This mode is interesting in that it can be used a second time to delete a drawing. IlvModeNot:
The resulting pixel is the result of the NOT operation upon the destination pixel. The source pixel value is not used. IlvModeInvert:
The resulting pixel is the result of a NOT operation upon the source pixel. IlvModeNotOr:
The resulting pixel is the result of a NOT OR operation upon the source and destination pixels. IlvModeNotAnd:
The resulting pixel is the result of a NOT AND operation upon the source and destination pixels. IlvModeNotXor:
The resulting pixel is the result of a NOT XOR operation upon the source and destination pixels. When you draw the same thing twice with IlvModeNotXor
set, the drawing disappears. There are two ways of creating a palette:
IlvDisplay::getPalette()
provides you with a palette matching your description. If the IlvDisplay
finds a match in the in the list of existing palettes, it is returned, otherwise a new one is created.lock()
and unLock()
.new
operator and the IlvPalette
constructor. Use a non-shared palette when you need to modify it frequently or when you do not want to share it. A non-shared palette still uses shared resources such as IlvFont
, IlvColor
, and so on, which are locked and unlocked in the same way as shared palettes.IlvPalette
object in this way, you have the responsibility of deleting it explicitly when it is no longer needed because the lock
and unLock
mechanisms are not supported by non-shared palettes (unLock()
never deletes a non-shared palette). IlvDisplay::getPalette()
, IlvColor
, IlvLineStyle
, IlvPattern
. IlvPalette::IlvPalette | ( | IlvDisplay * | display | ) |
Constructor.
Creates a non-shared palette. The new palette is initialized with all the default values offered by the display.
display | The display instance. |
IlvPalette::IlvPalette | ( | IlvDisplay * | display, |
IlvColor * | background, | ||
IlvColor * | foreground, | ||
IlvFont * | font, | ||
IlvPattern * | pattern | ||
) |
Constructor.
Creates a non-shared palette with the specified parameters.
display | The display instance. |
background | The background color of this palette. |
foreground | The foreground color of this palette. |
font | The font of this palette. |
pattern | The fill pattern color of this palette. |
IlvPalette::IlvPalette | ( | IlvPalette const * | palette | ) |
Constructor.
Creates a non-shared palette that is a copy of the palette palette.
palette | An existing palette. |
IlvPalette::IlvPalette | ( | IlvPalette const & | palette | ) |
Copy Constructor.
Creates a non-shared palette that is a copy of the palette palette.
palette | An existing palette. |
IlvIntensity IlvPalette::getAlpha | ( | ) | const |
Gets the alpha value.
The alpha value is the amount of opacity that will be used when drawing with this palette. A value of IlvFullIntensity
means that the drawing will be opaque. A value of 0
means that the drawing will be completely transparent. When drawing into an IlvPort
object, the alpha value of the palette will be composed with the alpha value of the port.
IlvAntialiasingMode IlvPalette::getAntialiasingMode | ( | ) | const |
Gets the anti-aliasing mode.
IlvArcMode IlvPalette::getArcMode | ( | ) | const |
Gets the arc mode.
IlvColor* IlvPalette::getBackground | ( | ) | const |
Gets the background color.
Retrieves the background color IlvResource
of the palette. This resource should never be deleted. If you want to use it in a context different from this palette, you should consider using lock
and unLock
on the resource.
IlvColorPattern* IlvPalette::getColorPattern | ( | ) | const |
Gets the color pattern.
Retrieves the color pattern IlvResource
of the palette. This resource should never be deleted; if you want to use it in a context different from this palette, you should consider using lock
and unLock
on the resource.
IlvFillRule IlvPalette::getFillRule | ( | ) | const |
Gets the fill rule.
IlvFillStyle IlvPalette::getFillStyle | ( | ) | const |
Gets the fill style.
IlvFont* IlvPalette::getFont | ( | ) | const |
Gets the font.
Retrieves the font IlvResource
of the palette. This resource should never be deleted; if you want to use it in a context different from this palette, you should consider using lock
and unLock
on the resource.
IlvColor* IlvPalette::getForeground | ( | ) | const |
Gets the foreground color.
Retrieves the foreground color IlvResource
of the palette. This resource should never be deleted; if you want to use it in a context different from this palette, you should consider using lock
and unLock
on the resource.
IlvGradientPattern* IlvPalette::getGradientPattern | ( | ) | const |
Gets the gradient pattern.
Retrieves the gradient pattern IlvResource
of the palette. This resource should never be deleted; if you want to use it in a context different from this palette, you should consider using lock
and unLock
on the resource.
IlvLineStyle* IlvPalette::getLineStyle | ( | ) | const |
Gets the line style.
Retrieves the line style IlvResource
of the palette. This resource should never be deleted; if you want to use it in a context different from this palette, you should consider using lock
and unLock
on the resource.
IlUShort IlvPalette::getLineWidth | ( | ) | const |
Gets the line width.
IlvDrawMode IlvPalette::getMode | ( | ) | const |
Gets the drawing mode.
IlBoolean IlvPalette::getOverwrite | ( | ) | const |
Gets the overwrite flag.
IlvPattern* IlvPalette::getPattern | ( | ) | const |
Gets the pattern.
Retrieves the pattern IlvResource
of the palette. This resource should never be deleted; if you want to use it in a context different from this palette, you should consider using lock
and unLock
on the resource.
void IlvPalette::invert | ( | ) |
Swaps the foreground and background of the palette.
Swaps the foreground and the background color of this IlvPalette
object.
void IlvPalette::setAlpha | ( | IlvIntensity | alpha | ) |
Sets the alpha value.
alpha | The new alpha value of the palette. |
void IlvPalette::setAntialiasingMode | ( | IlvAntialiasingMode | antialias | ) |
Sets the anti-aliasing mode.
antialias | The new anti-aliasing mode of the palette. |
void IlvPalette::setArcMode | ( | IlvArcMode | arcMode | ) |
Sets the arc mode.
Sets arcMode as the arc mode attribute of the palette.
arcMode | The arc mode to set. |
void IlvPalette::setBackground | ( | IlvColor * | color | ) |
Sets the background color.
Sets the background color IlvResource
of the palette. The palette calls lock
on the resource provided as argument. Then the palette calls unLock
on the old resource to release a reference to it.
color | The new background color. |
void IlvPalette::setClip | ( | const IlvRect * | rect = 0 | ) | const |
Set or reset clipping rectangle.
This member function forces all drawing operations that are done with this IlvPalette
to be clipped in the clip
rectangle. If no value is given, then 0
is assumed and no clipping takes place anymore. You should always reset the clipping region to none (that is, call the member function setClip
with no parameter) after it has been used, because clipping is not considered as a persistent attribute of the palette (two palettes using exactly the same resources but different clipping regions are considered identical).
rect | The rectangle on which clipping is to occur, or 0 to reset clipping. |
void IlvPalette::setClip | ( | const IlvRegion * | clip | ) | const |
Set clipping region.
This member function forces all drawing operations that are done with this IlvPalette
to be clipped in the clip
region. It has the same effect as the first setClip
method, except that the clipping now takes place on a real region.
clip | The region on which clipping is to occur. |
void IlvPalette::setColorPattern | ( | IlvColorPattern * | pattern | ) |
Sets the color pattern.
Sets the color pattern IlvResource
of the palette. The palette calls lock
on the resource provided as argument; then the palette calls unLock
on the old resource to release a reference to it.
pattern | The new color pattern. |
void IlvPalette::setFillRule | ( | IlvFillRule | fillRule | ) |
Sets the fill rule.
Sets fillRule as the fill rule attribute of the palette.
fillRule | The fill rule to set. |
void IlvPalette::setFillStyle | ( | IlvFillStyle | fillStyle | ) |
Sets the fill style.
Sets fillStyle as the fill style attribute of the palette.
fillStyle | The fill style to set. |
void IlvPalette::setFont | ( | IlvFont * | font | ) |
Sets the font.
Sets the font IlvResource
of the palette. The palette calls lock
on the resource provided as argument; then the palette calls unLock
on the old resource to release a reference to it.
font | The new font. |
void IlvPalette::setForeground | ( | IlvColor * | color | ) |
Sets the foreground color.
Sets the foreground color IlvResource
of the palette. The palette calls lock
on the resource provided as argument; then the palette calls unLock
on the old resource to release a reference to it.
color | The new foreground color. |
void IlvPalette::setGradientPattern | ( | IlvGradientPattern * | pattern | ) |
Sets the gradient pattern.
Sets the gradient pattern IlvResource
of the palette. The palette calls lock
on the resource provided as argument; then the palette calls unLock
on the old resource to release a reference to it.
pattern | The new color pattern. |
void IlvPalette::setLineStyle | ( | IlvLineStyle * | style, |
IlUShort | width | ||
) |
Sets the line style and width.
Sets style as the line style resource of the palette and width
as the line width attribute. The palette calls lock
on style
, then the palette calls unLock
on the old line style resource to release a reference to it.
style | The line style to set. |
width | The line width to set. |
void IlvPalette::setLineStyle | ( | IlvLineStyle * | style | ) |
Sets the line style.
Sets style as the line style resource of the palette. The palette calls lock
on style
, then the palette calls unLock
on the old line style resource to release a reference to it.
style | The line style to set. |
void IlvPalette::setLineWidth | ( | IlUShort | width | ) |
Sets the line width.
Sets width as the line width attribute of the palette.
width | The line width to set. |
void IlvPalette::setMode | ( | IlvDrawMode | drawMode | ) | const |
Sets the drawing mode.
Sets the drawing mode of this palette to the IlvDrawMode
drawMode
.
drawMode | The drawing mode to set. |
void IlvPalette::setOverwrite | ( | IlBoolean | over | ) | const |
Sets the overwrite flag.
Modifies the way the drawing member functions of the IlvDisplay
class operate, when drawing on the root port. If the over parameter is set to IlFalse
, the drawing operations are hidden by the windows stored on the top window. If the parameter is set to IlTrue
, the drawing operations are performed on top of every window present on the screen, just as if the windows were part of the root window.
over | A Boolean value to set the overwrite flag. |
void IlvPalette::setPattern | ( | IlvPattern * | pattern | ) |
Sets the pattern.
Sets the pattern IlvResource
of the palette. The palette calls lock
on the resource provided as argument; then the palette calls unLock
on the old resource to release a reference to it.
pattern | The new pattern. |
|
virtual |
Unlocks the resource.
This function decrements the reference count of the resource, and deletes it if this count becomes 0
. Resource management is closely concerned with the way resources are locked and unlocked. Whenever you need a specific resource in one of your persistent objects, you should use this mechanism to make sure that it will stay safe within your IlvDisplay
instance. If your application needs more than one instance of IlvDisplay
, you have to create resources within each environment, since resources cannot be shared between the different IlvDisplay
contexts.
Reimplemented from IlvResource.
© 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.