Class EvasObject

Definition

Namespace:

ElmSharp

Assembly:

ElmSharp.dll

The EvasObject is a base class for other widget classes.

[Obsolete("This has been deprecated in API12")]
public abstract class EvasObject

Inheritance

object

EvasObject

Derived

AccessibleObject

AccessibleObject

AnimationView

AnimationView

EvasImage

EvasImage

Polygon

Polygon

Rectangle

Rectangle

MediaView

MediaView

Constructors

EvasObject()

Creates and initializes a new instance of the EvasObject class.

Declaration

[Obsolete("This has been deprecated in API12")]
protected EvasObject()

EvasObject(EvasObject)

Creates and initializes a new instance of the EvasObject class with the parent EvasObject class parameter.

Declaration

[Obsolete("This has been deprecated in API12")]
protected EvasObject(EvasObject parent)

Parameters

Type	Name	Description
EvasObject	parent	Parent EvasObject class.

Properties

AlignmentX

Sets or gets the horizontal alignment hint of an object's alignment.

Declaration

[Obsolete("This has been deprecated in API12")]
public virtual double AlignmentX { get; set; }

Property Value

Type	Description
double

AlignmentY

Sets or gets the vertical alignment hint of an object's alignment.

Declaration

[Obsolete("This has been deprecated in API12")]
public virtual double AlignmentY { get; set; }

Property Value

Type	Description
double

AllEventsFrozen

Sets or gets whether an Evas object is to freeze (discard) events.

Declaration

[Obsolete("This has been deprecated in API12")]
public bool AllEventsFrozen { get; set; }

Property Value

Type	Description
bool

AutomationId

Sets of gets a value that allow the automation framework to find and interact with this object.

Declaration

[Obsolete("This has been deprecated in API12")]
public string AutomationId { get; set; }

Property Value

Type	Description
string

ClassName

Gets the current class's Name.

Declaration

[Obsolete("This has been deprecated in API12")]
public string ClassName { get; }

Property Value

Type	Description
string

Color

Sets or gets the general or main color of the given Evas object.

Declaration

[Obsolete("This has been deprecated in API12")]
public virtual Color Color { get; set; }

Property Value

Type	Description
Color

EvasCanvas

Gets EvasCanvas.

Declaration

[Obsolete("This has been deprecated in API12")]
public EvasCanvas EvasCanvas { get; }

Property Value

Type	Description
EvasCanvas

EvasMap

Sets or gets the current object's transformation map.

Declaration

[Obsolete("This has been deprecated in API12")]
public EvasMap EvasMap { get; set; }

Property Value

Type	Description
EvasMap

Geometry

Sets or gets the position and (rectangular) size of the given Evas object.

Declaration

[Obsolete("This has been deprecated in API12")]
public Rect Geometry { get; set; }

Property Value

Type	Description
Rect

Handle

Sets or gets the handle for EvasObject.

Declaration

[Obsolete("This has been deprecated in API12")]
public IntPtr Handle { get; protected set; }

Property Value

Type	Description
System.IntPtr

IsMapEnabled

Sets or gets the map enabled state.

Declaration

[Obsolete("This has been deprecated in API12")]
public bool IsMapEnabled { get; set; }

Property Value

Type	Description
bool

IsRealized

Gets a widget's status of realized or not.

Declaration

[Obsolete("This has been deprecated in API12")]
public bool IsRealized { get; }

Property Value

Type	Description
bool

IsVisible

Gets the visible state of the given Evas object.

Declaration

[Obsolete("This has been deprecated in API12")]
public bool IsVisible { get; }

Property Value

Type	Description
bool

Layer

Sets or gets the layer of its canvas that the given object will be part of.

Declaration

[Obsolete("This has been deprecated in API12")]
public virtual int Layer { get; set; }

Property Value

Type	Description
int

MinimumHeight

Sets or gets the height hints for an object's minimum size.

Declaration

[Obsolete("This has been deprecated in API12")]
public int MinimumHeight { get; set; }

Property Value

Type	Description
int

MinimumWidth

Sets or gets the width hints for an object's minimum size.

Declaration

[Obsolete("This has been deprecated in API12")]
public int MinimumWidth { get; set; }

Property Value

Type	Description
int

Parent

Gets the parent object for EvasObject.

Declaration

