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
IlvSimpleGraphic Class Reference

Graphic class. More...

#include <ilviews/base/graphic.h>

Inheritance diagram for IlvSimpleGraphic:
IlvGraphic IlvArc IlvDrawSelection IlvEllipse IlvGadget IlvGauge IlvGraphicPath IlvIcon IlvLabel IlvLine IlvListLabel IlvMarker IlvPolyPoints IlvPolySelection IlvRectangle IlvScale IlvTimeScale

Public Member Functions

 IlvSimpleGraphic (IlvDisplay *display, IlvPalette *palette=0)
 Constructor. More...
 
virtual ~IlvSimpleGraphic ()
 Destructor. More...
 
virtual void applyResources (const char *storageName, const char *storageClassName, const char *objectName, const char *objectClassName, IlvDisplay *display=0)
 Applies resources on a graphic object. More...
 
IlvIntensity getAlpha () const
 Retrieves the alpha value. More...
 
IlvAntialiasingMode getAntialiasingMode () const
 Retrieves the anti-aliasing mode. More...
 
IlvArcMode getArcMode () const
 Retrieves the arc mode. More...
 
IlvColorgetBackground () const
 Retrieves the background color. More...
 
IlvColorPatterngetColorPattern () const
 Retrieves the color pattern. More...
 
virtual IlvDisplaygetDisplay () const
 Retrieves the IlvDisplay instance. More...
 
IlvFillRule getFillRule () const
 Retrieves the fill rule. More...
 
IlvFillStyle getFillStyle () const
 Retrieves the fill style. More...
 
IlvFontgetFont () const
 Retrieves the font. More...
 
IlvColorgetForeground () const
 Retrieves the foreground color. More...
 
IlvGradientPatterngetGradientPattern () const
 Retrieves the gradient pattern. More...
 
IlvLineStylegetLineStyle () const
 Retrieves the line style. More...
 
IlUShort getLineWidth () const
 Retrieves the line width. More...
 
virtual IlvLookFeelHandlergetLookFeelHandler () const
 Returns the look & feel handler used by this object. More...
 
virtual int getLookupStringInputMethod (IlvEvent &event, char *bufferReturn, int bytesBuffer, int *statusReturn)
 Gets the preedit string from an input method. More...
 
IlvDrawMode getMode () const
 Retrieves the draw mode. More...
 
IlBoolean getOverwrite () const
 Retrieves the overwrite mode. More...
 
IlvPalettegetPalette () const
 Retrieves the internal palette value. More...
 
IlvPatterngetPattern () const
 Retrieves the pattern. More...
 
virtual void invert (IlBoolean temp=IlFalse)
 Highlights the object. More...
 
virtual void registerInputMethod () const
 Controls the connection of a graphic object to an input method. More...
 
virtual void setAlpha (IlvIntensity alpha)
 Sets the alpha value of the object. More...
 
virtual void setAntialiasingMode (IlvAntialiasingMode mode)
 Sets the anti-aliasing mode of the object. More...
 
virtual void setArcMode (IlvArcMode am)
 Sets the arc mode of the object. More...
 
virtual void setBackground (IlvColor *c)
 Sets the background color of the object. More...
 
virtual void setColorPattern (IlvColorPattern *b)
 Sets the color pattern of the object. More...
 
virtual void setFillRule (IlvFillRule fr)
 Sets the fill rule of the object. More...
 
virtual void setFillStyle (IlvFillStyle f)
 Sets the fill style of the object. More...
 
virtual void setFocusValuesInputMethod (IlUShort count, const IlvImValue *values) const
 Controls the interaction between a simple graphic object and an input method. More...
 
virtual void setFont (IlvFont *f)
 Sets the font of the object. More...
 
virtual void setForeground (IlvColor *c)
 Sets the foreground color of the object. More...
 
virtual void setGradientPattern (IlvGradientPattern *g)
 Sets the gradient pattern of the object. More...
 
virtual void setHolder (IlvGraphicHolder *holder)
 Sets the object's holder. More...
 
virtual void setLineStyle (IlvLineStyle *style)
 Sets the line style of the object. More...
 
virtual void setLineWidth (IlUShort width)
 Sets the line width of the object. More...
 
