Rogue Wave Views
Foundation Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvStylable Class Referenceabstract

Base interface for classes that can be applied a style. More...

#include <ilviews/base/stylable.h>

Inheritance diagram for IlvStylable:
IlvAbstractView IlvGadget IlvScrollView IlvView IlvDrawingView IlvElasticView IlvViewCOMAdapter IlvContainer

Public Member Functions

 IlvStylable ()
 Constructor.
 
virtual void getOuterStylableSize (IlvDim &w, IlvDim &h) const
 Returns the size of the outer stylable if any. More...
 
virtual const char * getStylableClassName () const
 Returns the class name of this object. More...
 
virtual IlvDisplaygetStylableDisplay () const =0
 Returns the display for this object. More...
 
virtual const char * getStylableName () const
 Returns the name of this object. More...
 
virtual const IlvStylablegetStylableParent () const
 Returns the parent of this object in the style hierarchy. More...
 
virtual void getStylableSize (IlvDim &w, IlvDim &h) const
 Returns the size of this object. More...
 
virtual const IlSymbol *const * getStylableTags (IlUInt &nTags) const
 Returns the tags of this object. More...
 
virtual IlvStylistgetStylist () const =0
 Returns the stylist for this object. More...
 

Detailed Description

Base interface for classes that can be applied a style.

Library: xviews or winviews or mviews (mutually exclusive)
Stylable objects are managed, from the style standpoint, by stylists.

See also
IlvStylist, IlvStyleSheet.

Member Function Documentation

§ getOuterStylableSize()

virtual void IlvStylable::getOuterStylableSize ( IlvDim w,
IlvDim h 
) const
virtual

Returns the size of the outer stylable if any.

When a stylable is part of another one, this information allows for instance to compute relative sizes or placement.

If the stylable is not part of another one, this function returns the same results than getStylableSize().

Parameters
wThe width of the container stylable.
hThe height of the container stylable.

Reimplemented in IlvGadget, and IlvAbstractView.

§ getStylableClassName()

virtual const char* IlvStylable::getStylableClassName ( ) const
virtual

Returns the class name of this object.

Returns
The class name of this object.

Reimplemented in IlvGadget, and IlvAbstractView.

§ getStylableDisplay()

virtual IlvDisplay* IlvStylable::getStylableDisplay ( ) const
pure virtual

Returns the display for this object.

Returns
The display instance of this object.

Implemented in IlvGadget, and IlvAbstractView.

§ getStylableName()

virtual const char* IlvStylable::getStylableName ( ) const
virtual

Returns the name of this object.

Returns
The name of this object or 0 if it has none. This name may be used as the identifier discriminant in style sheets.

Reimplemented in IlvView, and IlvGadget.

§ getStylableParent()

virtual const IlvStylable* IlvStylable::getStylableParent ( ) const
virtual

Returns the parent of this object in the style hierarchy.

Returns
The parent stylable if this object has one. The parent is used for inherited style properties.

§ getStylableSize()

virtual void IlvStylable::getStylableSize ( IlvDim w,
IlvDim h 
) const
virtual

Returns the size of this object.

It can be used for computing sizes relative to the object (image position, borders,...).

Parameters
wThe width of the stylable.
hThe height of the stylable.

Reimplemented in IlvGadget, and IlvAbstractView.

§ getStylableTags()

virtual const IlSymbol* const* IlvStylable::getStylableTags ( IlUInt nTags) const
virtual

Returns the tags of this object.

Parameters
nTagsthe number of tags for this object (which is also the size of the returned array).
Returns
An array containing the pointers to all the tags for this object. This array is stored in an IlPoolOf(Pointer) and should not be deleted or modified. If there is no tags on this object, this function returns 0 (and nTags is set to 0)..

Reimplemented in IlvGadget.

§ getStylist()

virtual IlvStylist* IlvStylable::getStylist ( ) const
pure virtual

Returns the stylist for this object.

Returns
The stylist of this object or 0 if there is none.

Implemented in IlvGadget, and IlvAbstractView.


© Copyright 2018, 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.