[Obsolete("This has been deprecated in API12")]
public EvasObject Parent { get; }

Property Value

Type	Description
EvasObject

PassEvents

Sets or gets whether an object is set to pass (ignore) events.

Declaration

[Obsolete("This has been deprecated in API12")]
public bool PassEvents { get; set; }

Property Value

Type	Description
bool

PropagateEvents

Sets or gets whether events on a smart object's member should get propagated up to its parent.

Declaration

[Obsolete("This has been deprecated in API12")]
public bool PropagateEvents { get; set; }

Property Value

Type	Description
bool

RealHandle

Sets or gets the real handle for EvasObject.

Declaration

[Obsolete("This has been deprecated in API12")]
public IntPtr RealHandle { get; protected set; }

Property Value

Type	Description
System.IntPtr

RenderOperation

Sets or gets the render operation to be used for rendering the Evas object.

Declaration

[Obsolete("This has been deprecated in API12")]
public RenderOp RenderOperation { get; set; }

Property Value

Type	Description
RenderOp

RepeatEvents

Sets or gets whether an object is to repeat events.

Declaration

[Obsolete("This has been deprecated in API12")]
public bool RepeatEvents { get; set; }

Property Value

Type	Description
bool

TooltipContentDelegate

Sets the content to be shown in the tooltip object.

Declaration

[Obsolete("This has been deprecated in API12")]
public EvasObject.GetTooltipContentDelegate TooltipContentDelegate { get; set; }

Property Value

Type	Description
EvasObject.GetTooltipContentDelegate

TooltipMoveFreezeCount

Gets the movement freeze by 1. This gets the movement freeze count by one.

Declaration

[Obsolete("This has been deprecated in API12")]
public int TooltipMoveFreezeCount { get; }

Property Value

Type	Description
int

TooltipOrientation

Sets or gets the orientation of tooltip.

Declaration

[Obsolete("This has been deprecated in API12")]
public TooltipOrientation TooltipOrientation { get; set; }

Property Value

Type	Description
TooltipOrientation

TooltipStyle

Sets or gets the style for this object tooltip.

Declaration

[Obsolete("This has been deprecated in API12")]
public string TooltipStyle { get; set; }

Property Value

Type	Description
string

TooltipWindowMode

Sets or gets size restriction state of an object's tooltip.

Declaration

[Obsolete("This has been deprecated in API12")]
public bool TooltipWindowMode { get; set; }

Property Value

Type	Description
bool

WeightX

Sets or gets the horizontal pointer hints for an object's weight.

Declaration

[Obsolete("This has been deprecated in API12")]
public double WeightX { get; set; }

Property Value

Type	Description
double

WeightY

Sets or gets the vertical pointer hints for an object's weight.

Declaration

[Obsolete("This has been deprecated in API12")]
public double WeightY { get; set; }

Property Value

Type	Description
double

Methods

Calculate()

Calls the calculate smart function immediately. This will force immediate calculations needed for renderization of this object.

Declaration

[Obsolete("This has been deprecated in API12")]
public void Calculate()

CreateHandle(EvasObject)

Creates a widget handle.

Declaration

[Obsolete("This has been deprecated in API12")]
protected abstract IntPtr CreateHandle(EvasObject parent)

Parameters

Type	Name	Description
EvasObject	parent	Parent EvasObject.

Returns

Type	Description
System.IntPtr	Handle IntPtr.

GetSizeHintAspect(out AspectControl, out int, out int)

Gets the hints for an object's aspect ratio.

Declaration

[Obsolete("This has been deprecated in API12")]
public void GetSizeHintAspect(out AspectControl aspect, out int w, out int h)

Parameters

Type	Name	Description
AspectControl	aspect	The policy or type of aspect ratio to apply to an object.
int	w	The integer to be used as aspect width ratio term.
int	h	The integer to be used as aspect height ratio term.

GetTextBlockGeometryByLineNumber(int, out int, out int, out int, out int)

Gets the geometry of a line number.

Declaration

[Obsolete("GetTextBlockGeometryByLineNumber is obsolete as of version 5.0.0.14299 and is no longer supported.")]
public bool GetTextBlockGeometryByLineNumber(int lineNumber, out int x, out int y, out int w, out int h)

Parameters