virtual void setMode (IlvDrawMode m)
 Sets the drawing mode of the object temporarily. More...
 
virtual void setOverwrite (IlBoolean o)
 Sets an overwrite mode that modifies how the drawing member functions operate. More...
 
virtual void setPalette (IlvPalette *palette)
 Sets the internal palette to the given palette value. More...
 
virtual void setPattern (IlvPattern *p)
 Sets the pattern of the object. More...
 
virtual void setValuesInputMethod (IlUShort count, const IlvImValue *values) const
 Controls the interaction between a graphic object and an input method. More...
 
virtual void unRegisterInputMethod () const
 Controls the disconnection of a graphic object from an input method. More...
 
virtual void unsetFocusInputMethod () const
 Controls the interaction between a graphic object and an input method. More...
 
- Public Member Functions inherited from IlvGraphic
void addCallback (const IlSymbol *callbackType, IlvGraphicCallback callback)
 Adds a callback function to a callback list. More...
 
void addCallback (const IlSymbol *callbackType, const IlSymbol *callbackName, const IlSymbol *script=0)
 Adds a callback function to a callback list. More...
 
void addCallback (const IlSymbol *callbackType, IlvGraphicCallback callback, IlAny data)
 Adds a callback function to a callback list. More...
 
void addClassProperty (const IlSymbol *key, IlAny value)
 Adds a property to this object's class. More...
 
void addProperty (const IlSymbol *key, IlAny value)
 Adds a specific property to the object. More...
 
void addTag (const IlSymbol *tag)
 Adds a tag. More...
 
virtual void apply (IlvApplyObject function, IlAny arg)
 Applies a function to objects that compose another object. More...
 
IlBoolean applyAttribute (const char *attributeClassName, IlInt value, IlAny checkData=0) const
 Applies attributes. More...
 
IlBoolean applyAttribute (const char *attributeClassName, IlFloat value, IlAny checkData=0) const
 Applies attributes. More...
 
IlBoolean applyAttribute (const char *attributeClassName, const char *value, IlAny checkData=0) const
 Applies attributes. More...
 
virtual void applyReferences (IlvApplyObject function, IlAny arg)
 Applies a function to objects that are referenced by another object. More...
 
virtual void applyTransform (const IlvTransformer *t)=0
 Applies a transformation function to the graphic object. More...
 
virtual IlBoolean applyValue (const IlvValue &val)
 Apply an accessor. More...
 
virtual void boundingBox (IlvRect &bbox, const IlvTransformer *t=0) const =0
 Retrieves the bounding box of the graphic object. More...
 
virtual void callCallbacks (const IlSymbol *callbackType)
 Calls every callback of a given type. More...
 
virtual IlBoolean changeValue (const IlvValue &val)
 Changes the value of an accessor. More...
 
virtual IlBoolean changeValues (const IlvValue *values, IlUShort count)
 Changes several accessor values simultaneously. More...
 
const char * className () const
 Returns the class name of an object. More...
 
virtual void computeFocusRegion (IlvRegion &r, const IlvTransformer *t=0) const
 Computes the region needed for the drawing of the focus. More...
 
virtual IlBoolean contains (const IlvPoint &p, const IlvPoint &tp, const IlvTransformer *t=0) const
 Checks whether a point is in the object. More...
 
IlBoolean contains (const IlvPoint &p) const
 Checks whether a point is in the object. More...
 
virtual IlvGraphiccopy () const =0
 Copies this object. More...
 
virtual void draw (IlvPort *dst, const IlvTransformer *t=0, const IlvRegion *clip=0) const =0
 Draws the graphic object. More...
 
void draw (IlvPort *dst, const IlvTransformer *t, const IlvRect *clip) const
 Draws a graphic object. More...
 
virtual void drawFocus (IlvPort *dst, const IlvPalette *palette, const IlvTransformer *t=0, const IlvRegion *clip=0) const
 Draws additional drawings for an object that has the keyboard focus. More...
 
virtual void getAccessors (const IlSymbol *const **accessors, const IlvValueTypeClass *const **types, IlUInt &count) const
 Retrieves the list of available accessors of an object. More...
 
