libyui  3.0.10
YImage Class Reference
Inheritance diagram for YImage:
Collaboration diagram for YImage:

List of all members.

Public Member Functions

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

Detailed Description

Definition at line 35 of file YImage.h.


Constructor & Destructor Documentation

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

Constructor.

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

Definition at line 54 of file YImage.cc.

YImage::~YImage ( ) [virtual]

Destructor.

Definition at line 64 of file YImage.cc.


Member Function Documentation

bool YImage::animated ( ) const

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

Definition at line 76 of file YImage.cc.

bool YImage::autoScale ( ) const

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

Definition at line 102 of file YImage.cc.

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.

Definition at line 89 of file YImage.cc.

std::string YImage::imageFileName ( ) const

Return the file name of this widget's image.

Definition at line 70 of file YImage.cc.

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.

Definition at line 108 of file YImage.cc.

Here is the call graph for this function:

void YImage::setImage ( const std::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.

Definition at line 82 of file YImage.cc.

Here is the call graph for this function:

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

Set and display a movie (an animated image).

Definition at line 81 of file YImage.h.

Here is the call graph for this function:

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.

Definition at line 95 of file YImage.cc.

Here is the call graph for this function:

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

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

Reimplemented from YWidget.

Definition at line 57 of file YImage.h.


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