Glympse::IImage Struct Reference

Wraps drawable object and provides control over its life cycle. More...

#include <IImage.h>

Inheritance diagram for Glympse::IImage:

Public Member Functions
virtual int32	getState ()=0
	Gets image state. More...
virtual GString	getUrl ()=0
	Gets URI of the image. More...
virtual GDrawable	getDrawable ()=0
	Gets underlying drawable object. More...
virtual bool	load ()=0
	Attempts to start loading drawable. More...
virtual bool	unload ()=0
	Frees underlying drawable object. More...
Public Member Functions inherited from Glympse::IEventSink
virtual bool	addListener (const GEventListener &eventListener)=0
	Registeres event listener on the sink. More...
virtual bool	removeListener (const GEventListener &eventListener)=0
	Unsubscribes listener from events coming from this sink.
virtual GArray< GEventListener > ::ptr	getListeners ()=0
	Provides access to the collection of current listeners. More...
virtual bool	hasContext (int64 key)=0
	Checks, where user context identified by key is already associated with the object.
virtual void	associateContext (int64 key, const GCommonObj &value)=0
	Associates specific context (user data) with the sink. More...
virtual GCommonObj	getContext (int64 key)=0
	Returns context associated with the sink, or NULL, if it is not found.
virtual void	clearContext (int64 key)=0
	Clears context identified by key argument.
virtual GEnumeration< GLong >::ptr	getContextKeys ()=0
	Gets enumeration of all context keys associated with the sink.
virtual void	deriveContext (const GEventSink &sink)=0
	Derives context from another sink object.
Public Member Functions inherited from Glympse::IEventListener
virtual void	eventsOccurred (const GGlympse &glympse, int32 listener, int32 events, const GCommonObj &obj)=0
	This method is invoked each time, when sink object notifies subscriber on an event. More...
Public Member Functions inherited from Glympse::ICommon
virtual int32	retain ()=0
	Add a reference to our object in a COM-like way.
virtual int32	release ()=0
	Release a reference to our object in a COM-like way.
virtual int32	hold ()=0
	Add a reference to our object in a COM-like way.
virtual int32	unhold ()=0
	Release a reference to our object in a COM-like way.
virtual int32	hashCode ()=0
	Returns an integer hash code for this object.
virtual bool	equals (const GCommonObj &o)=0
	Compares this instance with the specified object and indicates if they are equal. More...
virtual GString	toString ()=0
	Returns a string containing a concise, human-readable description of this object. More...
virtual void	attachObject (const GCommon &obj)=0
	Asociates arbitrary object with the instance.
virtual GCommon	extractObject ()=0
	Extracts associated object or NULL if no association is established.

Additional Inherited Members
Protected Member Functions inherited from Glympse::ICommon
virtual	~ICommon ()
	Destructor is protected to deny explicit object deallocation. More...

Detailed Description

Wraps drawable object and provides control over its life cycle.

Member Function Documentation

virtual GDrawable Glympse::IImage::getDrawable ( )

pure virtual

Gets underlying drawable object.

Returns

Drawable object or NULL, if drawable is not loaded or image is not initialized.

virtual int32 Glympse::IImage::getState ( )

pure virtual

Gets image state.

See GC::IMAGE_STATE_* for more details.

virtual GString Glympse::IImage::getUrl ( )

pure virtual

Gets URI of the image.

Returns

Image URI or NULL, if image is not initialized.

virtual bool Glympse::IImage::load ( )

pure virtual

Attempts to start loading drawable.

GE::IMAGE_CHANGED is sent to subscribers, if image loading is succussfully scheduled. The event is spread synchronously before execution is returned to caller.

Returns

true, if loading was scheduled correctly or image is loading or already loaded. false, if image is not properly initialized.

virtual bool Glympse::IImage::unload ( )

pure virtual

Frees underlying drawable object.

Returns

true, if operation completed successfully. failse, if image is currently loading or is not properly initialized.

---

The documentation for this struct was generated from the following file:

• IImage.h