IlvGraphicCallback getCallback (const IlSymbol *callbackType) const
 Gets a callback. More...
 
IlvGraphicCallback getCallback () const
 Gets the main callback function. More...
 
IlAny getCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback) const
 Gets a callback user data. More...
 
IlAny getCallbackData (const IlSymbol *callbackType, const IlSymbol *callbackName) const
 Gets a callback user data. More...
 
IlSymbolgetCallbackName (const IlSymbol *callbackType) const
 Gets the name of a callback. More...
 
IlSymbolgetCallbackName () const
 Gets the symbol that identifies the main callback. More...
 
virtual IlUInt getCallbackTypes (const char *const **names, const IlSymbol *const **types) const
 Gets the number of register callback types for the object. More...
 
virtual IlvGraphicgetChildAt (IlUInt index) const
 Returns the sub-object of the graphic object specified by index. More...
 
virtual IlvGraphicgetChildByName (const char *name) const
 Returns the sub-object of the graphic object specified by name. More...
 
virtual IlUInt getChildCount () const
 Returns the number of children of this graphic object. More...
 
virtual IlInt getChildIndex (const IlvGraphic *object) const
 Returns the index of the specified sub-object in this graphic object. More...
 
virtual IlvGraphic *const * getChildren (IlUInt &count) const
 Returns an array containing the sub-objects of this graphic object. More...
 
virtual IlvClassInfogetClassInfo () const
 Gets class information. More...
 
IlAny getClassProperty (const IlSymbol *key, IlBoolean checkParent=IlFalse) const
 Retrieves the indicated property value in the class of this object. More...
 
IlAny getClientData () const
 Gets client data. More...
 
virtual const char * getDefaultInteractor () const
 Gets the name of the default interactor for this object. More...
 
virtual IlvGraphicHoldergetHolder () const
 Gets a pointer to an object's holder. More...
 
IlvInteractorgetInteractor () const
 Returns the interactor associated with the current object. More...
 
const char * getName () const
 Gets the name of the object. More...
 
IlvNamedPropertygetNamedProperty (const IlSymbol *name) const
 Gets a named property. More...
 
IlSymbolgetNextFocusGraphic () const
 Gets the next object in the focus chain. More...
 
IlSymbolgetPreviousFocusGraphic () const
 Gets the previous object in the focus chain. More...
 
IlAny getProperty (const IlSymbol *key) const
 Gets a property. More...
 
IlvSmartSetgetSmartSet () const
 Gets the smart set object containing a specified graphic object. More...
 
IlvDim h () const
 Gets the height value of the object. More...
 
void h (IlvDim h)
 Sets the height value of the object. More...
 
IlBoolean hasCallback (const IlSymbol *callbackType, IlvGraphicCallback callback) const
 Checks whether a callback function is in a callback list. More...
 
IlBoolean hasCallback (const IlSymbol *callbackType, const IlSymbol *callbackName) const
 Checks whether a callback function is in a callback list. More...
 
IlBoolean hasCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback) const
 Checks whether a callback function has user data. More...
 
IlBoolean hasCallbackData (const IlSymbol *callbackType, const IlSymbol *callbackName) const
 Checks whether a callback function has user data. More...
 
const IlvClassInfohasClassProperty (const IlSymbol *key, IlBoolean s=IlFalse) const
 Checks for a class where the keyed property exists. More...
 
IlBoolean hasProperty (const IlSymbol *key) const
 Checks whether the object has a particular property. More...
 
IlBoolean hasTag (const IlSymbol *tag) const
 Checks whether the object has a specific tag. More...
 
virtual IlBoolean inside (const IlvRegion &r, const IlvTransformer *t=0) const
 Determines whether an object with transformation applied is inside the bounding box. More...
 
IlBoolean inside (const IlvRect &r, const IlvRect &tr, const IlvTransformer *t=0) const
 Determines whether an object with transformation applied is inside the bounding box. More...
 
IlBoolean inside (const IlvRect &r) const
 Determines whether a rectangle is inside the bounding box. More...
 
virtual IlBoolean intersects (const IlvRegion &r, const IlvTransformer *t=0) const
 Checks whether a region intersects the bounding box with transformation applied. More...
 
