dcpp::gui::IGUIImage Class Reference

GUI element displaying an image. More...

#include <duckcpp/core/engine/IGUIImage.hpp>

Inheritance diagram for dcpp::gui::IGUIImage:

Collaboration diagram for dcpp::gui::IGUIImage:

Public Member Functions
	IGUIImage (IGUIEnvironment *environment, IGUIElement *parent, dcpp::int32_kt id, dcpp::nub::recti rectangle)
	constructor
virtual void	setImage (dcpp::video::ITexture *image)=0
	Sets an image texture.
virtual dcpp::video::ITexture *	getImage () const =0
	Gets the image texture.
virtual void	setColor (dcpp::video::SColor color)=0
	Sets the color of the image.
virtual void	setScaleImage (bool scale)=0
	Sets if the image should scale to fit the element.
virtual void	setUseAlphaChannel (bool use)=0
	Sets if the image should use its alpha channel to draw itself.
virtual dcpp::video::SColor	getColor () const =0
	Gets the color of the image.
virtual bool	isImageScaled () const =0
	Returns true if the image is scaled to fit, false if not.
virtual bool	isAlphaChannelUsed () const =0
	Returns true if the image is using the alpha channel, false if not.
virtual void	setSourceRect (const dcpp::nub::recti &sourceRect)=0
	Sets the source rectangle of the image. By default the full image is used.
virtual dcpp::nub::recti	getSourceRect () const =0
	Returns the customized source rectangle of the image to be used.
virtual void	setDrawBounds (const dcpp::nub::rectf &drawBoundUVs=dcpp::nub::rectf(0.f, 0.f, 1.f, 1.f))=0
	Restrict drawing-area.
virtual dcpp::nub::rectf	getDrawBounds () const =0
	Get drawing-area restrictions.
virtual void	setDrawBackground (bool draw)=0
	Sets whether to draw a background color (EGDC_3D_DARK_SHADOW) when no texture is set.
virtual bool	isDrawBackgroundEnabled () const =0
	Checks if a background is drawn when no texture is set.
Public Member Functions inherited from dcpp::gui::IGUIElement
	IGUIElement (EGUI_ELEMENT_TYPE type, IGUIEnvironment *environment, IGUIElement *parent, dcpp::int32_kt id, const dcpp::nub::recti &rectangle)
	Constructor.
virtual	~IGUIElement ()
	Destructor.
IGUIElement *	getParent () const
	Returns parent of this element.
dcpp::nub::recti	getRelativePosition () const
	Returns the relative rectangle of this element.
void	setRelativePosition (const dcpp::nub::recti &r)
	Sets the relative rectangle of this element.
void	setRelativePosition (const dcpp::nub::position2di &position)
	Sets the relative rectangle of this element, maintaining its current width and height.
void	setRelativePositionProportional (const dcpp::nub::rectf &r)
	Sets the relative rectangle of this element as a proportion of its parent's area.
dcpp::nub::recti	getAbsolutePosition () const
	Gets the absolute rectangle of this element.
dcpp::nub::recti	getAbsoluteClippingRect () const
	Returns the visible area of the element.
void	setNotClipped (bool noClip)
	Sets whether the element will ignore its parent's clipping rectangle.
bool	isNotClipped () const
	Gets whether the element will ignore its parent's clipping rectangle.
void	setMaxSize (dcpp::nub::dimension2du size)
	Sets the maximum size allowed for this element.
void	setMinSize (dcpp::nub::dimension2du size)
	Sets the minimum size allowed for this element.
void	setAlignment (EGUI_ALIGNMENT left, EGUI_ALIGNMENT right, EGUI_ALIGNMENT top, EGUI_ALIGNMENT bottom)
	The alignment defines how the borders of this element will be positioned when the parent element is resized.
EGUI_ALIGNMENT	getAlignLeft () const
	How left element border is aligned when parent is resized.
EGUI_ALIGNMENT	getAlignRight () const
	How right element border is aligned when parent is resized.
EGUI_ALIGNMENT	getAlignTop () const
	How top element border is aligned when parent is resized.
EGUI_ALIGNMENT	getAlignBottom () const
	How bottom element border is aligned when parent is resized.
virtual void	updateAbsolutePosition ()
	Updates the absolute position.
virtual IGUIElement *	getElementFromPoint (const dcpp::nub::position2di &point)
	Returns the topmost GUI element at the specific position.
