libyui
Public Member Functions

YImage Class Reference

Inheritance diagram for YImage:
YWidget

List of all members.

Public Member Functions

 YImage (YWidget *parent, const string &imageFileName, bool animated=false)
virtual ~YImage ()
virtual const char * widgetClass () const
string imageFileName () const
bool animated () const
virtual void setImage (const string &imageFileName, bool animated=false)
void setMovie (const string &movieFileName)
bool hasZeroSize (YUIDimension dim) const
void setZeroSize (YUIDimension dim, bool zeroSize=true)
bool autoScale () const
virtual void setAutoScale (bool autoScale=true)

Constructor & Destructor Documentation

YImage::YImage ( YWidget parent,
const string &  imageFileName,
bool  animated = false 
)

Constructor.

'animated' indicates if 'imageFileName' is an animated image format (e.g., MNG).

YImage::~YImage ( ) [virtual]

Destructor.


Member Function Documentation

bool YImage::animated ( ) const

Returns 'true' if the current image is an animated image format (e.g., MNG).

bool YImage::autoScale ( ) const

Return 'true' if the image should be scaled to fit into the available space.

bool YImage::hasZeroSize ( YUIDimension  dim) const

Return 'true' if the image widget should be stretchable with a default width of 0 in the specified dimension. This is useful if the widget width is determined by outside constraints, like the width of a neighbouring widget.

string YImage::imageFileName ( ) const

Return the file name of this widget's image.

void YImage::setAutoScale ( bool  autoScale = true) [virtual]

Make the image fit into the available space.

Derived classes should overwrite this, but call this base class function in the new function.

void YImage::setImage ( const string &  imageFileName,
bool  animated = false 
) [virtual]

Set and display a new image (or movie if animated is 'true').

Derived classes should overwrite this, but call this base class function in the new function.

void YImage::setMovie ( const string &  movieFileName) [inline]

Set and display a movie (an animated image).

void YImage::setZeroSize ( YUIDimension  dim,
bool  zeroSize = true 
)

Make the image widget stretchable with a default size of 0 in the specified dimension. This is useful if the widget width is determined by outside constraints, like the width of a neighbouring widget.

This function is intentionally not virtual because it is only relevant during the next geometry update, in which case the derived class has to check this value anyway.

virtual const char* YImage::widgetClass ( ) const [inline, virtual]

Returns a descriptive name of this widget class for logging, debugging etc.

Reimplemented from YWidget.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations Friends