IlBoolean intersects (const IlvRect &r, const IlvRect &tr, const IlvTransformer *t=0) const
 Checks whether a rectangle intersects the bounding box with transformation applied. More...
 
IlBoolean intersects (const IlvRect &r) const
 Checks whether a rectangle intersects the bounding box. More...
 
IlBoolean isFirstFocusGraphic () const
 Checks whether the object is first in the focus chain. More...
 
IlBoolean isFocusable () const
 Checks whether the object can receive the keyboard focus or not. More...
 
IlBoolean isInSmartSet () const
 Checks whether a graphic object belongs to a smart set. More...
 
IlBoolean isLastFocusGraphic () const
 Checks whether the object is last in the focus chain. More...
 
IlBoolean isSensitive () const
 Checks whether the object is sensitive. More...
 
IlBoolean isSubtypeOf (const char *parentClass) const
 Checks whether this object's class is a subclass of a given parent class. More...
 
IlBoolean isSubtypeOf (const IlvClassInfo *classInfo) const
 Checks whether this object's class is a subclass. More...
 
virtual void move (IlvPos x, IlvPos y)
 Moves the graphic object. More...
 
void move (const IlvPoint &p)
 Moves the graphic object. More...
 
void moveResize (const IlvRect &size)
 Moves and resizes a graphic object. More...
 
virtual IlBoolean needsInputContext () const
 Indicates whether the graphic instance can connect to an input method for locale dependent input. More...
 
virtual void print (ILVSTDPREF ostream &out, int level=0) const
 Prints for debugging purposes. More...
 
virtual IlvValuequeryValue (IlvValue &val) const
 Retrieves the value of an accessor. More...
 
virtual void queryValues (IlvValue *values, IlUShort count) const
 Retrieves multiple accessor values simultaneously. More...
 
void removeCallback (const IlSymbol *callbackType, IlvGraphicCallback callback)
 Removes a callback function from a callback list. More...
 
void removeCallback (const IlSymbol *callbackType, const IlSymbol *callbackName)
 Removes a callback function from a callback list. More...
 
IlBoolean removeClassProperty (const IlSymbol *key)
 Removes a property from this object's class. More...
 
void removeInteractor ()
 Removes the interactor from the current object. More...
 
IlvNamedPropertyremoveNamedProperty (IlSymbol *name)
 Removes a named property from the object. More...
 
IlBoolean removeProperty (const IlSymbol *key)
 Removes a property from the object. More...
 
void removeTag (const IlSymbol *tag)
 Removes a tag. More...
 
IlBoolean replaceClassProperty (const IlSymbol *key, IlAny value)
 Replaces a property in this object's class. More...
 
IlBoolean replaceProperty (const IlSymbol *key, IlAny value)
 Replaces a property. More...
 
virtual void resize (IlvDim newW, IlvDim newH)
 Resizes a graphic object. More...
 
virtual void rotate (const IlvPoint &center, IlFloat angle)
 Rotates a graphic object. More...
 
virtual void scale (IlFloat zoomX, IlFloat zoomY)
 Scales the graphic object. More...
 
void setCallback (const IlSymbol *callbackType, IlvGraphicCallback callback)
 Sets a new callback. More...
 
void setCallback (const IlSymbol *callbackType, const IlSymbol *callbackName, const IlSymbol *script=0)
 Removes all previously set callbacks. More...
 
void setCallback (const IlSymbol *callbackType, IlvGraphicCallback callback, IlAny data)
 Removes all previously set callbacks. More...
 
void setCallback (IlvGraphicCallback callback, IlAny data)
 Sets the main callback function. More...
 
void setCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback, IlAny data)
 Sets the callback user data for a callback function. More...
 
void setCallbackData (const IlSymbol *callbackType, const IlSymbol *callbackName, IlAny data)
 Sets the callback user data for a callback function. More...
 
void setCallbackName (const IlSymbol *callbackName)
 Sets the symbol that identifies the main callback. More...
 
void setClientData (IlAny clientData)
 Sets client data. More...
 
void setFirstFocusGraphic ()
 Sets the object to be first in the focus chain.
 
void setFocusable (IlBoolean value)
 Set the focusable state of the object. More...
 
IlBoolean setInteractor (IlvInteractor *inter)
 Attaches an interactor to the current object. More...
 
