Rogue Wave Views 5.6
Rogue Wave Views
Foundation Package API Reference Guide
Rogue Wave Views
Documentation Home
Rogue Wave Views 5.6 |
Rogue Wave Views |
Rogue Wave Views Documentation Home |
Graphic class. More...
#include <ilviews/base/graphic.h>
Public Member Functions | |
| IlvSimpleGraphic (IlvDisplay *display, IlvPalette *palette=0) | |
| Constructor. | |
| virtual | ~IlvSimpleGraphic () |
| Destructor. | |
| virtual void | applyResources (const char *storageName, const char *storageClassName, const char *objectName, const char *objectClassName, IlvDisplay *display=0) |
| Applies resources on a graphic object. | |
| const char * | className () const |
| Returns the class name of an object. | |
| IlvIntensity | getAlpha () const |
| Retrieves the alpha value. | |
| IlvAntialiasingMode | getAntialiasingMode () const |
| Retrieves the anti-aliasing mode. | |
| IlvArcMode | getArcMode () const |
| Retrieves the arc mode. | |
| IlvColor * | getBackground () const |
| Retrieves the background color. | |
| virtual IlvClassInfo * | getClassInfo () const |
| Gets class information. | |
| IlvColorPattern * | getColorPattern () const |
| Retrieves the color pattern. | |
| virtual IlvDisplay * | getDisplay () const |
Retrieves the IlvDisplay instance. | |
| IlvFillRule | getFillRule () const |
| Retrieves the fill rule. | |
| IlvFillStyle | getFillStyle () const |
| Retrieves the fill style. | |
| IlvFont * | getFont () const |
| Retrieves the font. | |
| IlvColor * | getForeground () const |
| Retrieves the foreground color. | |
| IlvGradientPattern * | getGradientPattern () const |
| Retrieves the gradient pattern. | |
| IlvLineStyle * | getLineStyle () const |
| Retrieves the line style. | |
| IlUShort | getLineWidth () const |
| Retrieves the line width. | |
| virtual IlvLookFeelHandler * | getLookFeelHandler () const |
| Returns the look & feel handler used by this object. | |
| virtual int | getLookupStringInputMethod (IlvEvent &event, char *bufferReturn, int bytesBuffer, int *statusReturn) |
| Gets the preedit string from an input method. | |
| IlvDrawMode | getMode () const |
| Retrieves the draw mode. | |
| IlBoolean | getOverwrite () const |
| Retrieves the overwrite mode. | |
| IlvPalette * | getPalette () const |
| Retrieves the internal palette value. | |
| IlvPattern * | getPattern () const |
| Retrieves the pattern. | |
| virtual void | invert (IlBoolean temp=((IlBoolean) 0)) |
| Highlights the object. | |
| IlBoolean | isSubtypeOf (const IlvClassInfo *c) const |
| Checks whether this object's class is a subclass. | |
| IlBoolean | isSubtypeOf (const char *t) const |
| Checks whether this object's class is a subclass of a given parent class. | |
| virtual void | registerInputMethod () const |
| Controls the connection of a graphic object to an input method. | |
| virtual void | setAlpha (IlvIntensity alpha) |
| Sets the alpha value of the object. | |
| virtual void | setAntialiasingMode (IlvAntialiasingMode mode) |
| Sets the anti-aliasing mode of the object. | |
| virtual void | setArcMode (IlvArcMode am) |
| Sets the arc mode of the object. | |
| virtual void | setBackground (IlvColor *c) |
| Sets the background color of the object. | |
| virtual void | setColorPattern (IlvColorPattern *b) |
| Sets the color pattern of the object. | |
| virtual void | setFillRule (IlvFillRule fr) |
| Sets the fill rule of the object. | |
| virtual void | setFillStyle (IlvFillStyle f) |
| Sets the fill style of the object. | |
| virtual void | setFocusValuesInputMethod (IlUShort count, const IlvImValue *values) const |
| Controls the interaction between a simple graphic object and an input method. | |
| virtual void | setFont (IlvFont *f) |
| Sets the font of the object. | |
| virtual void | setForeground (IlvColor *c) |
| Sets the foreground color of the object. | |
| virtual void | setGradientPattern (IlvGradientPattern *g) |
| Sets the gradient pattern of the object. | |
| virtual void | setHolder (IlvGraphicHolder *holder) |
| Sets the object's holder. | |
| virtual void | setLineStyle (IlvLineStyle *style) |
| Sets the line style of the object. | |
| virtual void | setLineWidth (IlUShort width) |
| Sets the line width of the object. | |
| virtual void | setMode (IlvDrawMode m) |
| Sets the drawing mode of the object temporarily. | |
| virtual void | setOverwrite (IlBoolean o) |
| Sets an overwrite mode that modifies how the drawing member functions operate. | |
| virtual void | setPalette (IlvPalette *palette) |
Sets the internal palette to the given palette value. | |
| virtual void | setPattern (IlvPattern *p) |
| Sets the pattern of the object. | |
| virtual void | setValuesInputMethod (IlUShort count, const IlvImValue *values) const |
| Controls the interaction between a graphic object and an input method. | |
| virtual void | unRegisterInputMethod () const |
| Controls the disconnection of a graphic object from an input method. | |
| virtual void | unsetFocusInputMethod () const |
| Controls the interaction between a graphic object and an input method. | |
Static Public Member Functions | |
| static void | AddProperty (const IlSymbol *k, IlAny v) |
| Adds a property to this object's class. | |
| static IlAny | GetProperty (const IlSymbol *key, IlBoolean p=((IlBoolean) 0)) |
| Retrieves the property value associated with the key in this object's class. | |
| static const IlvClassInfo * | HasProperty (const IlSymbol *key, IlBoolean p=((IlBoolean) 0)) |
| Checks for the existence of a property for this object's class hierarchy. | |
| static IlBoolean | RemoveProperty (const IlSymbol *key) |
| Removes a property from this object's class. | |
| static IlBoolean | ReplaceProperty (const IlSymbol *k, IlAny v) |
| Replaces a property in this object's class. | |
Graphic class.
Library: views
This class enables you to access palette attributes. Every IlvSimpleGraphic has an IlvPalette object, but these palettes are shared between objects. When you ask an IlvSimpleGraphic object to change a graphic property such as its foreground, the following operations are performed:
getPalette function is used to search for a new IlvPalette using the graphic properties of the object. lock function is called for the new palette to increment its reference count (see IlvResource::lock). The member function unLock is called for the old palette (see IlvResource::unLock).
These operations guarantee the sharing of the IlvPalette. Users are encouraged to use the same mechanism in the case of IlvPalette objects. This is why member functions that can manipulate resources by changing the graphic attributes, such as IlvPalette::setForeground, are defined as virtual functions.
IlvDisplay, IlvPalette. | IlvSimpleGraphic::IlvSimpleGraphic | ( | IlvDisplay * | display, | |
| IlvPalette * | palette = 0 | |||
| ) |
Constructor.
The IlvSimpleGraphic constructor needs the IlvPalette object to which it is attached to obtain resources. The palette parameter can be set to a specific value or left unspecified where it takes the value 0. When the palette is set to 0, the default palette of the display object is used. This palette is the one returned by the member function IlvDisplay::defaultPalette of the IlvDisplay class. The palette parameter is locked when the object is created.
| display | The display where this object is created. | |
| palette | The palette of the display object. |
| virtual IlvSimpleGraphic::~IlvSimpleGraphic | ( | ) | [virtual] |
Destructor.
The destructor unlocks the palette.
Adds a property to this object's class.
This static function associates the given value with the given key for the class of this object only.
| key | The key to be associated. | |
| value | The value to be associated. |
Reimplemented from IlvGraphic.
Reimplemented in IlvContainerRectangle, IlvArc, IlvFilledArc, IlvCalendarScale, IlvCircularGauge, IlvFilledCircularGauge, IlvCircularScale, IlvEllipse, IlvFilledEllipse, IlvGauge, IlvRectangularGauge, IlvSliderGauge, IlvReliefGauge, IlvGridRectangle, IlvIcon, IlvTransparentIcon, IlvLabel, IlvFilledLabel, IlvListLabel, IlvLine, IlvArrowLine, IlvMarker, IlvZoomableMarker, IlvOutlinePolygon, IlvGraphicPath, IlvPolyline, IlvPolygon, IlvArrowPolyline, IlvPolyPoints, IlvPolyPointsSelection, IlvSplineSelection, IlvPolySelection, IlvRectangle, IlvFilledRectangle, IlvViewRectangle, IlvReliefLabel, IlvReliefLine, IlvReliefRectangle, IlvReliefDiamond, IlvRoundRectangle, IlvFilledRoundRectangle, IlvScale, IlvRectangularScale, IlvDrawSelection, IlvReshapeSelection, IlvShadowLabel, IlvShadowRectangle, IlvSpline, IlvClosedSpline, IlvFilledSpline, IlvTimeScale, IlvZoomableIcon, IlvZoomableTransparentIcon, and IlvZoomableLabel.
| virtual void IlvSimpleGraphic::applyResources | ( | const char * | storageName, | |
| const char * | storageClassName, | |||
| const char * | objectName, | |||
| const char * | objectClassName, | |||
| IlvDisplay * | display = 0 | |||
| ) | [virtual] |
Applies resources on a graphic object.
Searches for resources that match storageName.objectName.resource, or storageName.objectClassName.resource, or storageClassName.objectName.resource, or storageClassName.objectClassName.resource, in this order, and applies these resources to the object.
The resources taken into account by the class IlvGraphic are only geometric:
x y h or height w or width The class IlvSimpleGraphic also applies the following graphic resources, if and only if the object has the default display palette:
foreground background font pattern colorPattern lineStyle lineWidth fillStyle arcMode fillRule | storageName | The storage name. | |
| storageClassName | The generic name of the storage instance. | |
| objectName | The object name. | |
| objectClassName | The generic name of the object class. | |
| display | The display where this object is created. |
Reimplemented from IlvGraphic.
| const char* IlvSimpleGraphic::className | ( | ) | const |
Returns the class name of an object.
This method is equivalent to getClassInfo()->getClassName().
IlvRectangle object, the className function returns "IlvRectangle". Reimplemented from IlvGraphic.
Reimplemented in IlvContainerRectangle, IlvArc, IlvFilledArc, IlvCalendarScale, IlvCircularGauge, IlvFilledCircularGauge, IlvCircularScale, IlvEllipse, IlvFilledEllipse, IlvGauge, IlvRectangularGauge, IlvSliderGauge, IlvReliefGauge, IlvGridRectangle, IlvIcon, IlvTransparentIcon, IlvLabel, IlvFilledLabel, IlvListLabel, IlvLine, IlvArrowLine, IlvMarker, IlvZoomableMarker, IlvOutlinePolygon, IlvGraphicPath, IlvPolyline, IlvPolygon, IlvArrowPolyline, IlvPolyPoints, IlvPolyPointsSelection, IlvSplineSelection, IlvPolySelection, IlvRectangle, IlvFilledRectangle, IlvViewRectangle, IlvReliefLabel, IlvReliefLine, IlvReliefRectangle, IlvReliefDiamond, IlvRoundRectangle, IlvFilledRoundRectangle, IlvScale, IlvRectangularScale, IlvDrawSelection, IlvReshapeSelection, IlvShadowLabel, IlvShadowRectangle, IlvSpline, IlvClosedSpline, IlvFilledSpline, IlvTimeScale, IlvZoomableIcon, IlvZoomableTransparentIcon, and IlvZoomableLabel.
| IlvIntensity IlvSimpleGraphic::getAlpha | ( | ) | const [virtual] |
Retrieves the alpha value.
IlvPalette::getAlpha value of the palette. Reimplemented from IlvGraphic.
Reimplemented in IlvGadget.
| IlvAntialiasingMode IlvSimpleGraphic::getAntialiasingMode | ( | ) | const [virtual] |
Retrieves the anti-aliasing mode.
IlvPalette::getAntialiasingMode value of the palette. Reimplemented from IlvGraphic.
Reimplemented in IlvGadget.
| IlvArcMode IlvSimpleGraphic::getArcMode | ( | ) | const |
Retrieves the arc mode.
IlvPalette::getArcMode value of the palette. | IlvColor* IlvSimpleGraphic::getBackground | ( | ) | const |
Retrieves the background color.
IlvPalette::getBackground value of the palette. | virtual IlvClassInfo* IlvSimpleGraphic::getClassInfo | ( | ) | const [virtual] |
Gets class information.
Returns a pointer to the IlvClassInfo object associated with this object's class.
Reimplemented from IlvGraphic.
Reimplemented in IlvContainerRectangle, IlvArc, IlvFilledArc, IlvCalendarScale, IlvCircularGauge, IlvFilledCircularGauge, IlvCircularScale, IlvEllipse, IlvFilledEllipse, IlvGauge, IlvRectangularGauge, IlvSliderGauge, IlvReliefGauge, IlvGridRectangle, IlvIcon, IlvTransparentIcon, IlvLabel, IlvFilledLabel, IlvListLabel, IlvLine, IlvArrowLine, IlvMarker, IlvZoomableMarker, IlvOutlinePolygon, IlvGraphicPath, IlvPolyline, IlvPolygon, IlvArrowPolyline, IlvPolyPoints, IlvPolyPointsSelection, IlvSplineSelection, IlvPolySelection, IlvRectangle, IlvFilledRectangle, IlvViewRectangle, IlvReliefLabel, IlvReliefLine, IlvReliefRectangle, IlvReliefDiamond, IlvRoundRectangle, IlvFilledRoundRectangle, IlvScale, IlvRectangularScale, IlvDrawSelection, IlvReshapeSelection, IlvShadowLabel, IlvShadowRectangle, IlvSpline, IlvClosedSpline, IlvFilledSpline, IlvTimeScale, IlvZoomableIcon, IlvZoomableTransparentIcon, and IlvZoomableLabel.
| IlvColorPattern* IlvSimpleGraphic::getColorPattern | ( | ) | const |
Retrieves the color pattern.
IlvPalette::getColorPattern value of the palette. | virtual IlvDisplay* IlvSimpleGraphic::getDisplay | ( | ) | const [virtual] |
Retrieves the IlvDisplay instance.
getDisplay of the palette object associated with this object (see IlvResource::getDisplay). Reimplemented from IlvGraphic.
| IlvFillRule IlvSimpleGraphic::getFillRule | ( | ) | const |
Retrieves the fill rule.
IlvPalette::getFillRule value of the palette. | IlvFillStyle IlvSimpleGraphic::getFillStyle | ( | ) | const |
Retrieves the fill style.
IlvPalette::getFillStyle value of the palette. | IlvFont* IlvSimpleGraphic::getFont | ( | ) | const |
Retrieves the font.
IlvPalette::getFont value of the palette. | IlvColor* IlvSimpleGraphic::getForeground | ( | ) | const |
Retrieves the foreground color.
IlvPalette::getForeground value of the palette. | IlvGradientPattern* IlvSimpleGraphic::getGradientPattern | ( | ) | const |
Retrieves the gradient pattern.
IlvPalette::getGradientPattern value of the palette. | IlvLineStyle* IlvSimpleGraphic::getLineStyle | ( | ) | const |
Retrieves the line style.
IlvPalette::getLineStyle value of the palette. | IlUShort IlvSimpleGraphic::getLineWidth | ( | ) | const [virtual] |
Retrieves the line width.
IlvPalette::getLineWidth value of the palette. Reimplemented from IlvGraphic.
| virtual IlvLookFeelHandler* IlvSimpleGraphic::getLookFeelHandler | ( | ) | const [virtual] |
Returns the look & feel handler used by this object.
The default implementation returns the look & feel handler of the display connected to this object.
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget.
| virtual int IlvSimpleGraphic::getLookupStringInputMethod | ( | IlvEvent & | event, | |
| char * | bufferReturn, | |||
| int | bytesBuffer, | |||
| int * | statusReturn | |||
| ) | [virtual] |
Gets the preedit string from an input method.
This method is offered to developers of subclasses of IlvSimpleGraphic wanted to control input and connection to an input method, so that input can be done in the current locale. It returns the preedit string from an input method.
It should be called from the handleEvent when getting a key press event (in the IlvKeyDown case).
| event | The key press event. | |
| bufferReturn | The returned multibyte buffer containing the preedit string. You must pre-allocate this buffer so that it can be filled, and the actual size of the buffer can be enlarged using this same method (see statusReturn). | |
| bytesBuffer | The size in bytes of the allocated buffer. | |
| statusReturn | The return status of the operation. This can be:
|
| IlvDrawMode IlvSimpleGraphic::getMode | ( | ) | const |
Retrieves the draw mode.
IlvPalette::getMode value of the palette. | IlBoolean IlvSimpleGraphic::getOverwrite | ( | ) | const |
Retrieves the overwrite mode.
IlvPalette::getOverwrite value of the palette. | IlvPalette* IlvSimpleGraphic::getPalette | ( | ) | const |
Retrieves the internal palette value.
| IlvPattern* IlvSimpleGraphic::getPattern | ( | ) | const |
Retrieves the pattern.
IlvPalette::getPattern value of the palette. | static IlAny IlvSimpleGraphic::GetProperty | ( | const IlSymbol * | key, | |
| IlBoolean | checkSuperClass = ((IlBoolean) 0) | |||
| ) | [static] |
Retrieves the property value associated with the key in this object's class.
Retrieves the property value associated with the property name key. If the property cannot be found in the class of this object, and if checkSuperClass is set to IlTrue, then the function operates iteratively on each superclass until the property is found. If the property cannot be found, then 0 is returned.
| key | The key with which the property value is associated. | |
| checkSuperClass | IlTrue specifies iterative search on superclasses. |
0. Reimplemented from IlvGraphic.
Reimplemented in IlvContainerRectangle, IlvArc, IlvFilledArc, IlvCalendarScale, IlvCircularGauge, IlvFilledCircularGauge, IlvCircularScale, IlvEllipse, IlvFilledEllipse, IlvGauge, IlvRectangularGauge, IlvSliderGauge, IlvReliefGauge, IlvGridRectangle, IlvIcon, IlvTransparentIcon, IlvLabel, IlvFilledLabel, IlvListLabel, IlvLine, IlvArrowLine, IlvMarker, IlvZoomableMarker, IlvOutlinePolygon, IlvGraphicPath, IlvPolyline, IlvPolygon, IlvArrowPolyline, IlvPolyPoints, IlvPolyPointsSelection, IlvSplineSelection, IlvPolySelection, IlvRectangle, IlvFilledRectangle, IlvViewRectangle, IlvReliefLabel, IlvReliefLine, IlvReliefRectangle, IlvReliefDiamond, IlvRoundRectangle, IlvFilledRoundRectangle, IlvScale, IlvRectangularScale, IlvDrawSelection, IlvReshapeSelection, IlvShadowLabel, IlvShadowRectangle, IlvSpline, IlvClosedSpline, IlvFilledSpline, IlvTimeScale, IlvZoomableIcon, IlvZoomableTransparentIcon, and IlvZoomableLabel.
| static const IlvClassInfo* IlvSimpleGraphic::HasProperty | ( | const IlSymbol * | key, | |
| IlBoolean | checkSuperClass = ((IlBoolean) 0) | |||
| ) | [static] |
Checks for the existence of a property for this object's class hierarchy.
Retrieves a pointer to the IlvClassInfo that indicates a class where the key property exists. If the returned value is non-0, then this property actually exists for this class. If this is not the case and if checkSuperClass is set to IlTrue, then the function operates iteratively on each superclass until a match is found. If the property cannot be found, then 0 is returned.
| key | The key with which the property value is associated. | |
| checkSuperClass | IlTrue specifies iterative search on superclasses. |
0. Reimplemented from IlvGraphic.
Reimplemented in IlvContainerRectangle, IlvArc, IlvFilledArc, IlvCalendarScale, IlvCircularGauge, IlvFilledCircularGauge, IlvCircularScale, IlvEllipse, IlvFilledEllipse, IlvGauge, IlvRectangularGauge, IlvSliderGauge, IlvReliefGauge, IlvGridRectangle, IlvIcon, IlvTransparentIcon, IlvLabel, IlvFilledLabel, IlvListLabel, IlvLine, IlvArrowLine, IlvMarker, IlvZoomableMarker, IlvOutlinePolygon, IlvGraphicPath, IlvPolyline, IlvPolygon, IlvArrowPolyline, IlvPolyPoints, IlvPolyPointsSelection, IlvSplineSelection, IlvPolySelection, IlvRectangle, IlvFilledRectangle, IlvViewRectangle, IlvReliefLabel, IlvReliefLine, IlvReliefRectangle, IlvReliefDiamond, IlvRoundRectangle, IlvFilledRoundRectangle, IlvScale, IlvRectangularScale, IlvDrawSelection, IlvReshapeSelection, IlvShadowLabel, IlvShadowRectangle, IlvSpline, IlvClosedSpline, IlvFilledSpline, IlvTimeScale, IlvZoomableIcon, IlvZoomableTransparentIcon, and IlvZoomableLabel.
Highlights the object.
Highlights the object. It is implemented as swapping the foreground and background colors of the object, but can have other implementations in derived subclasses. The parameter temp controls the way you toggle between the background and the foreground. If temp is omitted or is IlFalse, then a new palette is computed by calling the IlvDisplay::getPalette() method. If temp is IlTrue, the object palette is inverted, and thus all the objects referencing this palette will be affected.
| temp | If IlTrue, highlights the object. |
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget, IlvGauge, IlvReliefGauge, IlvOutlinePolygon, IlvReliefLine, and IlvReliefRectangle.
| IlBoolean IlvSimpleGraphic::isSubtypeOf | ( | const IlvClassInfo * | classInfo | ) | const |
Checks whether this object's class is a subclass.
This method is equivalent to getClassInfo()->isSubtypeOf(classInfo).
| classInfo | The name of a class on which the object's class is tested. |
IlTrue or IlFalse, depending on whether or not this object's class is a subclass of the class indicated by classInfo. Reimplemented from IlvGraphic.
Reimplemented in IlvContainerRectangle, IlvArc, IlvFilledArc, IlvCalendarScale, IlvCircularGauge, IlvFilledCircularGauge, IlvCircularScale, IlvEllipse, IlvFilledEllipse, IlvGauge, IlvRectangularGauge, IlvSliderGauge, IlvReliefGauge, IlvGridRectangle, IlvIcon, IlvTransparentIcon, IlvLabel, IlvFilledLabel, IlvListLabel, IlvLine, IlvArrowLine, IlvMarker, IlvZoomableMarker, IlvOutlinePolygon, IlvGraphicPath, IlvPolyline, IlvPolygon, IlvArrowPolyline, IlvPolyPoints, IlvPolyPointsSelection, IlvSplineSelection, IlvPolySelection, IlvRectangle, IlvFilledRectangle, IlvViewRectangle, IlvReliefLabel, IlvReliefLine, IlvReliefRectangle, IlvReliefDiamond, IlvRoundRectangle, IlvFilledRoundRectangle, IlvScale, IlvRectangularScale, IlvDrawSelection, IlvReshapeSelection, IlvShadowLabel, IlvShadowRectangle, IlvSpline, IlvClosedSpline, IlvFilledSpline, IlvTimeScale, IlvZoomableIcon, IlvZoomableTransparentIcon, and IlvZoomableLabel.
| IlBoolean IlvSimpleGraphic::isSubtypeOf | ( | const char * | parentClass | ) | const |
Checks whether this object's class is a subclass of a given parent class.
This method is equivalent to getClassInfo()->isSubtypeOf(parentClass).
| parentClass | A string representing the parent class. |
IlTrue or IlFalse, depending on whether or not this object's class inherits parentClass attributes. The parentClass parameter should be a string representing the class name of an IlvGraphic subclass. A call to this member function for a given class instance returns IlTrue if given the name of its class. Reimplemented from IlvGraphic.
Reimplemented in IlvContainerRectangle, IlvArc, IlvFilledArc, IlvCalendarScale, IlvCircularGauge, IlvFilledCircularGauge, IlvCircularScale, IlvEllipse, IlvFilledEllipse, IlvGauge, IlvRectangularGauge, IlvSliderGauge, IlvReliefGauge, IlvGridRectangle, IlvIcon, IlvTransparentIcon, IlvLabel, IlvFilledLabel, IlvListLabel, IlvLine, IlvArrowLine, IlvMarker, IlvZoomableMarker, IlvOutlinePolygon, IlvGraphicPath, IlvPolyline, IlvPolygon, IlvArrowPolyline, IlvPolyPoints, IlvPolyPointsSelection, IlvSplineSelection, IlvPolySelection, IlvRectangle, IlvFilledRectangle, IlvViewRectangle, IlvReliefLabel, IlvReliefLine, IlvReliefRectangle, IlvReliefDiamond, IlvRoundRectangle, IlvFilledRoundRectangle, IlvScale, IlvRectangularScale, IlvDrawSelection, IlvReshapeSelection, IlvShadowLabel, IlvShadowRectangle, IlvSpline, IlvClosedSpline, IlvFilledSpline, IlvTimeScale, IlvZoomableIcon, IlvZoomableTransparentIcon, and IlvZoomableLabel.
| virtual void IlvSimpleGraphic::registerInputMethod | ( | ) | const [virtual] |
Controls the connection of a graphic object to an input method.
This method is offered to developers of subclasses of IlvSimpleGraphic wanted to control input and connection to an input method, so that input can be done in the current locale.
This method is used internally when an object is attached to its holder, as long as IlvSetLocale has been called, and IlvGraphic::needsInputContext returns IlTrue.
A developer could use it when its graphic object changes its editable state from non-editable to editable.
IlvSetLocale, IlvGraphic::needsInputContext. Removes a property from this object's class.
This static function removes the indicated property to the class of this object.
| key | The key property to be removed. |
IlTrue if the key property was actually found, or IlFalse otherwise. Reimplemented from IlvGraphic.
Reimplemented in IlvContainerRectangle, IlvArc, IlvFilledArc, IlvCalendarScale, IlvCircularGauge, IlvFilledCircularGauge, IlvCircularScale, IlvEllipse, IlvFilledEllipse, IlvGauge, IlvRectangularGauge, IlvSliderGauge, IlvReliefGauge, IlvGridRectangle, IlvIcon, IlvTransparentIcon, IlvLabel, IlvFilledLabel, IlvListLabel, IlvLine, IlvArrowLine, IlvMarker, IlvZoomableMarker, IlvOutlinePolygon, IlvGraphicPath, IlvPolyline, IlvPolygon, IlvArrowPolyline, IlvPolyPoints, IlvPolyPointsSelection, IlvSplineSelection, IlvPolySelection, IlvRectangle, IlvFilledRectangle, IlvViewRectangle, IlvReliefLabel, IlvReliefLine, IlvReliefRectangle, IlvReliefDiamond, IlvRoundRectangle, IlvFilledRoundRectangle, IlvScale, IlvRectangularScale, IlvDrawSelection, IlvReshapeSelection, IlvShadowLabel, IlvShadowRectangle, IlvSpline, IlvClosedSpline, IlvFilledSpline, IlvTimeScale, IlvZoomableIcon, IlvZoomableTransparentIcon, and IlvZoomableLabel.
Replaces a property in this object's class.
This static function replaces the indicated property value to the class of this object.
| key | The key to be replaced. | |
| value | The value to be replaced. |
IlTrue if the key property was actually found, or IlFalse otherwise. Reimplemented from IlvGraphic.
Reimplemented in IlvContainerRectangle, IlvArc, IlvFilledArc, IlvCalendarScale, IlvCircularGauge, IlvFilledCircularGauge, IlvCircularScale, IlvEllipse, IlvFilledEllipse, IlvGauge, IlvRectangularGauge, IlvSliderGauge, IlvReliefGauge, IlvGridRectangle, IlvIcon, IlvTransparentIcon, IlvLabel, IlvFilledLabel, IlvListLabel, IlvLine, IlvArrowLine, IlvMarker, IlvZoomableMarker, IlvOutlinePolygon, IlvGraphicPath, IlvPolyline, IlvPolygon, IlvArrowPolyline, IlvPolyPoints, IlvPolyPointsSelection, IlvSplineSelection, IlvPolySelection, IlvRectangle, IlvFilledRectangle, IlvViewRectangle, IlvReliefLabel, IlvReliefLine, IlvReliefRectangle, IlvReliefDiamond, IlvRoundRectangle, IlvFilledRoundRectangle, IlvScale, IlvRectangularScale, IlvDrawSelection, IlvReshapeSelection, IlvShadowLabel, IlvShadowRectangle, IlvSpline, IlvClosedSpline, IlvFilledSpline, IlvTimeScale, IlvZoomableIcon, IlvZoomableTransparentIcon, and IlvZoomableLabel.
| virtual void IlvSimpleGraphic::setAlpha | ( | IlvIntensity | alpha | ) | [virtual] |
Sets the alpha value of the object.
| alpha | The new alpha value. |
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget, IlvGauge, IlvReliefGauge, IlvOutlinePolygon, IlvGraphicPath, IlvReliefLine, IlvReliefRectangle, and IlvShadowRectangle.
| virtual void IlvSimpleGraphic::setAntialiasingMode | ( | IlvAntialiasingMode | mode | ) | [virtual] |
Sets the anti-aliasing mode of the object.
| mode | The new anti-aliasing mode. |
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget, IlvGauge, IlvReliefGauge, IlvOutlinePolygon, IlvGraphicPath, IlvReliefLine, IlvReliefRectangle, and IlvShadowRectangle.
| virtual void IlvSimpleGraphic::setArcMode | ( | IlvArcMode | mode | ) | [virtual] |
Sets the arc mode of the object.
| mode | The new arc mode. |
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget, and IlvReliefRectangle.
| virtual void IlvSimpleGraphic::setBackground | ( | IlvColor * | background | ) | [virtual] |
Sets the background color of the object.
Sets the background color of the object.
| background | The new background color. |
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget, IlvGauge, IlvOutlinePolygon, IlvGraphicPath, IlvViewRectangle, IlvReliefLine, IlvReliefRectangle, and IlvShadowRectangle.
| virtual void IlvSimpleGraphic::setColorPattern | ( | IlvColorPattern * | pattern | ) | [virtual] |
Sets the color pattern of the object.
Sets the color pattern of the object.
| pattern | The new color pattern. |
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget, IlvRectangularGauge, and IlvReliefRectangle.
| virtual void IlvSimpleGraphic::setFillRule | ( | IlvFillRule | rule | ) | [virtual] |
Sets the fill rule of the object.
| rule | The new fill rule. |
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget, and IlvReliefRectangle.
| virtual void IlvSimpleGraphic::setFillStyle | ( | IlvFillStyle | style | ) | [virtual] |
Sets the fill style of the object.
| style | The new fill style. |
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget, IlvRectangularGauge, and IlvReliefRectangle.
| virtual void IlvSimpleGraphic::setFocusValuesInputMethod | ( | IlUShort | count, | |
| const IlvImValue * | values | |||
| ) | const [virtual] |
Controls the interaction between a simple graphic object and an input method.
This method is offered to developers of subclasses of IlvSimpleGraphic wanted to control input and connection to an input method, so that input can be done in the current locale. It tells the input method that this object has now the input focus.
This method should be called when an object gets the keyboard focus (usually in the handleEvent under the IlvKeyboardFocusIn), as long as IlvSetLocale has been called, and IlvGraphic::needsInputContext returns IlTrue.
| count | The number of values. | |
| values | The attributes and values to be passed to an input method to update an input context. See detailed information in setValuesInputMethod. |
| virtual void IlvSimpleGraphic::setFont | ( | IlvFont * | font | ) | [virtual] |
Sets the font of the object.
| font | The new font. |
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget, IlvLabel, IlvListLabel, IlvReliefLabel, IlvReliefRectangle, IlvScale, and IlvShadowLabel.
| virtual void IlvSimpleGraphic::setForeground | ( | IlvColor * | foreground | ) | [virtual] |
Sets the foreground color of the object.
Sets the foreground color of the object.
| foreground | The new foreground color. |
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget, IlvGauge, IlvReliefGauge, IlvOutlinePolygon, IlvGraphicPath, IlvReliefLine, IlvReliefRectangle, and IlvShadowRectangle.
| virtual void IlvSimpleGraphic::setGradientPattern | ( | IlvGradientPattern * | pattern | ) | [virtual] |
Sets the gradient pattern of the object.
Sets the gradient pattern of the object.
| pattern | The new gradient pattern. |
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget, IlvRectangularGauge, and IlvReliefRectangle.
| virtual void IlvSimpleGraphic::setHolder | ( | IlvGraphicHolder * | holder | ) | [virtual] |
Sets the object's holder.
This default implementation has no real function.
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget.
| virtual void IlvSimpleGraphic::setLineStyle | ( | IlvLineStyle * | style | ) | [virtual] |
Sets the line style of the object.
| style | The new line style. |
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget, IlvOutlinePolygon, IlvReliefLine, IlvReliefRectangle, and IlvShadowRectangle.
| virtual void IlvSimpleGraphic::setLineWidth | ( | IlUShort | width | ) | [virtual] |
Sets the line width of the object.
| width | The new line width. |
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget, IlvOutlinePolygon, IlvReliefLine, IlvReliefRectangle, and IlvShadowRectangle.
| virtual void IlvSimpleGraphic::setMode | ( | IlvDrawMode | mode | ) | [virtual] |
Sets the drawing mode of the object temporarily.
Changing the IlvDrawMode attribute of an object is considered a temporary operation. You have to set the mode to its default value when you no longer need another mode different from the value IlvModeSet. The drawing mode information is passed to the palette of the graphic object (see the IlvPalette::setOverwrite method for more details).
| mode | The drawing mode to be set. |
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget, IlvGauge, IlvReliefGauge, IlvOutlinePolygon, IlvGraphicPath, IlvPolySelection, IlvReliefLine, IlvReliefRectangle, IlvDrawSelection, and IlvShadowRectangle.
| virtual void IlvSimpleGraphic::setOverwrite | ( | IlBoolean | over | ) | [virtual] |
Sets an overwrite mode that modifies how the drawing member functions operate.
Modifies the way the drawing member functions operate. The information is passed to the palette of the graphic object (see the IlvPalette::setOverwrite method for more details).
| over | If IlFalse, sets selective hidden drawing operations. |
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget, IlvGauge, IlvOutlinePolygon, IlvReliefLine, IlvReliefRectangle, IlvDrawSelection, and IlvShadowRectangle.
| virtual void IlvSimpleGraphic::setPalette | ( | IlvPalette * | palette | ) | [virtual] |
Sets the internal palette to the given palette value.
Sets the internal palette to the given palette value. The previous palette is unlocked, and palette is locked.
| palette | The new palette of this object. |
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget, IlvGauge, IlvReliefGauge, IlvLabel, IlvOutlinePolygon, IlvGraphicPath, IlvViewRectangle, IlvReliefLine, IlvReliefRectangle, IlvScale, IlvDrawSelection, and IlvShadowRectangle.
| virtual void IlvSimpleGraphic::setPattern | ( | IlvPattern * | pattern | ) | [virtual] |
Sets the pattern of the object.
Sets the pattern of the object.
| pattern | The new pattern. |
Reimplemented from IlvGraphic.
Reimplemented in IlvGadget, and IlvReliefRectangle.
| virtual void IlvSimpleGraphic::setValuesInputMethod | ( | IlUShort | count, | |
| const IlvImValue * | values | |||
| ) | const [virtual] |
Controls the interaction between a graphic object and an input method.
This method is offered to developers of subclasses of IlvSimpleGraphic wanted to control input and connection to an input method, so that input can be done in the current locale. It gives the input method attributes to update the input context.
This method should be called each time an object modifies its position or its appearance so that the input context can be updated, as long as IlvSetLocale has been called, and IlvGraphic::needsInputContext returns IlTrue.
It is automatically called from the following methods:
IlvSimpleGraphic::setPalette to communicate the foreground and background colors. IlvSimpleGraphic::setBackground to communicate the background color.IlvSimpleGraphic::setForeground to communicate the foreground color. IlvGadget::applyTransform to communicate the rectangle size of the object. as long as IlvSetLocale() has been called, and IlvGraphic::needsInputContext returns IlTrue.
| count | The number of values. | |
| values | The attributes and values to be passed to an input method to update an input context. See the IlvImValue class for more information. |
IlvSetLocale, IlvImValue, IlvGraphic::needsInputContext. | virtual void IlvSimpleGraphic::unRegisterInputMethod | ( | ) | const [virtual] |
Controls the disconnection of a graphic object from an input method.
This method is offered to developers of subclasses of IlvSimpleGraphic wanted to control input and connection to an input method, so that input can be done in the current locale.
This method is used internally when an object is removed from its holder, as long as IlvSetLocale() has been called, and IlvGraphic::needsInputContext returns IlTrue.
A developer could use it when its graphic object changes its editable state from editable to non-editable.
IlvSetLocale, IlvGraphic::needsInputContext. | virtual void IlvSimpleGraphic::unsetFocusInputMethod | ( | ) | const [virtual] |
Controls the interaction between a graphic object and an input method.
This method is offered to developers of subclasses of IlvSimpleGraphic wanted to control input and connection to an input method, so that input can be done in the current locale. It tells the input method that this object has lost the input focus.
This method should be called when an object looses the keyboard focus (usually in the handleEvent in the IlvKeyboardFocusOut case), as long as IlvSetLocale has been called, and IlvGraphic::needsInputContext returns IlTrue.
IlvSetLocale, IlvGraphic::needsInputContext. © 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.