rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvSelector Class Reference

Graphic class. More...

#include <ilviews/graphics/selector.h>

Inheritance diagram for IlvSelector:
IlvGraphicSet IlvGraphic

List of all members.

Public Member Functions

 IlvSelector ()
 Constructor.
const char * className () const
 Returns the class name of an object.
virtual void computeFocusRegion (IlvRegion &, const IlvTransformer *t=0) const
 Computes the region needed for the drawing of the focus.
virtual IlvGraphiccopy () const
 Copies this object.
virtual void drawFocus (IlvPort *, const IlvPalette *, const IlvTransformer *t=0, const IlvRegion *clip=0) const
 Draws additional drawings for an object that has the keyboard focus.
virtual IlvClassInfogetClassInfo () const
 Gets class information.
virtual void insertObject (IlvGraphic *obj)
 Inserts an object.
IlBoolean isSelected (IlvGraphic *object) const
 Returns a Boolean value indicating whether the specified graphic is selected or not.
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 removeObject (IlvGraphic *obj)
 Removes an object.
void setSelected (IlShort index)
 Sets the graphic object specified by its index as the selected object for this selector.
void setSelected (IlvGraphic *object)
 Sets the specified graphic object as the selected object for this selector.
IlvGraphicwhichGraphicSelected () const
 Returns a pointer to the selected object of this selector.
IlShort whichSelected () const
 Returns the index of the selected object of this selector.
virtual void write (IlvOutputFile &) const
 Writes an object description to a file.

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 IlvClassInfoHasProperty (const IlSymbol *key, IlBoolean p=((IlBoolean) 0))
 Checks for the existence of a property for this object's class hierarchy.
static IlvGraphicread (IlvInputFile &, IlvPalette *pal)
 Reads an object description from a file.
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.

Detailed Description

Graphic class.

Library: views

The IlvSelector class is a special kind of graphic set that handles a unique selection among the objects it holds. This class is a subtype of the IlvGraphicSet class. You must explicitly specify the interactor if you want an interactive behavior. The default interactor name for this object is "Selector".

See also:
IlvSelectorInteractor.

Constructor & Destructor Documentation

IlvSelector::IlvSelector (  ) 

Constructor.

Initializes an empty IlvSelector object. You can call member functions such as insertObject to add IlvGraphic objects to this instance.


Member Function Documentation

static void IlvSelector::AddProperty ( const IlSymbol key,
IlAny  value 
) [static]

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.

Parameters:
key The key to be associated.
value The value to be associated.

Reimplemented from IlvGraphicSet.

const char* IlvSelector::className (  )  const

Returns the class name of an object.

This method is equivalent to getClassInfo()->getClassName().

Returns:
The class name of the object. For example, for an IlvRectangle object, the className function returns "IlvRectangle".

Reimplemented from IlvGraphicSet.

virtual void IlvSelector::computeFocusRegion ( IlvRegion r,
const IlvTransformer t = 0 
) const [virtual]

Computes the region needed for the drawing of the focus.

This method is called to compute the region needed for the drawing of the focus (see the method drawFocus).

Parameters:
r The region that is updated.
t The transformer value. If 0, no transformation is performed.
Returns:
The computed region.

Reimplemented from IlvGraphic.

virtual IlvGraphic* IlvSelector::copy (  )  const [virtual]

Copies this object.

Allocates and returns a copy of this object. If the object is composite, the implementation of this member function makes a copy of the object's components.

Returns:
A copy of the object.
See also:
IlvPredefinedIOMembers.

Reimplemented from IlvGraphicSet.

virtual void IlvSelector::drawFocus ( IlvPort dst,
const IlvPalette palette,
const IlvTransformer t = 0,
const IlvRegion clip = 0 
) const [virtual]

Draws additional drawings for an object that has the keyboard focus.

This method is called to draw additional drawings when the graphic object has the keyboard focus. The default implementation draws a rectangle around the object. The drawing will be done inside the region returned by computeFocusRegion.

Parameters:
dst The destination port.
palette The palette of the object.
t The transformer value. If 0, no transformation is performed.
clip The clipping region.

Reimplemented from IlvGraphic.

virtual IlvClassInfo* IlvSelector::getClassInfo (  )  const [virtual]

Gets class information.

Returns a pointer to the IlvClassInfo object associated with this object's class.

Returns:
A pointer to the class information object of the class of this object.

Reimplemented from IlvGraphicSet.

static IlAny IlvSelector::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.

Parameters:
key The key with which the property value is associated.
checkSuperClass IlTrue specifies iterative search on superclasses.
Returns:
The property value associated with the proper name key, or 0.

Reimplemented from IlvGraphicSet.

static const IlvClassInfo* IlvSelector::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.

Parameters:
key The key with which the property value is associated.
checkSuperClass IlTrue specifies iterative search on superclasses.
Returns:
A pointer to the ClassInfo that indicates a class where the key property exists, or 0.

Reimplemented from IlvGraphicSet.

virtual void IlvSelector::insertObject ( IlvGraphic object  )  [virtual]

Inserts an object.

Inserts an object at the beginning of the maintained list so it will be the first object to be drawn when the IlvGraphicSet object is redrawn.

