Class EvasObject

Definition

Namespace:
ElmSharp
Assembly:
ElmSharp.dll
API Level:
preview

The EvasObject is a base class for other widget classes.

C#
Copy
public abstract class EvasObject
Inheritance
System.Object
EvasObject
Derived

Constructors

View Source

EvasObject()

Creates and initializes a new instance of the EvasObject class.

Declaration
C#
Copy
protected EvasObject()
API Level: preview
View Source

EvasObject(EvasObject)

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

Declaration
C#
Copy
protected EvasObject(EvasObject parent)
Parameters
Type Name Description
EvasObject parent

Parent EvasObject class.

API Level: preview

Properties

View Source

AlignmentX

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

Declaration
C#
Copy
public virtual double AlignmentX { get; set; }
Property Value
Type Description
System.Double
API Level: preview
View Source

AlignmentY

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

Declaration
C#
Copy
public virtual double AlignmentY { get; set; }
Property Value
Type Description
System.Double
API Level: preview
View Source

AllEventsFrozen

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

Declaration
C#
Copy
public bool AllEventsFrozen { get; set; }
Property Value
Type Description
Boolean
API Level: preview
View Source

AutomationId

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

Declaration
C#
Copy
public string AutomationId { get; set; }
Property Value
Type Description
System.String
API Level: preview
View Source

ClassName

Gets the current class's Name.

Declaration
C#
Copy
public string ClassName { get; }
Property Value
Type Description
System.String
API Level: preview
View Source

Color

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

Declaration
C#
Copy
public virtual Color Color { get; set; }
Property Value
Type Description
Color
API Level: preview
View Source

EvasCanvas

Gets EvasCanvas.

Declaration
C#
Copy
public EvasCanvas EvasCanvas { get; }
Property Value
Type Description
EvasCanvas
API Level: preview
View Source

EvasMap

Sets or gets the current object's transformation map.

Declaration
C#
Copy
public EvasMap EvasMap { get; set; }
Property Value
Type Description
EvasMap
API Level: preview
View Source

Geometry

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

Declaration
C#
Copy
public Rect Geometry { get; set; }
Property Value
Type Description
Rect
API Level: preview
View Source

Handle

Sets or gets the handle for EvasObject.

Declaration
C#
Copy
public IntPtr Handle { get; protected set; }
Property Value
Type Description
System.IntPtr
API Level: preview
View Source

IsMapEnabled

Sets or gets the map enabled state.

Declaration
C#
Copy
public bool IsMapEnabled { get; set; }
Property Value
Type Description
Boolean
API Level: preview
View Source

IsRealized

Gets a widget's status of realized or not.

Declaration
C#
Copy
public bool IsRealized { get; }
Property Value
Type Description
Boolean
API Level: preview
View Source

IsVisible

Gets the visible state of the given Evas object.

Declaration
C#
Copy
public bool IsVisible { get; }
Property Value
Type Description
Boolean
API Level: preview
View Source

Layer

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

Declaration
C#
Copy
public virtual int Layer { get; set; }
Property Value
Type Description
Int32
API Level: preview
View Source

MinimumHeight

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

Declaration
C#
Copy
public int MinimumHeight { get; set; }
Property Value
Type Description
Int32
API Level: preview
View Source

MinimumWidth

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

Declaration
C#
Copy
public int MinimumWidth { get; set; }
Property Value
Type Description
Int32
API Level: preview
View Source

Parent

Gets the parent object for EvasObject.

Declaration
C#
Copy
public EvasObject Parent { get; }
Property Value
Type Description
EvasObject
API Level: preview
View Source

PassEvents

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

Declaration
C#
Copy
public bool PassEvents { get; set; }
Property Value
Type Description
Boolean
API Level: preview
View Source

PropagateEvents

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

Declaration
C#
Copy
public bool PropagateEvents { get; set; }
Property Value
Type Description
Boolean
API Level: preview
View Source

RealHandle

Sets or gets the real handle for EvasObject.

Declaration
C#
Copy
public IntPtr RealHandle { get; protected set; }
Property Value
Type Description
System.IntPtr
API Level: preview
View Source

RenderOperation

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

Declaration
C#
Copy
public RenderOp RenderOperation { get; set; }
Property Value
Type Description
RenderOp
API Level: 5
View Source

RepeatEvents

Sets or gets whether an object is to repeat events.

Declaration
C#
Copy
public bool RepeatEvents { get; set; }
Property Value
Type Description
Boolean
API Level: preview
View Source

TooltipContentDelegate

Sets the content to be shown in the tooltip object.

Declaration
C#
Copy
public EvasObject.GetTooltipContentDelegate TooltipContentDelegate { get; set; }
Property Value
Type Description
EvasObject.GetTooltipContentDelegate
API Level: preview
View Source

TooltipMoveFreezeCount

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

Declaration
C#
Copy
public int TooltipMoveFreezeCount { get; }
Property Value
Type Description
Int32
API Level: preview
View Source

TooltipOrientation

Sets or gets the orientation of tooltip.