IlBoolean setInteractor (const char *name)
 Attaches an interactor to the current object. More...
 
void setLastFocusGraphic ()
 Sets the object to be last in the focus chain.
 
virtual void setName (const char *name)
 Sets the name of the object. More...
 
IlvNamedPropertysetNamedProperty (IlvNamedProperty *property)
 Sets a named property on the object. More...
 
virtual void setNeedsInputContext (IlBoolean val)
 Specifies whether the graphic object should have locale dependent input. More...
 
void setNextFocusGraphic (IlSymbol *name)
 Sets the object to be next in the focus chain. More...
 
void setPreviousFocusGraphic (IlSymbol *name)
 Sets an object as previous in the focus chain. More...
 
void setProperty (const IlSymbol *key, IlAny value)
 Sets a property of the object to a value. More...
 
virtual void setSensitive (IlBoolean value)
 Sets the sensitivity of the object. More...
 
virtual void symmetry (IlvDirection axis)
 Flips a graphic object. More...
 
virtual void translate (IlvPos dx, IlvPos dy)
 Applies a transformation function on a graphic object. More...
 
IlvDim w () const
 Gets the width value of the object. More...
 
void w (IlvDim w)
 Sets the width value of the object. More...
 
virtual void write (IlvOutputFile &output) const =0
 Writes an object description to a file. More...
 
IlvPos x () const
 Gets the x coordinate value of the object. More...
 
void x (IlvPos x)
 Sets the x coordinate value of the object. More...
 
IlvPos y () const
 Gets the y coordinate value of the object. More...
 
void y (IlvPos y)
 Sets the y coordinate value of the object. More...
 
virtual IlBoolean zoomable () const
 Checks whether this object is zoomable. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvGraphic
static void AddProperty (const IlSymbol *key, IlAny value)
 Adds a property to this object's class. More...
 
static void AddToCallbackTypeList (IlUInt &count, const char *const **names, const IlSymbol *const **types, const char *newName, const IlSymbol *newType)
 Adds a callback to a list. More...
 
static void AllowZoom (IlBoolean az)
 Sets or inhibits zooming. More...
 
static IlvClassInfoClassInfo () const
 Gets class information. More...
 
static IlAny GetProperty (const IlSymbol *key, IlBoolean checkSuperClass=IlFalse)
 Retrieves the property value associated with the key in this object's class. More...
 
static const IlvClassInfoHasProperty (const IlSymbol *key, IlBoolean checkSuperClass=IlFalse)
 Checks for the existence of a property for this object's class hierarchy. More...
 
static IlBoolean IsZoomAllowed ()
 Checks whether zoomable objects can display themselves when zooming out. More...
 
static IlvGraphicread (IlvInputFile &file, IlvPalette *palette)
 Reads an object description from a file. More...
 
static IlBoolean RemoveProperty (const IlSymbol *key)
 Removes a property from this object's class. More...
 
static IlBoolean ReplaceProperty (const IlSymbol *key, IlAny value)
 Replaces a property in this object's class. More...
 

Detailed Description

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:

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.

See Also
IlvDisplay, IlvPalette.

Constructor & Destructor Documentation

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.

Parameters
displayThe display where this object is created.
paletteThe palette of the display object.
virtual IlvSimpleGraphic::~IlvSimpleGraphic ( )
virtual

Destructor.

The destructor unlocks the palette.

Member Function Documentation

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
Parameters
storageNameThe storage name.
storageClassNameThe generic name of the storage instance.
objectNameThe object name.
objectClassNameThe generic name of the object class.
displayThe display where this object is created.

Reimplemented from IlvGraphic.

IlvIntensity IlvSimpleGraphic::getAlpha ( ) const
virtual

Retrieves the alpha value.

Returns
The IlvPalette::getAlpha value of the palette.

Reimplemented from IlvGraphic.

IlvAntialiasingMode IlvSimpleGraphic::getAntialiasingMode ( ) const
virtual

Retrieves the anti-aliasing mode.

Returns
The IlvPalette::getAntialiasingMode value of the palette.

Reimplemented from IlvGraphic.

IlvArcMode IlvSimpleGraphic::getArcMode ( ) const