Parameters:
object The object to be inserted.

Reimplemented from IlvGraphicSet.

IlBoolean IlvSelector::isSelected ( IlvGraphic object  )  const

Returns a Boolean value indicating whether the specified graphic is selected or not.

Parameters:
object The graphic object.
Returns:
A Boolean value indicating whether the specified graphic is selected or not.
See also:
setSelected, whichSelected, whichGraphicSelected.
IlBoolean IlvSelector::isSubtypeOf ( const IlvClassInfo classInfo  )  const

Checks whether this object's class is a subclass.

This method is equivalent to getClassInfo()->isSubtypeOf(classInfo).

Parameters:
classInfo The name of a class on which the object's class is tested.
Returns:
Either IlTrue or IlFalse, depending on whether or not this object's class is a subclass of the class indicated by classInfo.

Reimplemented from IlvGraphicSet.

IlBoolean IlvSelector::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).

Parameters:
parentClass A string representing the parent class.
Returns:
Either 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 IlvGraphicSet.

static IlvGraphic* IlvSelector::read ( IlvInputFile file,
IlvPalette palette 
) [static]

Reads an object description from a file.

Reads an object description from the file input, given the palette graphic attributes. It reads the information that was saved by the member function write to be able to create a new instance of this object. Usually, because of the availability of the constructor that expects an IlvInputFile, read should be equivalent to:

 IlvGraphic*
 MyClass::read(IlvInputFile& file, IlvPalette* palette)
 {
     return new MyClass(file, palette);
 }

In the following example, the static member function read of the IlvLabel class could have the following form:

 IlvGraphic*
 IlvLabel::read(IlvInputFile& file, IlvPalette* pal)
 {
     IlvPoint pos;
     file.getStream() >> pos;     // Read the position field
     return new IlvLabel(pal->getDisplay(), pos,
     IlvReadString(file.getStream()), pal);
 }
Parameters:
file The name of the file to be read from.
palette The name of the palette for the object.
See also:
DeclareTypeInfoRO, DeclareTypeInfo, IlvPredefinedIOMembers.
Warning:
[note] The read method is not capitalized like other static methods so that it is consistent with the write method.

Reimplemented from IlvGraphicSet.

virtual void IlvSelector::removeObject ( IlvGraphic object  )  [virtual]

Removes an object.

Removes an object from the list of referenced objects. If an object is stored more than once in the same IlvGraphicSet, only the first occurrence will be removed. The object is not destroyed.

Parameters:
object The object to be removed from this graphic set.

Reimplemented from IlvGraphicSet.

static IlBoolean IlvSelector::RemoveProperty ( const IlSymbol key  )  [static]

Removes a property from this object's class.

This static function removes the indicated property to the class of this object.

Parameters:
key The key property to be removed.
Returns:
IlTrue if the key property was actually found, or IlFalse otherwise.

Reimplemented from IlvGraphicSet.

static IlBoolean IlvSelector::ReplaceProperty ( const IlSymbol key,
IlAny  value 
) [static]

Replaces a property in this object's class.

This static function replaces the indicated property value to the class of this object.

Parameters:
key The key to be replaced.
value The value to be replaced.
Returns:
IlTrue if the key property was actually found, or IlFalse otherwise.

Reimplemented from IlvGraphicSet.

void IlvSelector::setSelected ( IlShort  index  ) 

Sets the graphic object specified by its index as the selected object for this selector.

If index is not a valid index, this method deselects the selected graphic object of the selector.

Parameters:
index The index of the new selected object.
See also:
whichSelected.
void IlvSelector::setSelected ( IlvGraphic object  ) 

Sets the specified graphic object as the selected object for this selector.

If object is not located in the selector, this method does nothing.

Parameters:
object The new selected object.
See also:
whichSelected.
IlvGraphic* IlvSelector::whichGraphicSelected (  )  const

Returns a pointer to the selected object of this selector.

Returns:
A pointer to the selected object of this selector.
See also:
setSelected, whichSelected.
IlShort IlvSelector::whichSelected (  )  const

Returns the index of the selected object of this selector.

Returns:
The index of the selected object of this selector.
See also:
setSelected, whichGraphicSelected.
virtual void IlvSelector::write ( IlvOutputFile output  )  const [virtual]

Writes an object description to a file.

Writes out, in a file, the object description. This description contains all the information necessary to create an exact copy of this object by means of the member function read. Information concerning any IlvPalette object attached to this object is written out by the object containers. All other information, such as the position and size of the object, is written out by this virtual member function.
For example, suppose we have an IlvLabel class that implements a graphic object drawn as a text string at a given position. It maintains its position in an internal IlvPoint field called _position and its textual content in an internal character array field called _text. The only information we need to save is the contents of those fields. So, the member function write of such an object should have the following form:

 void
 IlvLabel::write(IlvOutputFile& file) const
 {
     // Save the position field
     file.getStream() << IlvSpc() << _position;
     // Save the text field
     IlvWriteString(file.getStream(), _text);
 }
Parameters:
output The the output file to be written to.
See also:
DeclareTypeInfo.

Reimplemented from IlvGraphicSet.


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