YImage Class Reference

#include <YImage.h>

Inheritance diagram for YImage:

Collaboration diagram for YImage:

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)
Public Member Functions inherited from YWidget
virtual	~YWidget ()
virtual std::string	debugLabel () const
std::string	helpText () const
void	setHelpText (const std::string &helpText)
virtual const YPropertySet &	propertySet ()
virtual bool	setProperty (const std::string &propertyName, const YPropertyValue &val)
virtual YPropertyValue	getProperty (const std::string &propertyName)
bool	hasChildren () const
YWidget *	firstChild () const
YWidget *	lastChild () const
YWidgetListIterator	childrenBegin () const
YWidgetListIterator	childrenEnd () const
YWidgetListConstIterator	childrenConstBegin () const
YWidgetListConstIterator	childrenConstEnd () const
YWidgetListIterator	begin ()
YWidgetListIterator	end ()
int	childrenCount () const
bool	contains (YWidget *child) const
virtual void	addChild (YWidget *child)
virtual void	removeChild (YWidget *child)
void	deleteChildren ()
YWidget *	parent () const
bool	hasParent () const
void	setParent (YWidget *newParent)
YDialog *	findDialog ()
YWidget *	findWidget (YWidgetID *id, bool doThrow=true) const
virtual int	preferredWidth ()=0
virtual int	preferredHeight ()=0
virtual int	preferredSize (YUIDimension dim)
virtual void	setSize (int newWidth, int newHeight)=0
bool	isValid () const
bool	beingDestroyed () const
void *	widgetRep () const
void	setWidgetRep (void *toolkitWidgetRep)
bool	hasId () const
YWidgetID *	id () const
void	setId (YWidgetID *newId_disown)
virtual void	setEnabled (bool enabled=true)
void	setDisabled ()
virtual bool	isEnabled () const
virtual bool	stretchable (YUIDimension dim) const
void	setStretchable (YUIDimension dim, bool newStretch)
void	setDefaultStretchable (YUIDimension dim, bool newStretch)
virtual int	weight (YUIDimension dim)
bool	hasWeight (YUIDimension dim)
void	setWeight (YUIDimension dim, int weight)
void	setNotify (bool notify=true)
bool	notify () const
void	setNotifyContextMenu (bool notifyContextMenu=true)
bool	notifyContextMenu () const
bool	sendKeyEvents () const
void	setSendKeyEvents (bool doSend)
bool	autoShortcut () const
void	setAutoShortcut (bool _newAutoShortcut)
int	functionKey () const
bool	hasFunctionKey () const
virtual void	setFunctionKey (int fkey_no)
virtual bool	setKeyboardFocus ()
virtual std::string	shortcutString () const
virtual void	setShortcutString (const std::string &str)
virtual const char *	userInputProperty ()
void	dumpWidgetTree (int indentationLevel=0)
void	dumpDialogWidgetTree ()
void	setChildrenEnabled (bool enabled)
virtual void	saveUserInput (YMacroRecorder *macroRecorder)
void *	operator new (size_t size)
void	operator delete (void *ptr) noexcept
virtual void	startMultipleChanges ()
virtual void	doneMultipleChanges ()

Additional Inherited Members
Protected Member Functions inherited from YWidget
	YWidget (YWidget *parent)
YWidgetChildrenManager *	childrenManager () const
void	setChildrenManager (YWidgetChildrenManager *manager)
void	setBeingDestroyed ()
void	dumpWidget (YWidget *w, int indentationLevel)

Detailed Description

A picture, possibly animated, loaded from a file.

Constructor & Destructor Documentation

YImage()

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

Constructor.

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

~YImage()

YImage::~YImage ( )

virtual

Destructor.

Member Function Documentation

animated()

bool YImage::animated

(

)

const

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

autoScale()

bool YImage::autoScale

(

)

const

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

hasZeroSize()

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.

imageFileName()

string YImage::imageFileName

(

)

const

Return the file name of this widget's image.

setAutoScale()

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.

setImage()

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.

setMovie()

void YImage::setMovie ( const std::string & movieFileName )

inline

Set and display a movie (an animated image).

setZeroSize()

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.

widgetClass()

virtual const char * YImage::widgetClass ( ) const

inlinevirtual

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:

• /__w/libyui/libyui/libyui/src/YImage.h
• /__w/libyui/libyui/libyui/src/YImage.cc