Class EvasObject
The EvasObject is a base class for other widget classes.
Inheritance
Inherited Members
Namespace: ElmSharp
Assembly: ElmSharp.dll
Syntax
public abstract class EvasObject
Constructors
EvasObject()
Creates and initializes a new instance of the EvasObject class.
Declaration
protected EvasObject()
API Version
previewEvasObject(EvasObject)
Creates and initializes a new instance of the EvasObject class with the parent EvasObject class parameter.
Declaration
protected EvasObject(EvasObject parent)
Parameters
Type | Name | Description |
---|---|---|
EvasObject | parent | Parent EvasObject class. |
API Version
previewProperties
AlignmentX
Sets or gets the horizontal alignment hint of an object's alignment.
Declaration
public virtual double AlignmentX { get; set; }
Property Value
Type | Description |
---|---|
Double |
API Version
previewAlignmentY
Sets or gets the vertical alignment hint of an object's alignment.
Declaration
public virtual double AlignmentY { get; set; }
Property Value
Type | Description |
---|---|
Double |
API Version
previewAllEventsFrozen
Sets or gets whether an Evas object is to freeze (discard) events.
Declaration
public bool AllEventsFrozen { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
API Version
previewAutomationId
Sets of gets a value that allow the automation framework to find and interact with this object.
Declaration
public string AutomationId { get; set; }
Property Value
Type | Description |
---|---|
String |
API Version
previewClassName
Gets the current class's Name.
Declaration
public string ClassName { get; }
Property Value
Type | Description |
---|---|
String |
API Version
previewColor
Sets or gets the general or main color of the given Evas object.
Declaration
public virtual Color Color { get; set; }
Property Value
Type | Description |
---|---|
Color |
API Version
previewEvasCanvas
Gets EvasCanvas.
Declaration
public EvasCanvas EvasCanvas { get; }
Property Value
Type | Description |
---|---|
EvasCanvas |
API Version
previewEvasMap
Sets or gets the current object's transformation map.
Declaration
public EvasMap EvasMap { get; set; }
Property Value
Type | Description |
---|---|
EvasMap |
API Version
previewGeometry
Sets or gets the position and (rectangular) size of the given Evas object.
Declaration
public Rect Geometry { get; set; }
Property Value
Type | Description |
---|---|
Rect |
API Version
previewHandle
Sets or gets the handle for EvasObject.
Declaration
public IntPtr Handle { get; protected set; }
Property Value
Type | Description |
---|---|
IntPtr |
API Version
previewIsMapEnabled
Sets or gets the map enabled state.
Declaration
public bool IsMapEnabled { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
API Version
previewIsRealized
Gets a widget's status of realized or not.
Declaration
public bool IsRealized { get; }
Property Value
Type | Description |
---|---|
Boolean |
API Version
previewIsVisible
Gets the visible state of the given Evas object.
Declaration
public bool IsVisible { get; }
Property Value
Type | Description |
---|---|
Boolean |
API Version
previewLayer
Sets or gets the layer of its canvas that the given object will be part of.
Declaration
public virtual int Layer { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
API Version
previewMinimumHeight
Sets or gets the height hints for an object's minimum size.
Declaration
public int MinimumHeight { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
API Version
previewMinimumWidth
Sets or gets the width hints for an object's minimum size.
Declaration
public int MinimumWidth { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
API Version
previewParent
Gets the parent object for EvasObject.
Declaration
public EvasObject Parent { get; }
Property Value
Type | Description |
---|---|
EvasObject |
API Version
previewPassEvents
Sets or gets whether an object is set to pass (ignore) events.
Declaration
public bool PassEvents { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
API Version
previewPropagateEvents
Sets or gets whether events on a smart object's member should get propagated up to its parent.
Declaration
public bool PropagateEvents { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
API Version
previewRealHandle
Sets or gets the real handle for EvasObject.
Declaration
public IntPtr RealHandle { get; protected set; }
Property Value
Type | Description |
---|---|
IntPtr |
API Version
previewRenderOperation
Sets or gets the render operation to be used for rendering the Evas object.
Declaration
public RenderOp RenderOperation { get; set; }
Property Value
Type | Description |
---|---|
RenderOp |
API Version
5RepeatEvents
Sets or gets whether an object is to repeat events.
Declaration
public bool RepeatEvents { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
API Version
previewTooltipContentDelegate
Sets the content to be shown in the tooltip object.
Declaration
public EvasObject.GetTooltipContentDelegate TooltipContentDelegate { get; set; }
Property Value
Type | Description |
---|---|
EvasObject.GetTooltipContentDelegate |
API Version
previewTooltipMoveFreezeCount
Gets the movement freeze by 1. This gets the movement freeze count by one.
Declaration
public int TooltipMoveFreezeCount { get; }
Property Value
Type | Description |
---|---|
Int32 |
API Version
previewTooltipOrientation
Sets or gets the orientation of tooltip.
Declaration
public TooltipOrientation TooltipOrientation { get; set; }
Property Value
Type | Description |
---|---|
TooltipOrientation |
API Version
previewTooltipStyle
Sets or gets the style for this object tooltip.
Declaration
public string TooltipStyle { get; set; }
Property Value
Type | Description |
---|---|
String |
API Version
previewTooltipWindowMode
Sets or gets size restriction state of an object's tooltip.
Declaration
public bool TooltipWindowMode { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
API Version
previewWeightX
Sets or gets the horizontal pointer hints for an object's weight.
Declaration
public double WeightX { get; set; }
Property Value
Type | Description |
---|---|
Double |
API Version
previewWeightY
Sets or gets the vertical pointer hints for an object's weight.
Declaration
public double WeightY { get; set; }
Property Value
Type | Description |
---|---|
Double |
API Version
previewMethods
Calculate()
Calls the calculate smart function immediately. This will force immediate calculations needed for renderization of this object.
Declaration
public void Calculate()
API Version
previewCreateHandle(EvasObject)
Creates a widget handle.
Declaration
protected abstract IntPtr CreateHandle(EvasObject parent)
Parameters
Type | Name | Description |
---|---|---|
EvasObject | parent | Parent EvasObject. |
Returns
Type | Description |
---|---|
IntPtr | Handle IntPtr. |
API Version
previewGetSizeHintAspect(out AspectControl, out Int32, out Int32)
Gets the hints for an object's aspect ratio.
Declaration
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 Version
previewGetTextBlockGeometryByLineNumber(Int32, out Int32, out Int32, out Int32, out Int32)
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 |
---|---|---|
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 Version
previewHide()
Makes the current object invisible.
Declaration
public void Hide()
API Version
previewHideTooltip()
Force hide the tooltip of the object.
Declaration
public void HideTooltip()
API Version
previewKeyGrab(String, Boolean)
Requests the keyname key events to be directed to the current object.
Declaration
public bool KeyGrab(string keyname, bool exclusive)
Parameters
Type | Name | Description |
---|---|---|
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 Version
previewKeyUngrab(String)
Removes the grab on the keyname key events.
Declaration
public void KeyUngrab(string keyname)
Parameters
Type | Name | Description |
---|---|---|
String | keyname | The key the grab is set for. |
API Version
previewLower()
Lowers the object to the bottom of its layer.
Declaration
public void Lower()
API Version
previewMarkChanged()
Marks the smart object as changed.
Declaration
public void MarkChanged()
API Version
previewMove(Int32, Int32)
Moves the current object to the given location.
Declaration
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 Version
previewOnInstantiated()
The callback of the Instantiated Event.
Declaration
protected virtual void OnInstantiated()
API Version
previewOnInvalidate()
The callback of the Invalidate Event.
Declaration
protected virtual void OnInvalidate()
API Version
previewOnRealized()
The callback of the Realized Event.
Declaration
protected virtual void OnRealized()
API Version
previewOnUnrealize()
The callback of the Unrealize Event.
Declaration
protected virtual void OnUnrealize()
API Version
previewPopTooltipMoveFreeze()
This decrements the tooltip freeze count by one.
Declaration
public void PopTooltipMoveFreeze()
API Version
previewPushTooltipMoveFreeze()
This increments the tooltip movement freeze count by one. If the count is more than 0, the tooltip position will be fixed.
Declaration
public void PushTooltipMoveFreeze()
API Version
previewRaiseTop()
Raises to the top of its layer.
Declaration
public void RaiseTop()
API Version
previewRealize(EvasObject)
For this object bind Parent object.Init handle and all kinds of EvasObjectEvent.
Declaration
public void Realize(EvasObject parent)
Parameters
Type | Name | Description |
---|---|---|
EvasObject | parent | Parent object. |
API Version
previewResize(Int32, Int32)
Changes the size of the current object.
Declaration
public void Resize(int w, int h)
Parameters
Type | Name | Description |
---|---|---|
Int32 | w | The new width. |
Int32 | h | The new height. |
API Version
previewSetAlignment(Double, Double)
Sets the hints for an object's alignment.
Declaration
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. |
API Version
previewSetClip(EvasObject)
Clips one object to another.
Declaration
public void SetClip(EvasObject clip)
Parameters
Type | Name | Description |
---|---|---|
EvasObject | clip | The object to clip object by. |
API Version
previewSetSizeHintAspect(AspectControl, Int32, Int32)
Sets the hints for an object's aspect ratio.
Declaration
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 Version
previewSetTooltipText(String)
Sets the text for an object's tooltip.
Declaration
public void SetTooltipText(string text)
Parameters
Type | Name | Description |
---|---|---|
String | text | The text value to display inside the tooltip. |
API Version
previewSetWeight(Double, Double)
Sets the hints for an object's weight.
Declaration
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. |
API Version
previewShow()
Makes the current object visible.
Declaration
public void Show()
API Version
previewShowTooltip()
Force show the tooltip of the object.
Declaration
public void ShowTooltip()
API Version
previewStackAbove(EvasObject)
Stacks immediately above anchor.
Declaration
public void StackAbove(EvasObject anchor)
Parameters
Type | Name | Description |
---|---|---|
EvasObject | anchor | The object above which to stack. |
API Version
previewStackBelow(EvasObject)
Stacks immediately below anchor.
Declaration
public void StackBelow(EvasObject anchor)
Parameters
Type | Name | Description |
---|---|---|
EvasObject | anchor | The object below which to stack. |
API Version
previewUnrealize()
Removes the current object relationship with others.
Declaration
public void Unrealize()
API Version
previewUnsetTooltip()
Unsets an object's tooltip.
Declaration
public void UnsetTooltip()
API Version
previewEvents
BackButtonPressed
BackButtonPressed will be triggered when the Back button is pressed.
Declaration
public event EventHandler BackButtonPressed
Event Type
Type | Description |
---|---|
EventHandler |
API Version
previewDeleted
Deleted will be triggered when the widght is deleted.
Declaration
public event EventHandler Deleted
Event Type
Type | Description |
---|---|
EventHandler |
API Version
previewHidden
Hidden will be triggered when the widget is hidden.
Declaration
public event EventHandler Hidden
Event Type
Type | Description |
---|---|
EventHandler |
API Version
previewKeyDown
KeyDown will be triggered when the key is pressed down.
Declaration
public event EventHandler<EvasKeyEventArgs> KeyDown
Event Type
Type | Description |
---|---|
EventHandler<EvasKeyEventArgs> |
API Version
previewKeyUp
KeyUp will be triggered when the key is loose.
Declaration
public event EventHandler<EvasKeyEventArgs> KeyUp
Event Type
Type | Description |
---|---|
EventHandler<EvasKeyEventArgs> |
API Version
previewMoreButtonPressed
MoreButtonPressed will be triggered when the More button is pressed.
Declaration
public event EventHandler MoreButtonPressed
Event Type
Type | Description |
---|---|
EventHandler |
API Version
previewMoved
Moved will be triggered when the widght is moved.
Declaration
public event EventHandler Moved
Event Type
Type | Description |
---|---|
EventHandler |
API Version
previewRenderPost
RenderPost Event Handler of the current widget.
Declaration
public event EventHandler RenderPost
Event Type
Type | Description |
---|---|
EventHandler |
API Version
previewResized
Resized Event Handler of the current widget's size.
Declaration
public event EventHandler Resized
Event Type
Type | Description |
---|---|
EventHandler |
API Version
previewShown
Shown will be triggered when the widget is shown.
Declaration
public event EventHandler Shown
Event Type
Type | Description |
---|---|
EventHandler |
API Version
previewOperators
Explicit(IntPtr to EvasObject)
Define cast to EvasObject operator from IntPtr
Declaration
public static explicit operator EvasObject(IntPtr handle)
Parameters
Type | Name | Description |
---|---|---|
IntPtr | handle | Native handle to EvasObject |
Returns
Type | Description |
---|---|
EvasObject |
API Version
previewImplicit(EvasObject to IntPtr)
Define the IntPtr operator.
Declaration
public static implicit operator IntPtr(EvasObject obj)
Parameters
Type | Name | Description |
---|---|---|
EvasObject | obj | Parent object. |
Returns
Type | Description |
---|---|
IntPtr |