Retrieves the arc mode.

Returns
The IlvPalette::getArcMode value of the palette.
IlvColor* IlvSimpleGraphic::getBackground ( ) const

Retrieves the background color.

Returns
The IlvPalette::getBackground value of the palette.
IlvColorPattern* IlvSimpleGraphic::getColorPattern ( ) const

Retrieves the color pattern.

Returns
The IlvPalette::getColorPattern value of the palette.
virtual IlvDisplay* IlvSimpleGraphic::getDisplay ( ) const
virtual

Retrieves the IlvDisplay instance.

Returns
The value received from the method getDisplay of the palette object associated with this object (see IlvResource::getDisplay).

Reimplemented from IlvGraphic.

IlvFillRule IlvSimpleGraphic::getFillRule ( ) const

Retrieves the fill rule.

Returns
The IlvPalette::getFillRule value of the palette.
IlvFillStyle IlvSimpleGraphic::getFillStyle ( ) const

Retrieves the fill style.

Returns
The IlvPalette::getFillStyle value of the palette.
IlvFont* IlvSimpleGraphic::getFont ( ) const

Retrieves the font.

Returns
The IlvPalette::getFont value of the palette.
IlvColor* IlvSimpleGraphic::getForeground ( ) const

Retrieves the foreground color.

Returns
The IlvPalette::getForeground value of the palette.
IlvGradientPattern* IlvSimpleGraphic::getGradientPattern ( ) const

Retrieves the gradient pattern.

Returns
The IlvPalette::getGradientPattern value of the palette.
IlvLineStyle* IlvSimpleGraphic::getLineStyle ( ) const

Retrieves the line style.

Returns
The IlvPalette::getLineStyle value of the palette.
IlUShort IlvSimpleGraphic::getLineWidth ( ) const
virtual

Retrieves the line width.

Returns
The 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.

Returns
The look & feel handler used by 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).

Parameters
eventThe key press event.
bufferReturnThe 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).
bytesBufferThe size in bytes of the allocated buffer.
statusReturnThe return status of the operation. This can be:
  • 0 for success. In that case the returned value represents the number of bytes.
  • 1 for failure in case of an allocated buffer too small. In that case the returned value is the needed size.
  • Others values for failure.
Returns
The number of returned bytes, if successful.
IlvDrawMode IlvSimpleGraphic::getMode ( ) const

Retrieves the draw mode.

Returns
The IlvPalette::getMode value of the palette.
IlBoolean IlvSimpleGraphic::getOverwrite ( ) const

Retrieves the overwrite mode.

Returns
The IlvPalette::getOverwrite value of the palette.
IlvPalette* IlvSimpleGraphic::getPalette ( ) const

Retrieves the internal palette value.

Returns
A pointer to the internal palette value.
IlvPattern* IlvSimpleGraphic::getPattern ( ) const

Retrieves the pattern.

Returns
The IlvPalette::getPattern value of the palette.
virtual void IlvSimpleGraphic::invert ( IlBoolean  temp = IlFalse)
virtual

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.

Parameters
tempIf IlTrue, highlights the object.

Reimplemented from IlvGraphic.

Reimplemented in IlvGadget, IlvReliefGauge, IlvGauge, IlvReliefLine, IlvOutlinePolygon, and IlvReliefRectangle.

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.

See Also
IlvSetLocale, IlvGraphic::needsInputContext.
virtual void IlvSimpleGraphic::setAlpha ( IlvIntensity  alpha)
virtual

Sets the alpha value of the object.

Parameters
alphaThe new alpha value.

Reimplemented from IlvGraphic.

Reimplemented in IlvGadget, IlvGraphicPath, IlvReliefGauge, IlvGauge, IlvReliefLine, IlvShadowRectangle, IlvReliefRectangle, and IlvOutlinePolygon.

virtual void IlvSimpleGraphic::setAntialiasingMode ( IlvAntialiasingMode  mode)
virtual

Sets the anti-aliasing mode of the object.

Parameters
modeThe new anti-aliasing mode.

Reimplemented from IlvGraphic.

Reimplemented in IlvGadget, IlvGraphicPath, IlvReliefGauge, IlvGauge, IlvReliefLine, IlvShadowRectangle, IlvReliefRectangle, and IlvOutlinePolygon.