Type	Name	Description
int	lineNumber	The line number.
int	x	x coordinate of the line.
int	y	y coordinate of the line.
int	w	w coordinate of the line.
int	h	h coordinate of the line.

Returns

Type	Description
bool	True on success, or False on error.

Hide()

Makes the current object invisible.

Declaration

[Obsolete("This has been deprecated in API12")]
public void Hide()

HideTooltip()

Force hide the tooltip of the object.

Declaration

[Obsolete("This has been deprecated in API12")]
public void HideTooltip()

KeyGrab(string, bool)

Requests the keyname key events to be directed to the current object.

Declaration

[Obsolete("This has been deprecated in API12")]
public bool KeyGrab(string keyname, bool exclusive)

Parameters

Type	Name	Description
string	keyname	The key to request events for.
bool	exclusive	Set TRUE to request that the obj is the only object receiving the keyname events, otherwise set to FALSE.

Returns

Type	Description
bool	If the call succeeds then true, otherwise false.

KeyUngrab(string)

Removes the grab on the keyname key events.

Declaration

[Obsolete("This has been deprecated in API12")]
public void KeyUngrab(string keyname)

Parameters

Type	Name	Description
string	keyname	The key the grab is set for.

Lower()

Lowers the object to the bottom of its layer.

Declaration

[Obsolete("This has been deprecated in API12")]
public void Lower()

MarkChanged()

Marks the smart object as changed.

Declaration

[Obsolete("This has been deprecated in API12")]
public void MarkChanged()

Move(int, int)

Moves the current object to the given location.

Declaration

[Obsolete("This has been deprecated in API12")]
public void Move(int x, int y)

Parameters

Type	Name	Description
int	x	The X position to move the object.
int	y	The Y position to move the object.

OnInstantiated()

The callback of the Instantiated Event.

Declaration

[Obsolete("This has been deprecated in API12")]
protected virtual void OnInstantiated()

OnInvalidate()

The callback of the Invalidate Event.

Declaration

[Obsolete("This has been deprecated in API12")]
protected virtual void OnInvalidate()

OnRealized()

The callback of the Realized Event.

Declaration

[Obsolete("This has been deprecated in API12")]
protected virtual void OnRealized()

OnUnrealize()

The callback of the Unrealize Event.

Declaration

[Obsolete("This has been deprecated in API12")]
protected virtual void OnUnrealize()

PopTooltipMoveFreeze()

This decrements the tooltip freeze count by one.

Declaration

[Obsolete("This has been deprecated in API12")]
public void PopTooltipMoveFreeze()

PushTooltipMoveFreeze()

This increments the tooltip movement freeze count by one. If the count is more than 0, the tooltip position will be fixed.

Declaration

[Obsolete("This has been deprecated in API12")]
public void PushTooltipMoveFreeze()

RaiseTop()

Raises to the top of its layer.

Declaration

[Obsolete("This has been deprecated in API12")]
public void RaiseTop()

Realize(EvasObject)

For this object bind Parent object.Init handle and all kinds of EvasObjectEvent.

Declaration

[Obsolete("This has been deprecated in API12")]
public void Realize(EvasObject parent)

Parameters

Type	Name	Description
EvasObject	parent	Parent object.

Resize(int, int)

Changes the size of the current object.

Declaration

[Obsolete("This has been deprecated in API12")]
public void Resize(int w, int h)

Parameters

Type	Name	Description
int	w	The new width.
int	h	The new height.

SetAlignment(double, double)

Sets the hints for an object's alignment.

Declaration

[Obsolete("This has been deprecated in API12")]
public void SetAlignment(double x, double y)

Parameters

Type	Name	Description
double	x	The horizontal alignment hint as double value ranging from 0.0 to 1.0. The default alignment hint value is 0.5.
double	y	The vertical alignment hint as double value ranging from 0.0 to 1.0. The default alignment hint value is 0.5.

SetClip(EvasObject)

Clips one object to another.

Declaration

[Obsolete("This has been deprecated in API12")]
public void SetClip(EvasObject clip)

Parameters

Type	Name	Description
EvasObject	clip	The object to clip object by.

SetSizeHintAspect(AspectControl, int, int)

Sets the hints for an object's aspect ratio.

Declaration

[Obsolete("This has been deprecated in API12")]
public void SetSizeHintAspect(AspectControl aspect, int w, int h)

Parameters