Declaration
C#
Copy
public TooltipOrientation TooltipOrientation { get; set; }
Property Value
Type Description
TooltipOrientation
API Level: preview
View Source

TooltipStyle

Sets or gets the style for this object tooltip.

Declaration
C#
Copy
public string TooltipStyle { get; set; }
Property Value
Type Description
System.String
API Level: preview
View Source

TooltipWindowMode

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

Declaration
C#
Copy
public bool TooltipWindowMode { get; set; }
Property Value
Type Description
Boolean
API Level: preview
View Source

WeightX

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

Declaration
C#
Copy
public double WeightX { get; set; }
Property Value
Type Description
System.Double
API Level: preview
View Source

WeightY

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

Declaration
C#
Copy
public double WeightY { get; set; }
Property Value
Type Description
System.Double
API Level: preview

Methods

View Source

Calculate()

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

Declaration
C#
Copy
public void Calculate()
API Level: preview
View Source

CreateHandle(EvasObject)

Creates a widget handle.

Declaration
C#
Copy
protected abstract IntPtr CreateHandle(EvasObject parent)
Parameters
Type Name Description
EvasObject parent

Parent EvasObject.

Returns
Type Description
System.IntPtr

Handle IntPtr.

API Level: preview
View Source

GetSizeHintAspect(out AspectControl, out Int32, out Int32)

Gets the hints for an object's aspect ratio.

Declaration
C#
Copy
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.

Int32 w

The integer to be used as aspect width ratio term.

Int32 h

The integer to be used as aspect height ratio term.

API Level: preview
View Source

GetTextBlockGeometryByLineNumber(Int32, out Int32, out Int32, out Int32, out Int32)

Gets the geometry of a line number.