virtual void IlvSimpleGraphic::setArcMode ( IlvArcMode  mode)
virtual

Sets the arc mode of the object.

Parameters
modeThe 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.

Parameters
backgroundThe new background color.

Reimplemented from IlvGraphic.

Reimplemented in IlvGadget, IlvGraphicPath, IlvViewRectangle, IlvGauge, IlvReliefLine, IlvShadowRectangle, IlvOutlinePolygon, and IlvReliefRectangle.

virtual void IlvSimpleGraphic::setColorPattern ( IlvColorPattern pattern)
virtual

Sets the color pattern of the object.

Sets the color pattern of the object.

Parameters
patternThe 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.

Parameters
ruleThe 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.

Parameters
styleThe 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.

Parameters
countThe number of values.
valuesThe attributes and values to be passed to an input method to update an input context. See detailed information in setValuesInputMethod.
See Also
setValuesInputMethod, IlvSetLocale, IlvGraphic::needsInputContext.
virtual void IlvSimpleGraphic::setFont ( IlvFont font)
virtual

Sets the font of the object.

Parameters
fontThe new font.

Reimplemented from IlvGraphic.

Reimplemented in IlvGadget, IlvScale, IlvListLabel, IlvLabel, IlvShadowLabel, IlvReliefLabel, and IlvReliefRectangle.

virtual void IlvSimpleGraphic::setForeground ( IlvColor foreground)
virtual

Sets the foreground color of the object.

Sets the foreground color of the object.

Parameters
foregroundThe new foreground color.

Reimplemented from IlvGraphic.

Reimplemented in IlvGadget, IlvGraphicPath, IlvReliefGauge, IlvGauge, IlvReliefLine, IlvShadowRectangle, IlvOutlinePolygon, and IlvReliefRectangle.

virtual void IlvSimpleGraphic::setGradientPattern ( IlvGradientPattern pattern)
virtual

Sets the gradient pattern of the object.

Sets the gradient pattern of the object.

Parameters
patternThe 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.

Parameters
styleThe new line style.

Reimplemented from IlvGraphic.

Reimplemented in IlvGadget, IlvReliefLine, IlvShadowRectangle, IlvOutlinePolygon, and IlvReliefRectangle.

virtual void IlvSimpleGraphic::setLineWidth ( IlUShort  width)
virtual

Sets the line width of the object.

Parameters
widthThe new line width.

Reimplemented from IlvGraphic.

Reimplemented in IlvGadget, IlvReliefLine, IlvShadowRectangle, IlvOutlinePolygon, and IlvReliefRectangle.

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

Parameters
modeThe drawing mode to be set.

Reimplemented from IlvGraphic.

Reimplemented in IlvGadget, IlvGraphicPath, IlvReliefGauge, IlvPolySelection, IlvDrawSelection, IlvGauge, IlvReliefLine, IlvShadowRectangle, IlvReliefRectangle, and IlvOutlinePolygon.

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

Parameters
overIf IlFalse, sets selective hidden drawing operations.

Reimplemented from IlvGraphic.

Reimplemented in IlvGadget, IlvDrawSelection, IlvGauge, IlvReliefLine, IlvShadowRectangle, IlvReliefRectangle, and IlvOutlinePolygon.

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.

Parameters
paletteThe new palette of this object.

Reimplemented from IlvGraphic.

Reimplemented in IlvGadget, IlvGraphicPath, IlvReliefGauge, IlvScale, IlvDrawSelection, IlvViewRectangle, IlvGauge, IlvLabel, IlvReliefLine, IlvShadowRectangle, IlvReliefRectangle, and IlvOutlinePolygon.

virtual void IlvSimpleGraphic::setPattern ( IlvPattern pattern)
virtual

Sets the pattern of the object.

Sets the pattern of the object.

Parameters
patternThe 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:

as long as IlvSetLocale() has been called, and IlvGraphic::needsInputContext returns IlTrue.

Parameters
countThe number of values.
valuesThe attributes and values to be passed to an input method to update an input context. See the IlvImValue class for more information.
See Also
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.

See Also
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.

See Also
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.