Type	Name	Description
AspectControl	aspect	The policy or type of aspect ratio to apply to an object.
int	w	The integer to be used as aspect width ratio term.
int	h	The integer to be used as aspect height ratio term.

SetTooltipText(string)

Sets the text for an object's tooltip.

Declaration

[Obsolete("This has been deprecated in API12")]
public void SetTooltipText(string text)

Parameters

Type	Name	Description
string	text	The text value to display inside the tooltip.

SetWeight(double, double)

Sets the hints for an object's weight.

Declaration

[Obsolete("This has been deprecated in API12")]
public void SetWeight(double x, double y)

Parameters

Type	Name	Description
double	x	The non-negative double value to be used as horizontal weight hint.
double	y	The non-negative double value to be used as vertical weight hint.

Show()

Makes the current object visible.

Declaration

[Obsolete("This has been deprecated in API12")]
public void Show()

ShowTooltip()

Force show the tooltip of the object.

Declaration

[Obsolete("This has been deprecated in API12")]
public void ShowTooltip()

StackAbove(EvasObject)

Stacks immediately above anchor.

Declaration

[Obsolete("This has been deprecated in API12")]
public void StackAbove(EvasObject anchor)

Parameters

Type	Name	Description
EvasObject	anchor	The object above which to stack.

StackBelow(EvasObject)

Stacks immediately below anchor.

Declaration

[Obsolete("This has been deprecated in API12")]
public void StackBelow(EvasObject anchor)

Parameters

Type	Name	Description
EvasObject	anchor	The object below which to stack.

Unrealize()

Removes the current object relationship with others.

Declaration

[Obsolete("This has been deprecated in API12")]
public void Unrealize()

UnsetTooltip()

Unsets an object's tooltip.

Declaration

[Obsolete("This has been deprecated in API12")]
public void UnsetTooltip()

Events

BackButtonPressed

BackButtonPressed will be triggered when the Back button is pressed.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler BackButtonPressed

Event Type

Type	Description
System.EventHandler

Deleted

Deleted will be triggered when the widght is deleted.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler Deleted

Event Type

Type	Description
System.EventHandler

Hidden

Hidden will be triggered when the widget is hidden.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler Hidden

Event Type

Type	Description
System.EventHandler

KeyDown

KeyDown will be triggered when the key is pressed down.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler<EvasKeyEventArgs> KeyDown

Event Type

Type	Description
System.EventHandler<TEventArgs><EvasKeyEventArgs>

KeyUp

KeyUp will be triggered when the key is loose.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler<EvasKeyEventArgs> KeyUp

Event Type

Type	Description
System.EventHandler<TEventArgs><EvasKeyEventArgs>

MoreButtonPressed

MoreButtonPressed will be triggered when the More button is pressed.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler MoreButtonPressed

Event Type

Type	Description
System.EventHandler

Moved

Moved will be triggered when the widght is moved.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler Moved

Event Type

Type	Description
System.EventHandler

RenderPost

RenderPost Event Handler of the current widget.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler RenderPost

Event Type

Type	Description
System.EventHandler

Resized

Resized Event Handler of the current widget's size.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler Resized

Event Type

Type	Description
System.EventHandler

Shown

Shown will be triggered when the widget is shown.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler Shown

Event Type

Type	Description
System.EventHandler

Operators

explicit operator EvasObject(IntPtr)

Define cast to EvasObject operator from IntPtr

Declaration

[Obsolete("This has been deprecated in API12")]
public static explicit operator EvasObject(IntPtr handle)

Parameters

Type	Name	Description
System.IntPtr	handle	Native handle to EvasObject

Returns

Type	Description
EvasObject

implicit operator IntPtr(EvasObject)

Define the IntPtr operator.

Declaration

[Obsolete("This has been deprecated in API12")]
public static implicit operator IntPtr(EvasObject obj)

Parameters

Type	Name	Description
EvasObject	obj	Parent object.

Returns

Type	Description
System.IntPtr

Extension Methods

RotaryEventExtensions.Activate(EvasObject)

RotaryEventExtensions.AddRotaryEventHandler(EvasObject, RotaryEventHandler)

RotaryEventExtensions.Deactivate(EvasObject)

RotaryEventExtensions.RemoveRotaryEventHandler(EvasObject, RotaryEventHandler)