virtual bool	isPointInside (const dcpp::nub::position2di &point) const
	Returns true if a point is within this element.
virtual void	addChild (IGUIElement *child)
	Adds a GUI element as new child of this element.
virtual void	removeChild (IGUIElement *child)
	Removes a child.
virtual void	remove ()
	Removes this element from its parent.
virtual void	draw ()
	Draws the element and its children.
virtual void	OnPostRender (dcpp::uint32_kt timeMs)
	animate the element and its children.
virtual void	move (dcpp::nub::position2di absoluteMovement)
	Moves this element.
virtual bool	isVisible () const
	Returns true if element is visible.
virtual bool	isTrulyVisible () const
	Check whether the element is truly visible, taking into accounts its parents' visibility.
virtual void	setVisible (bool visible)
	Sets the visible state of this element.
virtual bool	isSubElement () const
	Returns true if this element was created as part of its parent control.
virtual void	setSubElement (bool subElement)
	Sets whether this control was created as part of its parent.
void	setTabStop (bool enable)
	If set to true, the focus will visit this element when using the tab key to cycle through elements.
bool	isTabStop () const
	Returns true if this element can be focused by navigating with the tab key.
void	setTabOrder (dcpp::int32_kt index)
	Sets the priority of focus when using the tab key to navigate between a group of elements.
dcpp::int32_kt	getTabOrder () const
	Returns the number in the tab order sequence.
void	setTabGroup (bool isGroup)
	Sets whether this element is a container for a group of elements which can be navigated using the tab key.
bool	isTabGroup () const
	Returns true if this element is a tab group.
IGUIElement *	getTabGroup ()
	Returns the container element which holds all elements in this element's tab group.
virtual bool	isEnabled () const
	Returns true if element is enabled.
virtual void	setEnabled (bool enabled)
	Sets the enabled state of this element.
virtual void	setText (const wchar_t *text)
	Sets the new caption of this element.
virtual const wchar_t *	getText () const
	Returns caption of this element.
virtual void	setToolTipText (const wchar_t *text)
	Sets the new caption of this element.
virtual const dcpp::nub::wstring &	getToolTipText () const
	Returns caption of this element.
virtual dcpp::int32_kt	getID () const
	Returns id. Can be used to identify the element.
virtual void	setID (dcpp::int32_kt id)
	Sets the id of this element.
virtual bool	OnEvent (const SEvent &event) override
	Called if an event happened.
virtual bool	bringToFront (IGUIElement *element)
	Brings a child to front.
virtual bool	sendToBack (IGUIElement *child)
	Moves a child to the back, so it's siblings are drawn on top of it.
virtual const dcpp::nub::list< IGUIElement * > &	getChildren () const
	Returns list with children of this element.
virtual IGUIElement *	getElementFromId (dcpp::int32_kt id, bool searchchildren=false) const
	Finds the first element with the given id.
bool	isMyChild (IGUIElement *child) const
bool	getNextElement (dcpp::int32_kt startOrder, bool reverse, bool group, IGUIElement *&first, IGUIElement *&closest, bool includeInvisible=false, bool includeDisabled=false) const
	searches elements to find the closest next element to tab to
EGUI_ELEMENT_TYPE	getType () const
	Returns the type of the gui element.
virtual bool	hasType (EGUI_ELEMENT_TYPE type) const
	Returns true if the gui element supports the given type.
virtual const dcpp::char_kt *	getTypeName () const
	Returns the type name of the gui element.
virtual const dcpp::char_kt *	getName () const
	Returns the name of the element.
virtual void	setName (const dcpp::char_kt *name)
	Sets the name of the element.
virtual void	setName (const dcpp::nub::string &name)
	Sets the name of the element.
virtual void	serializeAttributes (dcpp::io::IAttributes *out, dcpp::io::SAttributeReadWriteOptions *options=0) const override
	Writes attributes of the scene node.
virtual void	deserializeAttributes (dcpp::io::IAttributes *in, dcpp::io::SAttributeReadWriteOptions *options=0) override
	Reads attributes of the scene node.
Public Member Functions inherited from dcpp::IReferenceCounted
	IReferenceCounted ()
	Constructor.
virtual	~IReferenceCounted ()
	Destructor.
void	grab () const
	Grabs the object. Increments the reference counter by one.
bool	drop () const
	Drops the object. Decrements the reference counter by one.
dcpp::int32_kt	getReferenceCount () const
	Get the reference count.
