Class EvasObject
Definition
- Namespace:
- ElmSharp
- Assembly:
- ElmSharp.dll
The EvasObject is a base class for other widget classes.
public abstract class EvasObject
- Inheritance
-
objectEvasObject
- Derived
-
ElmSharp.AnimationViewElmSharp.AnimationViewElmSharp.AnimationViewElmSharp.AnimationViewElmSharp.AnimationViewElmSharp.AnimationViewElmSharp.AnimationViewElmSharp.AnimationView
Constructors
View SourceEvasObject()
Creates and initializes a new instance of the EvasObject class.
Declaration
protected EvasObject()
EvasObject(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. |
Properties
View SourceAlignmentX
Sets or gets the horizontal alignment hint of an object's alignment.
Declaration
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
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
public bool AllEventsFrozen { get; set; }
Property Value
Type | Description |
---|---|
bool |
ClassName
Gets the current class's Name.
Declaration
public string ClassName { get; }
Property Value
Type | Description |
---|---|
string |
Color
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 |
EvasCanvas
Gets EvasCanvas.
Declaration
public EvasCanvas EvasCanvas { get; }
Property Value
Type | Description |
---|---|
EvasCanvas |
EvasMap
Sets or gets the current object's transformation map.
Declaration
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
public Rect Geometry { get; set; }
Property Value
Type | Description |
---|---|
Rect |
Handle
Sets or gets the handle for EvasObject.
Declaration
public IntPtr Handle { get; protected set; }
Property Value
Type | Description |
---|---|
System.IntPtr |
IsMapEnabled
Sets or gets the map enabled state.
Declaration
public bool IsMapEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool |
IsRealized
Gets a widget's status of realized or not.
Declaration
public bool IsRealized { get; }
Property Value
Type | Description |
---|---|
bool |
IsVisible
Gets the visible state of the given Evas object.
Declaration
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
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
public int MinimumHeight { get; set; }
Property Value
Type | Description |
---|---|
int |
MinimumWidth
Sets or gets the width hints for an object's minimum size.
Declaration
public int MinimumWidth { get; set; }
Property Value
Type | Description |
---|---|
int |
Parent
Gets the parent object for EvasObject.
Declaration
public EvasObject Parent { get; }
Property Value
Type | Description |
---|---|
EvasObject |
PassEvents
Sets or gets whether an object is set to pass (ignore) events.
Declaration
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
public bool PropagateEvents { get; set; }
Property Value
Type | Description |
---|---|
bool |
RealHandle
Sets or gets the real handle for EvasObject.
Declaration
public IntPtr RealHandle { get; protected set; }
Property Value
Type | Description |
---|---|
System.IntPtr |
RepeatEvents
Sets or gets whether an object is to repeat events.
Declaration
public bool RepeatEvents { get; set; }
Property Value
Type | Description |
---|---|
bool |
TooltipContentDelegate
Sets the content to be shown in the tooltip object.
Declaration
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
public int TooltipMoveFreezeCount { get; }
Property Value
Type | Description |
---|---|
int |
TooltipOrientation
Sets or gets the orientation of tooltip.
Declaration
public TooltipOrientation TooltipOrientation { get; set; }
Property Value
Type | Description |
---|---|
TooltipOrientation |
TooltipStyle
Sets or gets the style for this object tooltip.
Declaration
public string TooltipStyle { get; set; }
Property Value
Type | Description |
---|---|
string |
TooltipWindowMode
Sets or gets size restriction state of an object's tooltip.
Declaration
public bool TooltipWindowMode { get; set; }
Property Value
Type | Description |
---|---|
bool |
WeightX
Sets or gets the horizontal pointer hints for an object's weight.
Declaration
public double WeightX { get; set; }
Property Value
Type | Description |
---|---|
double |
WeightY
Sets or gets the vertical pointer hints for an object's weight.
Declaration
public double WeightY { get; set; }
Property Value
Type | Description |
---|---|
double |
Methods
View SourceCalculate()
Calls the calculate smart function immediately. This will force immediate calculations needed for renderization of this object.
Declaration
public void Calculate()
CreateHandle(EvasObject)
Creates a widget handle.
Declaration
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
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
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 |
Hide()
Makes the current object invisible.
Declaration
public void Hide()
HideTooltip()
Force hide the tooltip of the object.
Declaration
public void HideTooltip()
KeyGrab(string, bool)
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. |
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
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
public void Lower()
MarkChanged()
Marks the smart object as changed.
Declaration
public void MarkChanged()
Move(int, int)
Moves the current object to the given location.
Declaration
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
protected virtual void OnInstantiated()
OnInvalidate()
The callback of the Invalidate Event.
Declaration
protected virtual void OnInvalidate()
OnRealized()
The callback of the Realized Event.
Declaration
protected virtual void OnRealized()
OnUnrealize()
The callback of the Unrealize Event.
Declaration
protected virtual void OnUnrealize()
PopTooltipMoveFreeze()
This decrements the tooltip freeze count by one.
Declaration
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
public void PushTooltipMoveFreeze()
RaiseTop()
Raises to the top of its layer.
Declaration
public void RaiseTop()
Realize(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. |
Resize(int, int)
Changes the size of the current object.
Declaration
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
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
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
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
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
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
public void Show()
ShowTooltip()
Force show the tooltip of the object.
Declaration
public void ShowTooltip()
StackAbove(EvasObject)
Stacks immediately above anchor.
Declaration
public void StackAbove(EvasObject anchor)
Parameters
Type | Name | Description |
---|---|---|
EvasObject | anchor | The object above which to stack. |
StackBelow(EvasObject)
Stacks immediately below anchor.
Declaration
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
public void Unrealize()
UnsetTooltip()
Unsets an object's tooltip.
Declaration
public void UnsetTooltip()
Events
View SourceBackButtonPressed
BackButtonPressed will be triggered when the Back button is pressed.
Declaration
public event EventHandler BackButtonPressed
Event Type
Type | Description |
---|---|
System.EventHandler |
Deleted
Deleted will be triggered when the widght is deleted.
Declaration
public event EventHandler Deleted
Event Type
Type | Description |
---|---|
System.EventHandler |
KeyDown
KeyDown will be triggered when the key is pressed down.
Declaration
public event EventHandler<EvasKeyEventArgs> KeyDown
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><EvasKeyEventArgs> |
KeyUp
KeyUp will be triggered when the key is loose.
Declaration
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
public event EventHandler MoreButtonPressed
Event Type
Type | Description |
---|---|
System.EventHandler |
Moved
Moved will be triggered when the widght is moved.
Declaration
public event EventHandler Moved
Event Type
Type | Description |
---|---|
System.EventHandler |
RenderPost
RenderPost Event Handler of the current widget.
Declaration
public event EventHandler RenderPost
Event Type
Type | Description |
---|---|
System.EventHandler |
Resized
Resized Event Handler of the current widget's size.
Declaration
public event EventHandler Resized
Event Type
Type | Description |
---|---|
System.EventHandler |
Operators
View Sourceimplicit operator IntPtr(EvasObject)
Define the IntPtr operator.
Declaration
public static implicit operator IntPtr(EvasObject obj)
Parameters
Type | Name | Description |
---|---|---|
EvasObject | obj | Parent object. |
Returns
Type | Description |
---|---|
System.IntPtr |