Declaration
C#
Copy
[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
Int32 lineNumber

The line number.

Int32 x

x coordinate of the line.

Int32 y

y coordinate of the line.

Int32 w

w coordinate of the line.

Int32 h

h coordinate of the line.

Returns
Type Description
Boolean

True on success, or False on error.

API Level: preview
View Source

Hide()

Makes the current object invisible.

Declaration
C#
Copy
public void Hide()
API Level: preview
View Source

HideTooltip()

Force hide the tooltip of the object.

Declaration
C#
Copy
public void HideTooltip()
API Level: preview
View Source

KeyGrab(String, Boolean)

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

Declaration
C#
Copy
public bool KeyGrab(string keyname, bool exclusive)
Parameters
Type Name Description
System.String keyname

The key to request events for.

Boolean exclusive

Set TRUE to request that the obj is the only object receiving the keyname events, otherwise set to FALSE.

Returns
Type Description
Boolean

If the call succeeds then true, otherwise false.

API Level: preview
View Source

KeyUngrab(String)

Removes the grab on the keyname key events.

Declaration
C#
Copy
public void KeyUngrab(string keyname)
Parameters
Type Name Description
System.String keyname

The key the grab is set for.

API Level: preview
View Source

Lower()

Lowers the object to the bottom of its layer.

Declaration
C#
Copy
public void Lower()
API Level: preview
View Source

MarkChanged()

Marks the smart object as changed.

Declaration
C#
Copy
public void MarkChanged()
API Level: preview
View Source

Move(Int32, Int32)

Moves the current object to the given location.

Declaration
C#
Copy
public void Move(int x, int y)
Parameters
Type Name Description
Int32 x

The X position to move the object.

Int32 y

The Y position to move the object.

API Level: preview
View Source

OnInstantiated()

The callback of the Instantiated Event.

Declaration
C#
Copy
protected virtual void OnInstantiated()
API Level: preview
View Source

OnInvalidate()

The callback of the Invalidate Event.

Declaration
C#
Copy
protected virtual void OnInvalidate()
API Level: preview
View Source

OnRealized()

The callback of the Realized Event.

Declaration
C#
Copy
protected virtual void OnRealized()
API Level: preview
View Source

OnUnrealize()

The callback of the Unrealize Event.

Declaration
C#
Copy
protected virtual void OnUnrealize()
API Level: preview
View Source

PopTooltipMoveFreeze()

This decrements the tooltip freeze count by one.

Declaration
C#
Copy
public void PopTooltipMoveFreeze()
API Level: preview
View Source

PushTooltipMoveFreeze()

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

Declaration
C#
Copy
public void PushTooltipMoveFreeze()
API Level: preview
View Source

RaiseTop()

Raises to the top of its layer.

Declaration
C#
Copy
public void RaiseTop()
API Level: preview
View Source

Realize(EvasObject)

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

Declaration
C#
Copy
public void Realize(EvasObject parent)
Parameters
Type Name Description
EvasObject parent

Parent object.

API Level: preview
View Source

Resize(Int32, Int32)

Changes the size of the current object.

Declaration
C#
Copy
public void Resize(int w, int h)
Parameters
Type Name Description
Int32 w

The new width.

Int32 h

The new height.

API Level: preview
View Source

SetAlignment(Double, Double)

Sets the hints for an object's alignment.

Declaration
C#
Copy
public void SetAlignment(double x, double y)
Parameters
Type Name Description
System.Double x

The horizontal alignment hint as double value ranging from 0.0 to 1.0. The default alignment hint value is 0.5.

System.Double y

The vertical alignment hint as double value ranging from 0.0 to 1.0. The default alignment hint value is 0.5.

API Level: preview
View Source

SetClip(EvasObject)

Clips one object to another.

Declaration
C#
Copy
public void SetClip(EvasObject clip)
Parameters
Type Name Description
EvasObject clip

The object to clip object by.

API Level: preview
View Source

SetSizeHintAspect(AspectControl, Int32, Int32)

Sets the hints for an object's aspect ratio.

Declaration
C#
Copy
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.

Int32 w

The integer to be used as aspect width ratio term.

Int32 h

The integer to be used as aspect height ratio term.

API Level: preview
View Source

SetTooltipText(String)

Sets the text for an object's tooltip.

Declaration
C#
Copy
public void SetTooltipText(string text)
Parameters
Type Name Description
System.String text

The text value to display inside the tooltip.

API Level: preview
View Source

SetWeight(Double, Double)

Sets the hints for an object's weight.

Declaration
C#
Copy
public void SetWeight(double x, double y)
Parameters
Type Name Description
System.Double x

The non-negative double value to be used as horizontal weight hint.

System.Double y

The non-negative double value to be used as vertical weight hint.

API Level: preview
View Source

Show()

Makes the current object visible.

Declaration
C#
Copy
public void Show()
API Level: preview
View Source

ShowTooltip()

Force show the tooltip of the object.

Declaration
C#
Copy
public void ShowTooltip()
API Level: preview
View Source

StackAbove(EvasObject)

Stacks immediately above anchor.

Declaration
C#
Copy
public void StackAbove(EvasObject anchor)
Parameters
Type Name Description
EvasObject anchor

The object above which to stack.

API Level: preview
View Source

StackBelow(EvasObject)

Stacks immediately below anchor.

Declaration
C#
Copy
public void StackBelow(EvasObject anchor)
Parameters
Type Name Description
EvasObject anchor

The object below which to stack.

API Level: preview
View Source

Unrealize()

Removes the current object relationship with others.

Declaration
C#
Copy
public void Unrealize()
API Level: preview
View Source

UnsetTooltip()

Unsets an object's tooltip.

Declaration
C#
Copy
public void UnsetTooltip()
API Level: preview

Events

View Source

BackButtonPressed

BackButtonPressed will be triggered when the Back button is pressed.

Declaration
C#
Copy
public event EventHandler BackButtonPressed
Event Type
Type Description
System.EventHandler
API Level: preview
View Source

Deleted

Deleted will be triggered when the widght is deleted.

Declaration
C#
Copy
public event EventHandler Deleted
Event Type
Type Description
System.EventHandler
API Level: preview
View Source

Hidden

Hidden will be triggered when the widget is hidden.

Declaration
C#
Copy
public event EventHandler Hidden
Event Type
Type Description
System.EventHandler
API Level: preview
View Source

KeyDown

KeyDown will be triggered when the key is pressed down.

Declaration
C#
Copy
public event EventHandler<EvasKeyEventArgs> KeyDown
Event Type
Type Description
System.EventHandler<EvasKeyEventArgs>
API Level: preview
View Source

KeyUp

KeyUp will be triggered when the key is loose.

Declaration
C#
Copy
public event EventHandler<EvasKeyEventArgs> KeyUp
Event Type
Type Description
System.EventHandler<EvasKeyEventArgs>
API Level: preview
View Source

MoreButtonPressed

MoreButtonPressed will be triggered when the More button is pressed.

Declaration
C#
Copy
public event EventHandler MoreButtonPressed
Event Type
Type Description
System.EventHandler
API Level: preview
View Source

Moved

Moved will be triggered when the widght is moved.

Declaration
C#
Copy
public event EventHandler Moved
Event Type
Type Description
System.EventHandler
API Level: preview
View Source

RenderPost

RenderPost Event Handler of the current widget.

Declaration
C#
Copy
public event EventHandler RenderPost
Event Type
Type Description
System.EventHandler
API Level: preview
View Source

Resized

Resized Event Handler of the current widget's size.

Declaration
C#
Copy
public event EventHandler Resized
Event Type
Type Description
System.EventHandler
API Level: preview
View Source

Shown

Shown will be triggered when the widget is shown.

Declaration
C#
Copy
public event EventHandler Shown
Event Type
Type Description
System.EventHandler
API Level: preview

Operators

View Source

Explicit(IntPtr to EvasObject)

Define cast to EvasObject operator from IntPtr

Declaration
C#
Copy
public static explicit operator EvasObject(IntPtr handle)
Parameters
Type Name Description
System.IntPtr handle

Native handle to EvasObject

Returns
Type Description
EvasObject
API Level: preview
View Source

Implicit(EvasObject to IntPtr)

Define the IntPtr operator.

Declaration
C#
Copy
public static implicit operator IntPtr(EvasObject obj)
Parameters
Type Name Description
EvasObject obj

Parent object.

Returns
Type Description
System.IntPtr
API Level: preview

Extension Methods