const dcpp::char_kt *	getDebugName () const
	Returns the debug name of the object.
Public Member Functions inherited from dcpp::IEventReceiver
virtual	~IEventReceiver ()
	Destructor.

Additional Inherited Members
Protected Member Functions inherited from dcpp::gui::IGUIElement
void	addChildToEnd (IGUIElement *child)
void	recalculateAbsolutePosition (bool recursive)
Protected Member Functions inherited from dcpp::IReferenceCounted
void	setDebugName (const dcpp::char_kt *newName)
	Sets the debug name of the object.
Protected Attributes inherited from dcpp::gui::IGUIElement
dcpp::nub::list< IGUIElement * >	Children
	List of all children of this element.
IGUIElement *	Parent
	Pointer to the parent.
dcpp::nub::recti	RelativeRect
	relative rect of element
dcpp::nub::recti	AbsoluteRect
	absolute rect of element
dcpp::nub::recti	AbsoluteClippingRect
	absolute clipping rect of element
dcpp::nub::recti	DesiredRect
dcpp::nub::recti	LastParentRect
	for calculating the difference when resizing parent
dcpp::nub::rectf	ScaleRect
	relative scale of the element inside its parent
dcpp::nub::dimension2du	MaxSize
	maximum and minimum size of the element
dcpp::nub::dimension2du	MinSize
bool	IsVisible
	is visible?
bool	IsEnabled
	is enabled?
bool	IsSubElement
	is a part of a larger whole and should not be serialized?
bool	NoClip
	does this element ignore its parent's clipping rectangle?
dcpp::nub::wstring	Text
	caption
dcpp::nub::wstring	ToolTipText
	tooltip
dcpp::nub::string	Name
	users can set this for identifying the element by string
dcpp::int32_kt	ID
	users can set this for identifying the element by integer
bool	IsTabStop
	tab stop like in windows
dcpp::int32_kt	TabOrder
	tab order
bool	IsTabGroup
	tab groups are containers like windows, use ctrl+tab to navigate
EGUI_ALIGNMENT	AlignLeft
	tells the element how to act when its parent is resized
EGUI_ALIGNMENT	AlignRight
EGUI_ALIGNMENT	AlignTop
EGUI_ALIGNMENT	AlignBottom
IGUIEnvironment *	Environment
	GUI Environment.
EGUI_ELEMENT_TYPE	Type
	type of element

Detailed Description

GUI element displaying an image.

Member Function Documentation

getSourceRect()

virtual dcpp::nub::recti dcpp::gui::IGUIImage::getSourceRect ( ) const

pure virtual

Returns the customized source rectangle of the image to be used.

By default an empty rectangle of width and height 0 is returned which means the full image is used.

isDrawBackgroundEnabled()

virtual bool dcpp::gui::IGUIImage::isDrawBackgroundEnabled ( ) const

pure virtual

Checks if a background is drawn when no texture is set.

Returns

true if background drawing is enabled, false otherwise

setColor()

virtual void dcpp::gui::IGUIImage::setColor ( dcpp::video::SColor  color )

pure virtual

Sets the color of the image.

Parameters

color

Color with which the image is drawn. If the color equals Color(255,255,255,255) it is ignored.

setDrawBackground()

virtual void dcpp::gui::IGUIImage::setDrawBackground ( bool  draw )

pure virtual

Sets whether to draw a background color (EGDC_3D_DARK_SHADOW) when no texture is set.

By default it's enabled

setDrawBounds()

virtual void dcpp::gui::IGUIImage::setDrawBounds ( const dcpp::nub::rectf &  drawBoundUVs = dcpp::nub::rectf(0.f, 0.f, 1.f, 1.f) )

pure virtual

Restrict drawing-area.

This allows for example to use the image as a progress bar. Base for area is the image, which means:

• The original clipping area when the texture is scaled or there is no texture.
• The source-rect for an unscaled texture (but still restricted afterward by the clipping area) Unlike normal clipping this does not affect the gui-children.

  Parameters

  drawBoundUVs

  Coordinates between 0 and 1 where 0 are for left+top and 1 for right+bottom

setSourceRect()

virtual void dcpp::gui::IGUIImage::setSourceRect ( const dcpp::nub::recti &  sourceRect )

pure virtual

Sets the source rectangle of the image. By default the full image is used.

Parameters

sourceRect

coordinates inside the image or an area with size 0 for using the full image (default).

---

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

• include/duckcpp/core/engine/IGUIImage.hpp