Class Efl.Canvas.Object
Efl canvas object abstract class (Since EFL 1.22)
Inheritance
Syntax
public abstract class Object : LoopConsumer, IPointer, IColor, IEntity, IHint, IMapping, IStack, IInterface, IWrapper, IDisposable
Constructors
Object(EoWrapper.ConstructingHandle)
Subclasses should override this constructor if they are expected to be instantiated from native code. Do not call this constructor directly.
Declaration
protected Object(EoWrapper.ConstructingHandle ch)
Parameters
Type | Name | Description |
---|---|---|
Efl.Eo.EoWrapper.ConstructingHandle | ch | Tag struct storing the native handle of the object being constructed. |
Object(Object)
Initializes a new instance of the Efl.Canvas.Object class.
Declaration
public Object(Object parent = null)
Parameters
Type | Name | Description |
---|---|---|
Efl.Object | parent | Parent instance. |
Object(IntPtr, Object)
Initializes a new instance of the Efl.Canvas.Object class. Internal usage: Constructor to forward the wrapper initialization to the root class that interfaces with native code. Should not be used directly.
Declaration
protected Object(IntPtr baseKlass, Object parent)
Parameters
Type | Name | Description |
---|---|---|
System.IntPtr | baseKlass | The pointer to the base native Eo class. |
Efl.Object | parent | The Efl.Object parent of this instance. |
Properties
Above
Get the Evas object stacked right above this object.
This function will traverse layers in its search, if there are objects on layers above the one obj
is placed at.
See also Efl.Gfx.IStack.Layer and Efl.Gfx.IStack.GetBelow() (Since EFL 1.22)
Declaration
public IStack Above { get; }
Property Value
Type | Description |
---|---|
Efl.Gfx.IStack | The Efl.Gfx.IStack object directly below |
AntiAlias
Whether or not the given Evas object is to be drawn anti-aliased. (Since EFL 1.22)
Declaration
public bool AntiAlias { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
Below
The Evas object stacked right below this object.
This function will traverse layers in its search, if there are objects on layers below the one obj
is placed at.
See also Efl.Gfx.IStack.Layer. (Since EFL 1.22)
Declaration
public IStack Below { get; }
Property Value
Type | Description |
---|---|
Efl.Gfx.IStack | The Efl.Gfx.IStack object directly below |
ClippedObjects
List of objects currently clipped by obj
.
This returns the internal list handle containing all objects clipped by the object obj
. If none are clipped by it, the call returns null
. This list is only valid until the clip list is changed and should be fetched again with another call to this function if any objects being clipped by this object are unclipped, clipped by a new object, deleted or get the clipper deleted. These operations will invalidate the list returned, so it should not be used anymore after that point. Any use of the list after this may have undefined results, possibly leading to crashes.
See also Efl.Canvas.Object.Clipper. (Since EFL 1.22)
Declaration
public Iterator<Object> ClippedObjects { get; }
Property Value
Type | Description |
---|---|
Eina.Iterator<Efl.Canvas.Object> | An iterator over the list of objects clipped by |
Clipper
Clip one object to another.
This property will clip the object obj
to the area occupied by the object clip
. This means the object obj
will only be visible within the area occupied by the clipping object (clip
).
The color of the object being clipped will be multiplied by the color of the clipping one, so the resulting color for the former will be "RESULT = (OBJ * CLIP) / (255 * 255)", per color element (red, green, blue and alpha).
Clipping is recursive, so clipping objects may be clipped by others, and their color will in term be multiplied. You may not set up circular clipping lists (i.e. object 1 clips object 2, which clips object 1): the behavior of Evas is undefined in this case.
Objects which do not clip others are visible in the canvas as normal; those that clip one or more objects become invisible themselves, only affecting what they clip. If an object ceases to have other objects being clipped by it, it will become visible again.
The visibility of an object affects the objects that are clipped by it, so if the object clipping others is not shown (as in Efl.Gfx.IEntity.Visible), the objects clipped by it will not be shown either.
If obj
was being clipped by another object when this function is called, it gets implicitly removed from the old clipper's domain and is made now to be clipped by its new clipper.
If clip
is null
, this call will disable clipping for the object i.e. its visibility and color get detached from the previous clipper. If it wasn't, this has no effect.
Note: Only rectangle and image (masks) objects can be used as clippers. Anything else will result in undefined behaviour. (Since EFL 1.22)
Declaration
public Object Clipper { get; set; }
Property Value
Type | Description |
---|---|
Efl.Canvas.Object | The object to clip |
Color
The general/main color of the given Evas object. Represents the main color's RGB component (and alpha channel) values, which range from 0 to 255. For the alpha channel, which defines the object's transparency level, 0 means totally transparent, while 255 means opaque. These color values are premultiplied by the alpha value.
Usually you'll use this attribute for text and rectangle objects, where the main color is the only color. If set for objects which themselves have colors, like the images one, those colors get modulated by this one.
All newly created Evas rectangles get the default color values of 255 255 255 255 (opaque white).
When reading this property, use NULL
pointers on the components you're not interested in and they'll be ignored by the function.
(Since EFL 1.22)
Declaration
public (int, int, int, int)Color { get; set; }
Property Value
Type | Description |
---|---|
System.ValueTuple<System.Int32, System.Int32, System.Int32, System.Int32> |
ColorCode
Hexadecimal color code of given Evas object (#RRGGBBAA). (Since EFL 1.22)
Declaration
public string ColorCode { get; set; }
Property Value
Type | Description |
---|---|
System.String | the hex color code. |
Geometry
Rectangular geometry that combines both position and size. (Since EFL 1.22)
Declaration
public Rect Geometry { get; set; }
Property Value
Type | Description |
---|---|
Eina.Rect | The X,Y position and W,H size, in pixels. |
HintAlign
Hints for an object's alignment. These are hints on how to align an object inside the boundaries of a container/manager. Accepted values are in the 0.0 to 1.0 range.
For the horizontal component, 0.0 means the start of the axis in the direction that the current language reads, 1.0 means the end of the axis.
For the vertical component, 0.0 to the top, 1.0 means to the bottom.
This is not a size enforcement in any way, it's just a hint that should be used whenever appropriate.
Note: Default alignment hint values are 0.5, for both axes. (Since EFL 1.22)
Declaration
public (double, double)HintAlign { get; set; }
Property Value
Type | Description |
---|---|
System.ValueTuple<System.Double, System.Double> | Double, ranging from 0.0 to 1.0, where 0.0 is at the start of the horizontal axis and 1.0 is at the end. |
HintAspect
Defines the aspect ratio to respect when scaling this object. The aspect ratio is defined as the width / height ratio of the object. Depending on the object and its container, this hint may or may not be fully respected.
If any of the given aspect ratio terms are 0, the object's container will ignore the aspect and scale this object to occupy the whole available area, for any given policy. (Since EFL 1.22)
Declaration
public (HintAspect, Size2D)HintAspect { get; set; }
Property Value
Type | Description |
---|---|
System.ValueTuple<Efl.Gfx.HintAspect, Eina.Size2D> | Mode of interpretation. |
HintFill
Hints for an object's fill property that used to specify "justify" or "fill" by some users. Efl.Gfx.IHint.GetHintFill(out System.Boolean, out System.Boolean) specify whether to fill the space inside the boundaries of a container/manager. Maximum hints should be enforced with higher priority, if they are set. Also, any Efl.Gfx.IHint.GetHintMargin(out System.Int32, out System.Int32, out System.Int32, out System.Int32) set on objects should add up to the object space on the final scene composition.
See documentation of possible users: in Evas, they are the Efl.Ui.Box "box" and Efl.Ui.Table "table" smart objects.
This is not a size enforcement in any way, it's just a hint that should be used whenever appropriate.
Note: Default fill hint values are true, for both axes. (Since EFL 1.22)
Declaration
public (bool, bool)HintFill { get; set; }
Property Value
Type | Description |
---|---|
System.ValueTuple<System.Boolean, System.Boolean> |
|
HintMargin
Hints for an object's margin or padding space. This is not a size enforcement in any way, it's just a hint that should be used whenever appropriate.
The object container is in charge of fetching this property and placing the object accordingly.
Note: Smart objects (such as elementary) can have their own hint policy. So calling this API may or may not affect the size of smart objects. (Since EFL 1.22)
Declaration
public (int, int, int, int)HintMargin { get; set; }
Property Value
Type | Description |
---|---|
System.ValueTuple<System.Int32, System.Int32, System.Int32, System.Int32> | Integer to specify left padding. |
HintSizeCombinedMax
Read-only maximum size combining both Efl.Gfx.IHint.HintSizeRestrictedMax and Efl.Gfx.IHint.HintSizeMax hints. Efl.Gfx.IHint.HintSizeRestrictedMax is intended for mostly internal usage and widget developers, and Efl.Gfx.IHint.HintSizeMax is intended to be set from application side. Efl.Gfx.IHint.GetHintSizeCombinedMax() combines both values by taking their repective maximum (in both width and height), and is used internally to get an object's maximum size. (Since EFL 1.22)
Declaration
public Size2D HintSizeCombinedMax { get; }
Property Value
Type | Description |
---|---|
Eina.Size2D | Maximum size (hint) in pixels. |
HintSizeCombinedMin
Read-only minimum size combining both Efl.Gfx.IHint.HintSizeRestrictedMin and Efl.Gfx.IHint.HintSizeMin hints. Efl.Gfx.IHint.HintSizeRestrictedMin is intended for mostly internal usage and widget developers, and Efl.Gfx.IHint.HintSizeMin is intended to be set from application side. Efl.Gfx.IHint.GetHintSizeCombinedMin() combines both values by taking their repective maximum (in both width and height), and is used internally to get an object's minimum size. (Since EFL 1.22)
Declaration
public Size2D HintSizeCombinedMin { get; }
Property Value
Type | Description |
---|---|
Eina.Size2D | Minimum size (hint) in pixels. |
HintSizeMax
Hints on the object's maximum size. This is not a size enforcement in any way, it's just a hint that should be used whenever appropriate.
The object container is in charge of fetching this property and placing the object accordingly.
Values -1 will be treated as unset hint components, when queried by managers.
Note: Smart objects (such as elementary) can have their own hint policy. So calling this API may or may not affect the size of smart objects.
Note: It is an error for the Efl.Gfx.IHint.HintSizeMax to be smaller in either axis than Efl.Gfx.IHint.HintSizeMin. In this scenario, the max size hint will be prioritized over the user min size hint. (Since EFL 1.22)
Declaration
public Size2D HintSizeMax { get; set; }
Property Value
Type | Description |
---|---|
Eina.Size2D | Maximum size (hint) in pixels, (-1, -1) by default for canvas objects). |
HintSizeMin
Hints on the object's minimum size. This is not a size enforcement in any way, it's just a hint that should be used whenever appropriate. The object container is in charge of fetching this property and placing the object accordingly.
Value 0 will be treated as unset hint components, when queried by managers.
Note: This property is meant to be set by applications and not by EFL itself. Use this to request a specific size (treated as minimum size).
Note: It is an error for the Efl.Gfx.IHint.HintSizeMax to be smaller in either axis than Efl.Gfx.IHint.HintSizeMin. In this scenario, the max size hint will be prioritized over the user min size hint. (Since EFL 1.22)
Declaration
public Size2D HintSizeMin { get; set; }
Property Value
Type | Description |
---|---|
Eina.Size2D | Minimum size (hint) in pixels. |
HintSizeRestrictedMax
Internal hints for an object's maximum size. This is not a size enforcement in any way, it's just a hint that should be used whenever appropriate.
Values -1 will be treated as unset hint components, when queried by managers.
Note: This property is internal and meant for widget developers to define the absolute maximum size of the object. EFL itself sets this size internally, so any change to it from an application might be ignored. Applications should use Efl.Gfx.IHint.HintSizeMax instead.
Note: It is an error for the Efl.Gfx.IHint.HintSizeRestrictedMax to be smaller in either axis than Efl.Gfx.IHint.HintSizeRestrictedMin. In this scenario, the max size hint will be prioritized over the user min size hint. (Since EFL 1.22)
Declaration
public Size2D HintSizeRestrictedMax { get; protected set; }
Property Value
Type | Description |
---|---|
Eina.Size2D | Maximum size (hint) in pixels. |
HintSizeRestrictedMin
Internal hints for an object's minimum size. This is not a size enforcement in any way, it's just a hint that should be used whenever appropriate.
Values 0 will be treated as unset hint components, when queried by managers.
Note: This property is internal and meant for widget developers to define the absolute minimum size of the object. EFL itself sets this size internally, so any change to it from an application might be ignored. Use Efl.Gfx.IHint.HintSizeMin instead.
Note: It is an error for the Efl.Gfx.IHint.HintSizeRestrictedMax to be smaller in either axis than Efl.Gfx.IHint.HintSizeRestrictedMin. In this scenario, the max size hint will be prioritized over the user min size hint. (Since EFL 1.22)
Declaration
public Size2D HintSizeRestrictedMin { get; protected set; }
Property Value
Type | Description |
---|---|
Eina.Size2D | Minimum size (hint) in pixels. |
HintWeight
Hints for an object's weight. This is a hint on how a container object should resize a given child within its area. Containers may adhere to the simpler logic of just expanding the child object's dimensions to fit its own (see the Efl.Gfx.Constants.HintExpand helper weight macro) or the complete one of taking each child's weight hint as real weights to how much of its size to allocate for them in each axis. A container is supposed to, after normalizing the weights of its children (with weight hints), distribut the space it has to layout them by those factors -- most weighted children get larger in this process than the least ones.
Accepted values are zero or positive values. Some containers might use this hint as a boolean, but some others might consider it as a proportion, see documentation of each container.
Note: Default weight hint values are 0.0, for both axis. (Since EFL 1.22)
Declaration
public (double, double)HintWeight { get; set; }
Property Value
Type | Description |
---|---|
System.ValueTuple<System.Double, System.Double> | Non-negative double value to use as horizontal weight hint. |
KeyFocus
Indicates that this object is the keyboard event receiver on its canvas.
Changing focus only affects where (key) input events go. There can be only one object focused at any time. If focus
is true
, obj
will be set as the currently focused object and it will receive all keyboard events that are not exclusive key grabs on other objects. See also Efl.Canvas.Object.CheckSeatFocus (object still in beta stage), Efl.Canvas.Object.AddSeatFocus (object still in beta stage), Efl.Canvas.Object.DelSeatFocus (object still in beta stage).
(Since EFL 1.22)
Declaration
public bool KeyFocus { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
Layer
The layer of its canvas that the given object will be part of. If you don't use this property, you'll be dealing with a unique layer of objects (the default one). Additional layers are handy when you don't want a set of objects to interfere with another set with regard to stacking. Two layers are completely disjoint in that matter.
This is a low-level function, which you'd be using when something should be always on top, for example.
Warning: Don't change the layer of smart objects' children. Smart objects have a layer of their own, which should contain all their child objects. (Since EFL 1.22)
Declaration
public short Layer { get; set; }
Property Value
Type | Description |
---|---|
System.Int16 | The number of the layer to place the object on. Must be between Efl.Gfx.Constants.StackLayerMin and Efl.Gfx.Constants.StackLayerMax. |
MappingAlpha
Alpha flag for map rendering. This sets alpha flag for map rendering. If the object is a type that has its own alpha settings, then this will take precedence. Only image objects support this currently (Efl.Canvas.Image (object still in beta stage) and its friends). Setting this to off stops alpha blending of the map area, and is useful if you know the object and/or all sub-objects is 100% solid.
Note that this may conflict with Efl.Gfx.IMapping.MappingSmooth depending on which algorithm is used for anti-aliasing. (Since EFL 1.22)
Declaration
public bool MappingAlpha { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
MappingClockwise
Clockwise state of a map (read-only). This determines if the output points (X and Y. Z is not used) are clockwise or counter-clockwise. This can be used for "back-face culling". This is where you hide objects that "face away" from you. In this case objects that are not clockwise. (Since EFL 1.22)
Declaration
public bool MappingClockwise { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
MappingPointCount
Number of points of a map. This sets the number of points of map. Currently, the number of points must be multiples of 4. (Since EFL 1.22)
Declaration
public int MappingPointCount { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The number of points of map |
MappingSmooth
Smoothing state for map rendering. This sets smoothing for map rendering. If the object is a type that has its own smoothing settings, then both the smooth settings for this object and the map must be turned off. By default smooth maps are enabled. (Since EFL 1.22)
Declaration
public bool MappingSmooth { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
NoRender
Disables all rendering on the canvas. This flag will be used to indicate to Evas that this object should never be rendered on the canvas under any circumstances. In particular, this is useful to avoid drawing clipper objects (or masks) even when they don't clip any object. This can also be used to replace the old source_visible flag with proxy objects.
This is different to the visible property, as even visible objects marked as "no-render" will never appear on screen. But those objects can still be used as proxy sources or clippers. When hidden, all "no-render" objects will completely disappear from the canvas, and hide their clippees or be invisible when used as proxy sources. (Since EFL 1.22)
Declaration
public bool NoRender { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | Enable "no-render" mode. |
ParagraphDirection
This handles text paragraph direction of the given object. Even if the given object is not textblock or text, its smart child objects can inherit the paragraph direction from the given object. The default paragraph direction is inherit
.
(Since EFL 1.22)
Declaration
public TextBidirectionalType ParagraphDirection { get; set; }
Property Value
Type | Description |
---|---|
Efl.TextBidirectionalType | Paragraph direction for the given object. |
PassEvents
Whether an Evas object is to pass (ignore) events.
If pass
is true
, it will make events on obj
to be ignored. They will be triggered on the next lower object (that is not set to pass events), instead (see Efl.Gfx.IStack.GetBelow()).
If pass
is false
events will be processed on that object as normal.
See also Efl.Canvas.Object.SetRepeatEvents(System.Boolean), Efl.Canvas.Object.SetPropagateEvents(System.Boolean) (Since EFL 1.22)
Declaration
public bool PassEvents { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | Whether |
Position
The 2D position of a canvas object. The position is absolute, in pixels, relative to the top-left corner of the window, within its border decorations (application space). (Since EFL 1.22)
Declaration
public Position2D Position { get; set; }
Property Value
Type | Description |
---|---|
Eina.Position2D | A 2D coordinate in pixel units. |
PreciseIsInside
Whether to use precise (usually expensive) point collision detection for a given Evas object. Use this property to make Evas treat objects' transparent areas as not belonging to it with regard to mouse pointer events. By default, all of the object's boundary rectangle will be taken in account for them.
Warning: By using precise point collision detection you'll be making Evas more resource intensive. (Since EFL 1.22)
Declaration
public bool PreciseIsInside { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | Whether to use precise point collision detection. |
PropagateEvents
Whether events on a smart object's member should be propagated up to its parent.
This function has no effect if obj
is not a member of a smart object.
If prop
is true
, events occurring on this object will be propagated on to the smart object of which obj
is a member. If prop
is false
, events occurring on this object will not be propagated on to the smart object of which obj
is a member.
See also Efl.Canvas.Object.SetRepeatEvents(System.Boolean), Efl.Canvas.Object.SetPassEvents(System.Boolean). (Since EFL 1.22)
Declaration
public bool PropagateEvents { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | Whether to propagate events. |
RenderOp
Render mode to be used for compositing the Evas object. Only two modes are supported: - Efl.Gfx.RenderOp.Blend means the object will be merged on top of objects below it using simple alpha compositing. - Efl.Gfx.RenderOp.Copy means this object's pixels will replace everything that is below, making this object opaque.
Please do not assume that Efl.Gfx.RenderOp.Copy mode can be used to "poke" holes in a window (to see through it), as only the compositor can ensure that. Copy mode should only be used with otherwise opaque widgets or inside non-window surfaces (e.g. a transparent background inside a buffer canvas). (Since EFL 1.22)
Declaration
public RenderOp RenderOp { get; set; }
Property Value
Type | Description |
---|---|
Efl.Gfx.RenderOp | Blend or copy. |
RenderParent
Gets the parent smart object of a given Evas object, if it has one. This can be different from Efl.Object.Parent because this one is used internally for rendering and the normal parent is what the user expects to be the parent. (Since EFL 1.22)
Declaration
protected Object RenderParent { get; }
Property Value
Type | Description |
---|---|
Efl.Canvas.Object | The parent smart object of |
RepeatEvents
Whether an Evas object is to repeat events to objects below it.
If repeat
is true
, it will make events on obj
to also be repeated for the next lower object in the objects' stack (see see Efl.Gfx.IStack.GetBelow()).
If repeat
is false
, events occurring on obj
will be processed only on it.
(Since EFL 1.22)
Declaration
public bool RepeatEvents { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | Whether |
Scale
The scaling factor of an object. This property is an individual scaling factor on the object (Edje or UI widget). This property (or Edje's global scaling factor, when applicable), will affect this object's part sizes. If scale is not zero, then the individual scaling will override any global scaling set, for the object obj's parts. Set it back to zero to get the effects of the global scaling again.
Warning: In Edje, only parts which, at EDC level, had the "scale" property set to 1, will be affected by this function. Check the complete "syntax reference" for EDC files. (Since EFL 1.22)
Declaration
public double Scale { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The scaling factor. |
SeatFocus
Check if this object is focused. (Since EFL 1.22)
Declaration
public bool SeatFocus { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
Size
The 2D size of a canvas object. (Since EFL 1.22)
Declaration
public Size2D Size { get; set; }
Property Value
Type | Description |
---|---|
Eina.Size2D | A 2D size in pixel units. |
Visible
The visibility of a canvas object. All canvas objects will become visible by default just before render. This means that it is not required to call Efl.Gfx.IEntity.SetVisible(System.Boolean) after creating an object unless you want to create it without showing it. Note that this behavior is new since 1.21, and only applies to canvas objects created with the EO API (i.e. not the legacy C-only API). Other types of Gfx objects may or may not be visible by default.
Note that many other parameters can prevent a visible object from actually being "visible" on screen. For instance if its color is fully transparent, or its parent is hidden, or it is clipped out, etc... (Since EFL 1.22)
Declaration
public bool Visible { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
Methods
ClippedObjectsCount()
Returns the number of objects clipped by obj
(Since EFL 1.22)
Declaration
public virtual uint ClippedObjectsCount()
Returns
Type | Description |
---|---|
System.UInt32 | The number of objects clipped by |
GetAbove()
Get the Evas object stacked right above this object.
This function will traverse layers in its search, if there are objects on layers above the one obj
is placed at.
See also Efl.Gfx.IStack.Layer and Efl.Gfx.IStack.GetBelow() (Since EFL 1.22)
Declaration
public virtual IStack GetAbove()
Returns
Type | Description |
---|---|
Efl.Gfx.IStack | The Efl.Gfx.IStack object directly below |
GetAntiAlias()
Whether or not the given Evas object is to be drawn anti-aliased. (Since EFL 1.22)
Declaration
public virtual bool GetAntiAlias()
Returns
Type | Description |
---|---|
System.Boolean |
|
GetBelow()
The Evas object stacked right below this object.
This function will traverse layers in its search, if there are objects on layers below the one obj
is placed at.
See also Efl.Gfx.IStack.Layer. (Since EFL 1.22)
Declaration
public virtual IStack GetBelow()
Returns
Type | Description |
---|---|
Efl.Gfx.IStack | The Efl.Gfx.IStack object directly below |
GetClippedObjects()
List of objects currently clipped by obj
.
This returns the internal list handle containing all objects clipped by the object obj
. If none are clipped by it, the call returns null
. This list is only valid until the clip list is changed and should be fetched again with another call to this function if any objects being clipped by this object are unclipped, clipped by a new object, deleted or get the clipper deleted. These operations will invalidate the list returned, so it should not be used anymore after that point. Any use of the list after this may have undefined results, possibly leading to crashes.
See also Efl.Canvas.Object.Clipper. (Since EFL 1.22)
Declaration
public virtual Iterator<Object> GetClippedObjects()
Returns
Type | Description |
---|---|
Eina.Iterator<Efl.Canvas.Object> | An iterator over the list of objects clipped by |
GetClipper()
Clip one object to another.
This property will clip the object obj
to the area occupied by the object clip
. This means the object obj
will only be visible within the area occupied by the clipping object (clip
).
The color of the object being clipped will be multiplied by the color of the clipping one, so the resulting color for the former will be "RESULT = (OBJ * CLIP) / (255 * 255)", per color element (red, green, blue and alpha).
Clipping is recursive, so clipping objects may be clipped by others, and their color will in term be multiplied. You may not set up circular clipping lists (i.e. object 1 clips object 2, which clips object 1): the behavior of Evas is undefined in this case.
Objects which do not clip others are visible in the canvas as normal; those that clip one or more objects become invisible themselves, only affecting what they clip. If an object ceases to have other objects being clipped by it, it will become visible again.
The visibility of an object affects the objects that are clipped by it, so if the object clipping others is not shown (as in Efl.Gfx.IEntity.Visible), the objects clipped by it will not be shown either.
If obj
was being clipped by another object when this function is called, it gets implicitly removed from the old clipper's domain and is made now to be clipped by its new clipper.
If clip
is null
, this call will disable clipping for the object i.e. its visibility and color get detached from the previous clipper. If it wasn't, this has no effect.
Note: Only rectangle and image (masks) objects can be used as clippers. Anything else will result in undefined behaviour. (Since EFL 1.22)
Declaration
public virtual Object GetClipper()
Returns
Type | Description |
---|---|
Efl.Canvas.Object | The object to clip |
GetColor(out Int32, out Int32, out Int32, out Int32)
The general/main color of the given Evas object. Represents the main color's RGB component (and alpha channel) values, which range from 0 to 255. For the alpha channel, which defines the object's transparency level, 0 means totally transparent, while 255 means opaque. These color values are premultiplied by the alpha value.
Usually you'll use this attribute for text and rectangle objects, where the main color is the only color. If set for objects which themselves have colors, like the images one, those colors get modulated by this one.
All newly created Evas rectangles get the default color values of 255 255 255 255 (opaque white).
When reading this property, use NULL
pointers on the components you're not interested in and they'll be ignored by the function.
(Since EFL 1.22)
Declaration
public virtual void GetColor(out int r, out int g, out int b, out int a)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | r | |
System.Int32 | g | |
System.Int32 | b | |
System.Int32 | a |
GetColorCode()
Hexadecimal color code of given Evas object (#RRGGBBAA). (Since EFL 1.22)
Declaration
public virtual string GetColorCode()
Returns
Type | Description |
---|---|
System.String | the hex color code. |
GetCoordsInside(Position2D)
Whether the coordinates are logically inside the object.
A value of true
indicates the position is logically inside the object, and false
implies it is logically outside the object.
If obj
is not a valid object, the return value is undefined.
(Since EFL 1.22)
Declaration
public virtual bool GetCoordsInside(Position2D pos)
Parameters
Type | Name | Description |
---|---|---|
Eina.Position2D | pos | The coordinates in pixels. |
Returns
Type | Description |
---|---|
System.Boolean |
|
GetGeometry()
Rectangular geometry that combines both position and size. (Since EFL 1.22)
Declaration
public virtual Rect GetGeometry()
Returns
Type | Description |
---|---|
Eina.Rect | The X,Y position and W,H size, in pixels. |
GetHintAlign(out Double, out Double)
Hints for an object's alignment. These are hints on how to align an object inside the boundaries of a container/manager. Accepted values are in the 0.0 to 1.0 range.
For the horizontal component, 0.0 means the start of the axis in the direction that the current language reads, 1.0 means the end of the axis.
For the vertical component, 0.0 to the top, 1.0 means to the bottom.
This is not a size enforcement in any way, it's just a hint that should be used whenever appropriate.
Note: Default alignment hint values are 0.5, for both axes. (Since EFL 1.22)
Declaration
public virtual void GetHintAlign(out double x, out double y)
Parameters
Type | Name | Description |
---|---|---|
System.Double | x | Double, ranging from 0.0 to 1.0, where 0.0 is at the start of the horizontal axis and 1.0 is at the end. |
System.Double | y | Double, ranging from 0.0 to 1.0, where 0.0 is at the start of the vertical axis and 1.0 is at the end. |
GetHintAspect(out HintAspect, out Size2D)
Defines the aspect ratio to respect when scaling this object. The aspect ratio is defined as the width / height ratio of the object. Depending on the object and its container, this hint may or may not be fully respected.
If any of the given aspect ratio terms are 0, the object's container will ignore the aspect and scale this object to occupy the whole available area, for any given policy. (Since EFL 1.22)
Declaration
public virtual void GetHintAspect(out HintAspect mode, out Size2D sz)
Parameters
Type | Name | Description |
---|---|---|
Efl.Gfx.HintAspect | mode | Mode of interpretation. |
Eina.Size2D | sz | Base size to use for aspecting. |
GetHintFill(out Boolean, out Boolean)
Hints for an object's fill property that used to specify "justify" or "fill" by some users. Efl.Gfx.IHint.GetHintFill(out System.Boolean, out System.Boolean) specify whether to fill the space inside the boundaries of a container/manager. Maximum hints should be enforced with higher priority, if they are set. Also, any Efl.Gfx.IHint.GetHintMargin(out System.Int32, out System.Int32, out System.Int32, out System.Int32) set on objects should add up to the object space on the final scene composition.
See documentation of possible users: in Evas, they are the Efl.Ui.Box "box" and Efl.Ui.Table "table" smart objects.
This is not a size enforcement in any way, it's just a hint that should be used whenever appropriate.
Note: Default fill hint values are true, for both axes. (Since EFL 1.22)
Declaration
public virtual void GetHintFill(out bool x, out bool y)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | x |
|
System.Boolean | y |
|
GetHintMargin(out Int32, out Int32, out Int32, out Int32)
Hints for an object's margin or padding space. This is not a size enforcement in any way, it's just a hint that should be used whenever appropriate.
The object container is in charge of fetching this property and placing the object accordingly.
Note: Smart objects (such as elementary) can have their own hint policy. So calling this API may or may not affect the size of smart objects. (Since EFL 1.22)
Declaration
public virtual void GetHintMargin(out int l, out int r, out int t, out int b)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | l | Integer to specify left padding. |
System.Int32 | r | Integer to specify right padding. |
System.Int32 | t | Integer to specify top padding. |
System.Int32 | b | Integer to specify bottom padding. |
GetHintSizeCombinedMax()
Read-only maximum size combining both Efl.Gfx.IHint.HintSizeRestrictedMax and Efl.Gfx.IHint.HintSizeMax hints. Efl.Gfx.IHint.HintSizeRestrictedMax is intended for mostly internal usage and widget developers, and Efl.Gfx.IHint.HintSizeMax is intended to be set from application side. Efl.Gfx.IHint.GetHintSizeCombinedMax() combines both values by taking their repective maximum (in both width and height), and is used internally to get an object's maximum size. (Since EFL 1.22)
Declaration
public virtual Size2D GetHintSizeCombinedMax()
Returns
Type | Description |
---|---|
Eina.Size2D | Maximum size (hint) in pixels. |
GetHintSizeCombinedMin()
Read-only minimum size combining both Efl.Gfx.IHint.HintSizeRestrictedMin and Efl.Gfx.IHint.HintSizeMin hints. Efl.Gfx.IHint.HintSizeRestrictedMin is intended for mostly internal usage and widget developers, and Efl.Gfx.IHint.HintSizeMin is intended to be set from application side. Efl.Gfx.IHint.GetHintSizeCombinedMin() combines both values by taking their repective maximum (in both width and height), and is used internally to get an object's minimum size. (Since EFL 1.22)
Declaration
public virtual Size2D GetHintSizeCombinedMin()
Returns
Type | Description |
---|---|
Eina.Size2D | Minimum size (hint) in pixels. |
GetHintSizeMax()
Hints on the object's maximum size. This is not a size enforcement in any way, it's just a hint that should be used whenever appropriate.
The object container is in charge of fetching this property and placing the object accordingly.
Values -1 will be treated as unset hint components, when queried by managers.
Note: Smart objects (such as elementary) can have their own hint policy. So calling this API may or may not affect the size of smart objects.
Note: It is an error for the Efl.Gfx.IHint.HintSizeMax to be smaller in either axis than Efl.Gfx.IHint.HintSizeMin. In this scenario, the max size hint will be prioritized over the user min size hint. (Since EFL 1.22)
Declaration
public virtual Size2D GetHintSizeMax()
Returns
Type | Description |
---|---|
Eina.Size2D | Maximum size (hint) in pixels, (-1, -1) by default for canvas objects). |
GetHintSizeMin()
Hints on the object's minimum size. This is not a size enforcement in any way, it's just a hint that should be used whenever appropriate. The object container is in charge of fetching this property and placing the object accordingly.
Value 0 will be treated as unset hint components, when queried by managers.
Note: This property is meant to be set by applications and not by EFL itself. Use this to request a specific size (treated as minimum size).
Note: It is an error for the Efl.Gfx.IHint.HintSizeMax to be smaller in either axis than Efl.Gfx.IHint.HintSizeMin. In this scenario, the max size hint will be prioritized over the user min size hint. (Since EFL 1.22)
Declaration
public virtual Size2D GetHintSizeMin()
Returns
Type | Description |
---|---|
Eina.Size2D | Minimum size (hint) in pixels. |
GetHintSizeRestrictedMax()
Get the "intrinsic" maximum size of this object. (Since EFL 1.22)
Declaration
public virtual Size2D GetHintSizeRestrictedMax()
Returns
Type | Description |
---|---|
Eina.Size2D | Maximum size (hint) in pixels. |
GetHintSizeRestrictedMin()
Get the "intrinsic" minimum size of this object. (Since EFL 1.22)
Declaration
public virtual Size2D GetHintSizeRestrictedMin()
Returns
Type | Description |
---|---|
Eina.Size2D | Minimum size (hint) in pixels. |
GetHintWeight(out Double, out Double)
Hints for an object's weight. This is a hint on how a container object should resize a given child within its area. Containers may adhere to the simpler logic of just expanding the child object's dimensions to fit its own (see the Efl.Gfx.Constants.HintExpand helper weight macro) or the complete one of taking each child's weight hint as real weights to how much of its size to allocate for them in each axis. A container is supposed to, after normalizing the weights of its children (with weight hints), distribut the space it has to layout them by those factors -- most weighted children get larger in this process than the least ones.
Accepted values are zero or positive values. Some containers might use this hint as a boolean, but some others might consider it as a proportion, see documentation of each container.
Note: Default weight hint values are 0.0, for both axis. (Since EFL 1.22)
Declaration
public virtual void GetHintWeight(out double x, out double y)
Parameters
Type | Name | Description |
---|---|---|
System.Double | x | Non-negative double value to use as horizontal weight hint. |
System.Double | y | Non-negative double value to use as vertical weight hint. |
GetKeyFocus()
Indicates that this object is the keyboard event receiver on its canvas.
Changing focus only affects where (key) input events go. There can be only one object focused at any time. If focus
is true
, obj
will be set as the currently focused object and it will receive all keyboard events that are not exclusive key grabs on other objects. See also Efl.Canvas.Object.CheckSeatFocus (object still in beta stage), Efl.Canvas.Object.AddSeatFocus (object still in beta stage), Efl.Canvas.Object.DelSeatFocus (object still in beta stage).
(Since EFL 1.22)
Declaration
public virtual bool GetKeyFocus()
Returns
Type | Description |
---|---|
System.Boolean |
|
GetLayer()
The layer of its canvas that the given object will be part of. If you don't use this property, you'll be dealing with a unique layer of objects (the default one). Additional layers are handy when you don't want a set of objects to interfere with another set with regard to stacking. Two layers are completely disjoint in that matter.
This is a low-level function, which you'd be using when something should be always on top, for example.
Warning: Don't change the layer of smart objects' children. Smart objects have a layer of their own, which should contain all their child objects. (Since EFL 1.22)
Declaration
public virtual short GetLayer()
Returns
Type | Description |
---|---|
System.Int16 | The number of the layer to place the object on. Must be between Efl.Gfx.Constants.StackLayerMin and Efl.Gfx.Constants.StackLayerMax. |
GetMappingAlpha()
Alpha flag for map rendering. This sets alpha flag for map rendering. If the object is a type that has its own alpha settings, then this will take precedence. Only image objects support this currently (Efl.Canvas.Image (object still in beta stage) and its friends). Setting this to off stops alpha blending of the map area, and is useful if you know the object and/or all sub-objects is 100% solid.
Note that this may conflict with Efl.Gfx.IMapping.MappingSmooth depending on which algorithm is used for anti-aliasing. (Since EFL 1.22)
Declaration
public virtual bool GetMappingAlpha()
Returns
Type | Description |
---|---|
System.Boolean |
|
GetMappingClockwise()
Clockwise state of a map (read-only). This determines if the output points (X and Y. Z is not used) are clockwise or counter-clockwise. This can be used for "back-face culling". This is where you hide objects that "face away" from you. In this case objects that are not clockwise. (Since EFL 1.22)
Declaration
public virtual bool GetMappingClockwise()
Returns
Type | Description |
---|---|
System.Boolean |
|
GetMappingColor(Int32, out Int32, out Int32, out Int32, out Int32)
Color of a vertex in the map. This sets the color of the vertex in the map. Colors will be linearly interpolated between vertex points through the map. Color will multiply the "texture" pixels (like GL_MODULATE in OpenGL). The default color of a vertex in a map is white solid (255, 255, 255, 255) which means it will have no affect on modifying the texture pixels.
The color values must be premultiplied (ie. a
>= {r
, g
, b
}).
(Since EFL 1.22)
Declaration
public virtual void GetMappingColor(int idx, out int r, out int g, out int b, out int a)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | idx | ID of the point, from 0 to 3 (included). -1 can be used to set the color for all points, but it is invalid for get(). |
System.Int32 | r | Red (0 - 255) |
System.Int32 | g | Green (0 - 255) |
System.Int32 | b | Blue (0 - 255) |
System.Int32 | a | Alpha (0 - 255) |
GetMappingCoordAbsolute(Int32, out Double, out Double, out Double)
A point's absolute coordinate on the canvas. This sets/gets the fixed point's coordinate in the map. Note that points describe the outline of a quadrangle and are ordered either clockwise or counter-clockwise. Try to keep your quadrangles concave and non-complex. Though these polygon modes may work, they may not render a desired set of output. The quadrangle will use points 0 and 1 , 1 and 2, 2 and 3, and 3 and 0 to describe the edges of the quadrangle.
The X and Y and Z coordinates are in canvas units. Z is optional and may or may not be honored in drawing. Z is a hint and does not affect the X and Y rendered coordinates. It may be used for calculating fills with perspective correct rendering.
Remember all coordinates are canvas global ones as with move and resize in the canvas.
This property can be read to get the 4 points positions on the canvas, or set to manually place them. (Since EFL 1.22)
Declaration
public virtual void GetMappingCoordAbsolute(int idx, out double x, out double y, out double z)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | idx | ID of the point, from 0 to 3 (included). |
System.Double | x | Point X coordinate in absolute pixel coordinates. |
System.Double | y | Point Y coordinate in absolute pixel coordinates. |
System.Double | z | Point Z coordinate hint (pre-perspective transform). |
GetMappingPointCount()
Number of points of a map. This sets the number of points of map. Currently, the number of points must be multiples of 4. (Since EFL 1.22)
Declaration
public virtual int GetMappingPointCount()
Returns
Type | Description |
---|---|
System.Int32 | The number of points of map |
GetMappingSmooth()
Smoothing state for map rendering. This sets smoothing for map rendering. If the object is a type that has its own smoothing settings, then both the smooth settings for this object and the map must be turned off. By default smooth maps are enabled. (Since EFL 1.22)
Declaration
public virtual bool GetMappingSmooth()
Returns
Type | Description |
---|---|
System.Boolean |
|
GetMappingUv(Int32, out Double, out Double)
Map point's U and V texture source point. This sets/gets the U and V coordinates for the point. This determines which coordinate in the source image is mapped to the given point, much like OpenGL and textures. Valid values range from 0.0 to 1.0.
By default the points are set in a clockwise order, as such: - 0: top-left, i.e. (0.0, 0.0), - 1: top-right, i.e. (1.0, 0.0), - 2: bottom-right, i.e. (1.0, 1.0), - 3: bottom-left, i.e. (0.0, 1.0). (Since EFL 1.22)
Declaration
public virtual void GetMappingUv(int idx, out double u, out double v)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | idx | ID of the point, from 0 to 3 (included). |
System.Double | u | Relative X coordinate within the image, from 0 to 1. |
System.Double | v | Relative Y coordinate within the image, from 0 to 1. |
GetNoRender()
Disables all rendering on the canvas. This flag will be used to indicate to Evas that this object should never be rendered on the canvas under any circumstances. In particular, this is useful to avoid drawing clipper objects (or masks) even when they don't clip any object. This can also be used to replace the old source_visible flag with proxy objects.
This is different to the visible property, as even visible objects marked as "no-render" will never appear on screen. But those objects can still be used as proxy sources or clippers. When hidden, all "no-render" objects will completely disappear from the canvas, and hide their clippees or be invisible when used as proxy sources. (Since EFL 1.22)
Declaration
public virtual bool GetNoRender()
Returns
Type | Description |
---|---|
System.Boolean | Enable "no-render" mode. |
GetParagraphDirection()
This handles text paragraph direction of the given object. Even if the given object is not textblock or text, its smart child objects can inherit the paragraph direction from the given object. The default paragraph direction is inherit
.
(Since EFL 1.22)
Declaration
public virtual TextBidirectionalType GetParagraphDirection()
Returns
Type | Description |
---|---|
Efl.TextBidirectionalType | Paragraph direction for the given object. |
GetPassEvents()
Whether an Evas object is to pass (ignore) events.
If pass
is true
, it will make events on obj
to be ignored. They will be triggered on the next lower object (that is not set to pass events), instead (see Efl.Gfx.IStack.GetBelow()).
If pass
is false
events will be processed on that object as normal.
See also Efl.Canvas.Object.SetRepeatEvents(System.Boolean), Efl.Canvas.Object.SetPropagateEvents(System.Boolean) (Since EFL 1.22)
Declaration
public virtual bool GetPassEvents()
Returns
Type | Description |
---|---|
System.Boolean | Whether |
GetPosition()
Retrieves the position of the given canvas object. (Since EFL 1.22)
Declaration
public virtual Position2D GetPosition()
Returns
Type | Description |
---|---|
Eina.Position2D | A 2D coordinate in pixel units. |
GetPreciseIsInside()
Whether to use precise (usually expensive) point collision detection for a given Evas object. Use this property to make Evas treat objects' transparent areas as not belonging to it with regard to mouse pointer events. By default, all of the object's boundary rectangle will be taken in account for them.
Warning: By using precise point collision detection you'll be making Evas more resource intensive. (Since EFL 1.22)
Declaration
public virtual bool GetPreciseIsInside()
Returns
Type | Description |
---|---|
System.Boolean | Whether to use precise point collision detection. |
GetPropagateEvents()
Whether events on a smart object's member should be propagated up to its parent.
This function has no effect if obj
is not a member of a smart object.
If prop
is true
, events occurring on this object will be propagated on to the smart object of which obj
is a member. If prop
is false
, events occurring on this object will not be propagated on to the smart object of which obj
is a member.
See also Efl.Canvas.Object.SetRepeatEvents(System.Boolean), Efl.Canvas.Object.SetPassEvents(System.Boolean). (Since EFL 1.22)
Declaration
public virtual bool GetPropagateEvents()
Returns
Type | Description |
---|---|
System.Boolean | Whether to propagate events. |
GetRenderOp()
Render mode to be used for compositing the Evas object. Only two modes are supported: - Efl.Gfx.RenderOp.Blend means the object will be merged on top of objects below it using simple alpha compositing. - Efl.Gfx.RenderOp.Copy means this object's pixels will replace everything that is below, making this object opaque.
Please do not assume that Efl.Gfx.RenderOp.Copy mode can be used to "poke" holes in a window (to see through it), as only the compositor can ensure that. Copy mode should only be used with otherwise opaque widgets or inside non-window surfaces (e.g. a transparent background inside a buffer canvas). (Since EFL 1.22)
Declaration
public virtual RenderOp GetRenderOp()
Returns
Type | Description |
---|---|
Efl.Gfx.RenderOp | Blend or copy. |
GetRenderParent()
Gets the parent smart object of a given Evas object, if it has one. This can be different from Efl.Object.Parent because this one is used internally for rendering and the normal parent is what the user expects to be the parent. (Since EFL 1.22)
Declaration
protected virtual Object GetRenderParent()
Returns
Type | Description |
---|---|
Efl.Canvas.Object | The parent smart object of |
GetRepeatEvents()
Whether an Evas object is to repeat events to objects below it.
If repeat
is true
, it will make events on obj
to also be repeated for the next lower object in the objects' stack (see see Efl.Gfx.IStack.GetBelow()).
If repeat
is false
, events occurring on obj
will be processed only on it.
(Since EFL 1.22)
Declaration
public virtual bool GetRepeatEvents()
Returns
Type | Description |
---|---|
System.Boolean | Whether |
GetScale()
Gets an object's scaling factor. (Since EFL 1.22)
Declaration
public virtual double GetScale()
Returns
Type | Description |
---|---|
System.Double | The scaling factor. |
GetSeatFocus()
Check if this object is focused. (Since EFL 1.22)
Declaration
public virtual bool GetSeatFocus()
Returns
Type | Description |
---|---|
System.Boolean |
|
GetSize()
Retrieves the (rectangular) size of the given Evas object. (Since EFL 1.22)
Declaration
public virtual Size2D GetSize()
Returns
Type | Description |
---|---|
Eina.Size2D | A 2D size in pixel units. |
GetVisible()
Retrieves whether or not the given canvas object is visible. (Since EFL 1.22)
Declaration
public virtual bool GetVisible()
Returns
Type | Description |
---|---|
System.Boolean |
|
GrabKey(String, Modifier, Modifier, Boolean)
Requests keyname
key events be directed to obj
.
Key grabs allow one or more objects to receive key events for specific key strokes even if other objects have focus. Whenever a key is grabbed, only the objects grabbing it will get the events for the given keys.
keyname
is a platform dependent symbolic name for the key pressed.
modifiers
and not_modifiers
are bit masks of all the modifiers that must and mustn't, respectively, be pressed along with keyname
key in order to trigger this new key grab. Modifiers can be things such as Shift and Ctrl as well as user defined types via ref evas_key_modifier_add. exclusive
will make the given object the only one permitted to grab the given key. If given true
, subsequent calls on this function with different obj
arguments will fail, unless the key is ungrabbed again.
Warning: Providing impossible modifier sets creates undefined behavior. (Since EFL 1.22)
Declaration
public virtual bool GrabKey(string keyname, Modifier modifiers, Modifier not_modifiers, bool exclusive)
Parameters
Type | Name | Description |
---|---|---|
System.String | keyname | The key to request events for. |
Efl.Input.Modifier | modifiers | A combination of modifier keys that must be present to trigger the event. |
Efl.Input.Modifier | not_modifiers | A combination of modifier keys that must not be present to trigger the event. |
System.Boolean | exclusive | Request that the |
Returns
Type | Description |
---|---|
System.Boolean |
|
HasMapping()
Read-only property indicating whether an object is mapped.
This will be true
if any transformation is applied to this object.
(Since EFL 1.22)
Declaration
public virtual bool HasMapping()
Returns
Type | Description |
---|---|
System.Boolean |
|
Lighting3d(IEntity, Double, Double, Double, Int32, Int32, Int32, Int32, Int32, Int32)
Apply a lighting effect on the object. This is used to apply lighting calculations (from a single light source) to a given mapped object. The R, G and B values of each vertex will be modified to reflect the lighting based on the light point coordinates, the light color and the ambient color, and at what angle the map is facing the light source. A surface should have its points be declared in a clockwise fashion if the face is "facing" towards you (as opposed to away from you) as faces have a "logical" side for lighting.
The coordinates are set relative to the given pivot
object. If its geometry changes, then the absolute position of the rotation center will change accordingly. The Z position is absolute. If the pivot
is null
then this object will be its own pivot.
(Since EFL 1.22)
Declaration
public virtual void Lighting3d(IEntity pivot, double lx, double ly, double lz, int lr, int lg, int lb, int ar, int ag, int ab)
Parameters
Type | Name | Description |
---|---|---|
Efl.Gfx.IEntity | pivot | A pivot object for the light point, can be |
System.Double | lx | X relative coordinate in space of light point. |
System.Double | ly | Y relative coordinate in space of light point. |
System.Double | lz | Z absolute coordinate in space of light point. |
System.Int32 | lr | Light red value (0 - 255). |
System.Int32 | lg | Light green value (0 - 255). |
System.Int32 | lb | Light blue value (0 - 255). |
System.Int32 | ar | Ambient color red value (0 - 255). |
System.Int32 | ag | Ambient color green value (0 - 255). |
System.Int32 | ab | Ambient color blue value (0 - 255). |
Lighting3dAbsolute(Double, Double, Double, Int32, Int32, Int32, Int32, Int32, Int32)
Apply a lighting effect to the object. This is used to apply lighting calculations (from a single light source) to a given mapped object. The RGB values of each vertex will be modified to reflect the lighting based on the light point coordinates, the light color, the ambient color and at what angle the map is facing the light source. A surface should have its points be declared in a clockwise fashion if the face is "facing" towards you (as opposed to away from you) as faces have a "logical" side for lighting.
The coordinates of the center point are given in absolute canvas coordinates. See also Efl.Gfx.IMapping.Lighting3d(Efl.Gfx.IEntity, System.Double, System.Double, System.Double, System.Int32, System.Int32, System.Int32, System.Int32, System.Int32, System.Int32) for a pivot-based lighting effect. (Since EFL 1.22)
Declaration
public virtual void Lighting3dAbsolute(double lx, double ly, double lz, int lr, int lg, int lb, int ar, int ag, int ab)
Parameters
Type | Name | Description |
---|---|---|
System.Double | lx | X absolute coordinate in pixels of the light point. |
System.Double | ly | y absolute coordinate in pixels of the light point. |
System.Double | lz | Z absolute coordinate in space of light point. |
System.Int32 | lr | Light red value (0 - 255). |
System.Int32 | lg | Light green value (0 - 255). |
System.Int32 | lb | Light blue value (0 - 255). |
System.Int32 | ar | Ambient color red value (0 - 255). |
System.Int32 | ag | Ambient color green value (0 - 255). |
System.Int32 | ab | Ambient color blue value (0 - 255). |
LowerToBottom()
Lower obj
to the bottom of its layer.
obj
will, then, be the lowest one in the layer it belongs to. Objects on other layers won't get touched.
See also Efl.Gfx.IStack.StackAbove(Efl.Gfx.IStack), Efl.Gfx.IStack.StackBelow(Efl.Gfx.IStack) and Efl.Gfx.IStack.RaiseToTop() (Since EFL 1.22)
Declaration
public virtual void LowerToBottom()
OnAnimatorTickEvent(ObjectAnimatorTickEventArgs)
Method to raise event AnimatorTickEvent.
Declaration
public void OnAnimatorTickEvent(ObjectAnimatorTickEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Canvas.ObjectAnimatorTickEventArgs | e | Event to raise. |
OnFingerDownEvent(InterfaceFingerDownEventArgs)
Method to raise event FingerDownEvent.
Declaration
public void OnFingerDownEvent(InterfaceFingerDownEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Input.InterfaceFingerDownEventArgs | e | Event to raise. |
OnFingerMoveEvent(InterfaceFingerMoveEventArgs)
Method to raise event FingerMoveEvent.
Declaration
public void OnFingerMoveEvent(InterfaceFingerMoveEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Input.InterfaceFingerMoveEventArgs | e | Event to raise. |
OnFingerUpEvent(InterfaceFingerUpEventArgs)
Method to raise event FingerUpEvent.
Declaration
public void OnFingerUpEvent(InterfaceFingerUpEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Input.InterfaceFingerUpEventArgs | e | Event to raise. |
OnFocusInEvent(InterfaceFocusInEventArgs)
Method to raise event FocusInEvent.
Declaration
public void OnFocusInEvent(InterfaceFocusInEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Input.InterfaceFocusInEventArgs | e | Event to raise. |
OnFocusOutEvent(InterfaceFocusOutEventArgs)
Method to raise event FocusOutEvent.
Declaration
public void OnFocusOutEvent(InterfaceFocusOutEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Input.InterfaceFocusOutEventArgs | e | Event to raise. |
OnHintsChangedEvent(EventArgs)
Method to raise event HintsChangedEvent.
Declaration
public void OnHintsChangedEvent(EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.EventArgs | e | Event to raise. |
OnHoldEvent(InterfaceHoldEventArgs)
Method to raise event HoldEvent.
Declaration
public void OnHoldEvent(InterfaceHoldEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Input.InterfaceHoldEventArgs | e | Event to raise. |
OnKeyDownEvent(InterfaceKeyDownEventArgs)
Method to raise event KeyDownEvent.
Declaration
public void OnKeyDownEvent(InterfaceKeyDownEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Input.InterfaceKeyDownEventArgs | e | Event to raise. |
OnKeyUpEvent(InterfaceKeyUpEventArgs)
Method to raise event KeyUpEvent.
Declaration
public void OnKeyUpEvent(InterfaceKeyUpEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Input.InterfaceKeyUpEventArgs | e | Event to raise. |
OnPointerAxisEvent(InterfacePointerAxisEventArgs)
Method to raise event PointerAxisEvent.
Declaration
public void OnPointerAxisEvent(InterfacePointerAxisEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Input.InterfacePointerAxisEventArgs | e | Event to raise. |
OnPointerCancelEvent(InterfacePointerCancelEventArgs)
Method to raise event PointerCancelEvent.
Declaration
public void OnPointerCancelEvent(InterfacePointerCancelEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Input.InterfacePointerCancelEventArgs | e | Event to raise. |
OnPointerDownEvent(InterfacePointerDownEventArgs)
Method to raise event PointerDownEvent.
Declaration
public void OnPointerDownEvent(InterfacePointerDownEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Input.InterfacePointerDownEventArgs | e | Event to raise. |
OnPointerInEvent(InterfacePointerInEventArgs)
Method to raise event PointerInEvent.
Declaration
public void OnPointerInEvent(InterfacePointerInEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Input.InterfacePointerInEventArgs | e | Event to raise. |
OnPointerMoveEvent(InterfacePointerMoveEventArgs)
Method to raise event PointerMoveEvent.
Declaration
public void OnPointerMoveEvent(InterfacePointerMoveEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Input.InterfacePointerMoveEventArgs | e | Event to raise. |
OnPointerOutEvent(InterfacePointerOutEventArgs)
Method to raise event PointerOutEvent.
Declaration
public void OnPointerOutEvent(InterfacePointerOutEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Input.InterfacePointerOutEventArgs | e | Event to raise. |
OnPointerUpEvent(InterfacePointerUpEventArgs)
Method to raise event PointerUpEvent.
Declaration
public void OnPointerUpEvent(InterfacePointerUpEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Input.InterfacePointerUpEventArgs | e | Event to raise. |
OnPointerWheelEvent(InterfacePointerWheelEventArgs)
Method to raise event PointerWheelEvent.
Declaration
public void OnPointerWheelEvent(InterfacePointerWheelEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Input.InterfacePointerWheelEventArgs | e | Event to raise. |
OnPositionChangedEvent(EntityPositionChangedEventArgs)
Method to raise event PositionChangedEvent.
Declaration
public void OnPositionChangedEvent(EntityPositionChangedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Gfx.EntityPositionChangedEventArgs | e | Event to raise. |
OnSizeChangedEvent(EntitySizeChangedEventArgs)
Method to raise event SizeChangedEvent.
Declaration
public void OnSizeChangedEvent(EntitySizeChangedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Gfx.EntitySizeChangedEventArgs | e | Event to raise. |
OnStackingChangedEvent(EventArgs)
Method to raise event StackingChangedEvent.
Declaration
public void OnStackingChangedEvent(EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.EventArgs | e | Event to raise. |
OnVisibilityChangedEvent(EntityVisibilityChangedEventArgs)
Method to raise event VisibilityChangedEvent.
Declaration
public void OnVisibilityChangedEvent(EntityVisibilityChangedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Efl.Gfx.EntityVisibilityChangedEventArgs | e | Event to raise. |
Perspective3d(IEntity, Double, Double, Double, Double)
Apply a perspective transform to the map
This applies a given perspective (3D) to the map coordinates. X, Y and Z values are used. The px and py points specify the "infinite distance" point in the 3D conversion (where all lines converge to like when artists draw 3D by hand). The z0
value specifies the z value at which there is a 1:1 mapping between spatial coordinates and screen coordinates. Any points on this z value will not have their X and Y values modified in the transform. Those further away (Z value higher) will shrink into the distance, and those under this value will expand and become bigger. The foc
value determines the "focal length" of the camera. This is in reality the distance between the camera lens plane itself (at or closer than this rendering results are undefined) and the "z0" z value. This allows for some "depth" control and foc
must be greater than 0.
The coordinates are set relative to the given pivot
object. If its geometry changes, then the absolute position of the rotation center will change accordingly. The Z position is absolute. If the pivot
is null
then this object will be its own pivot.
(Since EFL 1.22)
Declaration
public virtual void Perspective3d(IEntity pivot, double px, double py, double z0, double foc)
Parameters
Type | Name | Description |
---|---|---|
Efl.Gfx.IEntity | pivot | A pivot object for the infinite point, can be |
System.Double | px | The perspective distance X relative coordinate. |
System.Double | py | The perspective distance Y relative coordinate. |
System.Double | z0 | The "0" Z plane value. |
System.Double | foc | The focal distance, must be greater than 0. |
Perspective3dAbsolute(Double, Double, Double, Double)
Apply a perspective transform to the map
This applies a given perspective (3D) to the map coordinates. X, Y and Z values are used. The px and py points specify the "infinite distance" point in the 3D conversion (where all lines converge to like when artists draw 3D by hand). The z0
value specifies the z value at which there is a 1:1 mapping between spatial coordinates and screen coordinates. Any points on this z value will not have their X and Y values modified in the transform. Those further away (Z value higher) will shrink into the distance, and those less than this value will expand and become bigger. The foc
value determines the "focal length" of the camera. This is in reality the distance between the camera lens plane itself (at or closer than this rendering results are undefined) and the "z0" z value. This allows for some "depth" control and foc
must be greater than 0.
The coordinates of the center point are given in absolute canvas coordinates. See also Efl.Gfx.IMapping.Perspective3d(Efl.Gfx.IEntity, System.Double, System.Double, System.Double, System.Double) for a pivot-based perspective effect. (Since EFL 1.22)
Declaration
public virtual void Perspective3dAbsolute(double px, double py, double z0, double foc)
Parameters
Type | Name | Description |
---|---|---|
System.Double | px | The perspective distance X relative coordinate. |
System.Double | py | The perspective distance Y relative coordinate. |
System.Double | z0 | The "0" Z plane value. |
System.Double | foc | The focal distance, must be greater than 0. |
RaiseToTop()
Raise obj
to the top of its layer.
obj
will, then, be the highest one in the layer it belongs to. Object on other layers won't get touched.
See also Efl.Gfx.IStack.StackAbove(Efl.Gfx.IStack), Efl.Gfx.IStack.StackBelow(Efl.Gfx.IStack) and Efl.Gfx.IStack.LowerToBottom() (Since EFL 1.22)
Declaration
public virtual void RaiseToTop()
ResetMapping()
Resets the map transformation to its default state.
This will reset all transformations to identity, meaning the points' colors, positions and UV coordinates will be reset to their default values. Efl.Gfx.IMapping.HasMapping() will then return false
. This function will not modify the values of Efl.Gfx.IMapping.MappingSmooth or Efl.Gfx.IMapping.MappingAlpha.
(Since EFL 1.22)
Declaration
public virtual void ResetMapping()
Rotate(Double, IEntity, Double, Double)
Apply a rotation to the object.
This rotates the object clockwise by degrees
degrees, around the center specified by the relative position (cx
, cy
) in the pivot
object. If pivot
is null
then this object is used as its own pivot center. 360 degrees is a full rotation, equivalent to no rotation. Negative values for degrees
will rotate clockwise by that amount.
The coordinates are set relative to the given pivot
object. If its geometry changes, then the absolute position of the rotation center will change accordingly.
By default, the center is at (0.5, 0.5). 0.0 means left or top while 1.0 means right or bottom of the pivot
object.
(Since EFL 1.22)
Declaration
public virtual void Rotate(double degrees, IEntity pivot, double cx, double cy)
Parameters
Type | Name | Description |
---|---|---|
System.Double | degrees | CCW rotation in degrees. |
Efl.Gfx.IEntity | pivot | A pivot object for the center point, can be |
System.Double | cx | X relative coordinate of the center point. |
System.Double | cy | y relative coordinate of the center point. |
Rotate3d(Double, Double, Double, IEntity, Double, Double, Double)
Rotate the object around 3 axes in 3D. This will rotate in 3D, not just around the "Z" axis as is the case with Efl.Gfx.IMapping.Rotate(System.Double, Efl.Gfx.IEntity, System.Double, System.Double). You can rotate around the X, Y and Z axes. The Z axis points "into" the screen with low values at the screen and higher values further away. The X axis runs from left to right on the screen and the Y axis from top to bottom.
As with Efl.Gfx.IMapping.Rotate(System.Double, Efl.Gfx.IEntity, System.Double, System.Double), you provide a pivot and center point to rotate around (in 3D). The Z coordinate of this center point is an absolute value, and not a relative one like X and Y, as objects are flat in a 2D space. (Since EFL 1.22)
Declaration
public virtual void Rotate3d(double dx, double dy, double dz, IEntity pivot, double cx, double cy, double cz)
Parameters
Type | Name | Description |
---|---|---|
System.Double | dx | Rotation in degrees around X axis (0 to 360). |
System.Double | dy | Rotation in degrees around Y axis (0 to 360). |
System.Double | dz | Rotation in degrees around Z axis (0 to 360). |
Efl.Gfx.IEntity | pivot | A pivot object for the center point, can be |
System.Double | cx | X relative coordinate of the center point. |
System.Double | cy | y relative coordinate of the center point. |
System.Double | cz | Z absolute coordinate of the center point. |
Rotate3dAbsolute(Double, Double, Double, Double, Double, Double)
Rotate the object around 3 axes in 3D, using absolute coordinates. This will rotate in 3D and not just around the "Z" axis as the case with Efl.Gfx.IMapping.Rotate(System.Double, Efl.Gfx.IEntity, System.Double, System.Double). This will rotate around the X, Y and Z axes. The Z axis points "into" the screen with low values at the screen and higher values further away. The X axis runs from left to right on the screen and the Y axis from top to bottom.
The coordinates of the center point are given in absolute canvas coordinates. See also Efl.Gfx.IMapping.Rotate3d(System.Double, System.Double, System.Double, Efl.Gfx.IEntity, System.Double, System.Double, System.Double) for a pivot-based 3D rotation. (Since EFL 1.22)
Declaration
public virtual void Rotate3dAbsolute(double dx, double dy, double dz, double cx, double cy, double cz)
Parameters
Type | Name | Description |
---|---|---|
System.Double | dx | Rotation in degrees around X axis (0 to 360). |
System.Double | dy | Rotation in degrees around Y axis (0 to 360). |
System.Double | dz | Rotation in degrees around Z axis (0 to 360). |
System.Double | cx | X absolute coordinate in pixels of the center point. |
System.Double | cy | y absolute coordinate in pixels of the center point. |
System.Double | cz | Z absolute coordinate of the center point. |
RotateAbsolute(Double, Double, Double)
Apply a rotation to the object, using absolute coordinates.
This rotates the object clockwise by degrees
degrees, around the center specified by the relative position (cx
, cy
) in the pivot
object. If pivot
is null
then this object is used as its own pivot center. 360 degrees is a full rotation, equivalent to no rotation. Negative values for degrees
will rotate clockwise by that amount.
The given coordinates are absolute values in pixels. See also Efl.Gfx.IMapping.Rotate(System.Double, Efl.Gfx.IEntity, System.Double, System.Double) for a relative coordinate version. (Since EFL 1.22)
Declaration
public virtual void RotateAbsolute(double degrees, double cx, double cy)
Parameters
Type | Name | Description |
---|---|---|
System.Double | degrees | CCW rotation in degrees. |
System.Double | cx | X absolute coordinate in pixels of the center point. |
System.Double | cy | y absolute coordinate in pixels of the center point. |
RotateQuat(Double, Double, Double, Double, IEntity, Double, Double, Double)
Rotate the object in 3D using a unit quaternion. This is similar to Efl.Gfx.IMapping.Rotate3d(System.Double, System.Double, System.Double, Efl.Gfx.IEntity, System.Double, System.Double, System.Double) but uses a unit quaternion (also known as versor) rather than a direct angle-based rotation around a center point. Use this to avoid gimbal locks.
As with Efl.Gfx.IMapping.Rotate(System.Double, Efl.Gfx.IEntity, System.Double, System.Double), you provide a pivot and center point to rotate around (in 3D). The Z coordinate of this center point is an absolute value, and not a relative one like X and Y, as objects are flat in a 2D space. (Since EFL 1.22)
Declaration
public virtual void RotateQuat(double qx, double qy, double qz, double qw, IEntity pivot, double cx, double cy, double cz)
Parameters
Type | Name | Description |
---|---|---|
System.Double | qx | The x component of the imaginary part of the quaternion. |
System.Double | qy | The y component of the imaginary part of the quaternion. |
System.Double | qz | The z component of the imaginary part of the quaternion. |
System.Double | qw | The w component of the real part of the quaternion. |
Efl.Gfx.IEntity | pivot | A pivot object for the center point, can be |
System.Double | cx | X relative coordinate of the center point. |
System.Double | cy | y relative coordinate of the center point. |
System.Double | cz | Z absolute coordinate of the center point. |
RotateQuatAbsolute(Double, Double, Double, Double, Double, Double, Double)
Rotate the object in 3D using a unit quaternion, using absolute coordinates. This is similar to Efl.Gfx.IMapping.Rotate3d(System.Double, System.Double, System.Double, Efl.Gfx.IEntity, System.Double, System.Double, System.Double) but uses a unit quaternion (also known as versor) rather than a direct angle-based rotation around a center point. Use this to avoid gimbal locks.
The coordinates of the center point are given in absolute canvas coordinates. See also Efl.Gfx.IMapping.RotateQuat(System.Double, System.Double, System.Double, System.Double, Efl.Gfx.IEntity, System.Double, System.Double, System.Double) for a pivot-based 3D rotation. (Since EFL 1.22)
Declaration
public virtual void RotateQuatAbsolute(double qx, double qy, double qz, double qw, double cx, double cy, double cz)
Parameters
Type | Name | Description |
---|---|---|
System.Double | qx | The x component of the imaginary part of the quaternion. |
System.Double | qy | The y component of the imaginary part of the quaternion. |
System.Double | qz | The z component of the imaginary part of the quaternion. |
System.Double | qw | The w component of the real part of the quaternion. |
System.Double | cx | X absolute coordinate in pixels of the center point. |
System.Double | cy | y absolute coordinate in pixels of the center point. |
System.Double | cz | Z absolute coordinate of the center point. |
SetAntiAlias(Boolean)
Whether or not the given Evas object is to be drawn anti-aliased. (Since EFL 1.22)
Declaration
public virtual void SetAntiAlias(bool anti_alias)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | anti_alias |
|
SetClipper(Object)
Clip one object to another.
This property will clip the object obj
to the area occupied by the object clip
. This means the object obj
will only be visible within the area occupied by the clipping object (clip
).
The color of the object being clipped will be multiplied by the color of the clipping one, so the resulting color for the former will be "RESULT = (OBJ * CLIP) / (255 * 255)", per color element (red, green, blue and alpha).
Clipping is recursive, so clipping objects may be clipped by others, and their color will in term be multiplied. You may not set up circular clipping lists (i.e. object 1 clips object 2, which clips object 1): the behavior of Evas is undefined in this case.
Objects which do not clip others are visible in the canvas as normal; those that clip one or more objects become invisible themselves, only affecting what they clip. If an object ceases to have other objects being clipped by it, it will become visible again.
The visibility of an object affects the objects that are clipped by it, so if the object clipping others is not shown (as in Efl.Gfx.IEntity.Visible), the objects clipped by it will not be shown either.
If obj
was being clipped by another object when this function is called, it gets implicitly removed from the old clipper's domain and is made now to be clipped by its new clipper.
If clip
is null
, this call will disable clipping for the object i.e. its visibility and color get detached from the previous clipper. If it wasn't, this has no effect.
Note: Only rectangle and image (masks) objects can be used as clippers. Anything else will result in undefined behaviour. (Since EFL 1.22)
Declaration
public virtual void SetClipper(Object clipper)
Parameters
Type | Name | Description |
---|---|---|
Efl.Canvas.Object | clipper | The object to clip |
SetColor(Int32, Int32, Int32, Int32)
The general/main color of the given Evas object. Represents the main color's RGB component (and alpha channel) values, which range from 0 to 255. For the alpha channel, which defines the object's transparency level, 0 means totally transparent, while 255 means opaque. These color values are premultiplied by the alpha value.
Usually you'll use this attribute for text and rectangle objects, where the main color is the only color. If set for objects which themselves have colors, like the images one, those colors get modulated by this one.
All newly created Evas rectangles get the default color values of 255 255 255 255 (opaque white).
When reading this property, use NULL
pointers on the components you're not interested in and they'll be ignored by the function.
(Since EFL 1.22)
Declaration
public virtual void SetColor(int r, int g, int b, int a)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | r | |
System.Int32 | g | |
System.Int32 | b | |
System.Int32 | a |
SetColorCode(String)
Hexadecimal color code of given Evas object (#RRGGBBAA). (Since EFL 1.22)
Declaration
public virtual void SetColorCode(string colorcode)
Parameters
Type | Name | Description |
---|---|---|
System.String | colorcode | the hex color code. |
SetGeometry(Rect)
Rectangular geometry that combines both position and size. (Since EFL 1.22)
Declaration
public virtual void SetGeometry(Rect rect)
Parameters
Type | Name | Description |
---|---|---|
Eina.Rect | rect | The X,Y position and W,H size, in pixels. |
SetHintAlign(Double, Double)
Hints for an object's alignment. These are hints on how to align an object inside the boundaries of a container/manager. Accepted values are in the 0.0 to 1.0 range.
For the horizontal component, 0.0 means the start of the axis in the direction that the current language reads, 1.0 means the end of the axis.
For the vertical component, 0.0 to the top, 1.0 means to the bottom.
This is not a size enforcement in any way, it's just a hint that should be used whenever appropriate.
Note: Default alignment hint values are 0.5, for both axes. (Since EFL 1.22)
Declaration
public virtual void SetHintAlign(double x, double y)
Parameters
Type | Name | Description |
---|---|---|
System.Double | x | Double, ranging from 0.0 to 1.0, where 0.0 is at the start of the horizontal axis and 1.0 is at the end. |
System.Double | y | Double, ranging from 0.0 to 1.0, where 0.0 is at the start of the vertical axis and 1.0 is at the end. |
SetHintAspect(HintAspect, Size2D)
Defines the aspect ratio to respect when scaling this object. The aspect ratio is defined as the width / height ratio of the object. Depending on the object and its container, this hint may or may not be fully respected.
If any of the given aspect ratio terms are 0, the object's container will ignore the aspect and scale this object to occupy the whole available area, for any given policy. (Since EFL 1.22)
Declaration
public virtual void SetHintAspect(HintAspect mode, Size2D sz)
Parameters
Type | Name | Description |
---|---|---|
Efl.Gfx.HintAspect | mode | Mode of interpretation. |
Eina.Size2D | sz | Base size to use for aspecting. |
SetHintFill(Boolean, Boolean)
Hints for an object's fill property that used to specify "justify" or "fill" by some users. Efl.Gfx.IHint.GetHintFill(out System.Boolean, out System.Boolean) specify whether to fill the space inside the boundaries of a container/manager. Maximum hints should be enforced with higher priority, if they are set. Also, any Efl.Gfx.IHint.GetHintMargin(out System.Int32, out System.Int32, out System.Int32, out System.Int32) set on objects should add up to the object space on the final scene composition.
See documentation of possible users: in Evas, they are the Efl.Ui.Box "box" and Efl.Ui.Table "table" smart objects.
This is not a size enforcement in any way, it's just a hint that should be used whenever appropriate.
Note: Default fill hint values are true, for both axes. (Since EFL 1.22)
Declaration
public virtual void SetHintFill(bool x, bool y)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | x |
|
System.Boolean | y |
|
SetHintMargin(Int32, Int32, Int32, Int32)
Hints for an object's margin or padding space. This is not a size enforcement in any way, it's just a hint that should be used whenever appropriate.
The object container is in charge of fetching this property and placing the object accordingly.
Note: Smart objects (such as elementary) can have their own hint policy. So calling this API may or may not affect the size of smart objects. (Since EFL 1.22)
Declaration
public virtual void SetHintMargin(int l, int r, int t, int b)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | l | Integer to specify left padding. |
System.Int32 | r | Integer to specify right padding. |
System.Int32 | t | Integer to specify top padding. |
System.Int32 | b | Integer to specify bottom padding. |
SetHintSizeMax(Size2D)
Hints on the object's maximum size. This is not a size enforcement in any way, it's just a hint that should be used whenever appropriate.
The object container is in charge of fetching this property and placing the object accordingly.
Values -1 will be treated as unset hint components, when queried by managers.
Note: Smart objects (such as elementary) can have their own hint policy. So calling this API may or may not affect the size of smart objects.
Note: It is an error for the Efl.Gfx.IHint.HintSizeMax to be smaller in either axis than Efl.Gfx.IHint.HintSizeMin. In this scenario, the max size hint will be prioritized over the user min size hint. (Since EFL 1.22)
Declaration
public virtual void SetHintSizeMax(Size2D sz)
Parameters
Type | Name | Description |
---|---|---|
Eina.Size2D | sz | Maximum size (hint) in pixels, (-1, -1) by default for canvas objects). |
SetHintSizeMin(Size2D)
Hints on the object's minimum size. This is not a size enforcement in any way, it's just a hint that should be used whenever appropriate. The object container is in charge of fetching this property and placing the object accordingly.
Value 0 will be treated as unset hint components, when queried by managers.
Note: This property is meant to be set by applications and not by EFL itself. Use this to request a specific size (treated as minimum size).
Note: It is an error for the Efl.Gfx.IHint.HintSizeMax to be smaller in either axis than Efl.Gfx.IHint.HintSizeMin. In this scenario, the max size hint will be prioritized over the user min size hint. (Since EFL 1.22)
Declaration
public virtual void SetHintSizeMin(Size2D sz)
Parameters
Type | Name | Description |
---|---|---|
Eina.Size2D | sz | Minimum size (hint) in pixels. |
SetHintSizeRestrictedMax(Size2D)
This function is protected as it is meant for widgets to indicate their "intrinsic" maximum size. (Since EFL 1.22)
Declaration
protected virtual void SetHintSizeRestrictedMax(Size2D sz)
Parameters
Type | Name | Description |
---|---|---|
Eina.Size2D | sz | Maximum size (hint) in pixels. |
SetHintSizeRestrictedMin(Size2D)
This function is protected as it is meant for widgets to indicate their "intrinsic" minimum size. (Since EFL 1.22)
Declaration
protected virtual void SetHintSizeRestrictedMin(Size2D sz)
Parameters
Type | Name | Description |
---|---|---|
Eina.Size2D | sz | Minimum size (hint) in pixels. |
SetHintWeight(Double, Double)
Hints for an object's weight. This is a hint on how a container object should resize a given child within its area. Containers may adhere to the simpler logic of just expanding the child object's dimensions to fit its own (see the Efl.Gfx.Constants.HintExpand helper weight macro) or the complete one of taking each child's weight hint as real weights to how much of its size to allocate for them in each axis. A container is supposed to, after normalizing the weights of its children (with weight hints), distribut the space it has to layout them by those factors -- most weighted children get larger in this process than the least ones.
Accepted values are zero or positive values. Some containers might use this hint as a boolean, but some others might consider it as a proportion, see documentation of each container.
Note: Default weight hint values are 0.0, for both axis. (Since EFL 1.22)
Declaration
public virtual void SetHintWeight(double x, double y)
Parameters
Type | Name | Description |
---|---|---|
System.Double | x | Non-negative double value to use as horizontal weight hint. |
System.Double | y | Non-negative double value to use as vertical weight hint. |
SetKeyFocus(Boolean)
Indicates that this object is the keyboard event receiver on its canvas.
Changing focus only affects where (key) input events go. There can be only one object focused at any time. If focus
is true
, obj
will be set as the currently focused object and it will receive all keyboard events that are not exclusive key grabs on other objects. See also Efl.Canvas.Object.CheckSeatFocus (object still in beta stage), Efl.Canvas.Object.AddSeatFocus (object still in beta stage), Efl.Canvas.Object.DelSeatFocus (object still in beta stage).
(Since EFL 1.22)
Declaration
public virtual void SetKeyFocus(bool focus)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | focus |
|
SetLayer(Int16)
The layer of its canvas that the given object will be part of. If you don't use this property, you'll be dealing with a unique layer of objects (the default one). Additional layers are handy when you don't want a set of objects to interfere with another set with regard to stacking. Two layers are completely disjoint in that matter.
This is a low-level function, which you'd be using when something should be always on top, for example.
Warning: Don't change the layer of smart objects' children. Smart objects have a layer of their own, which should contain all their child objects. (Since EFL 1.22)
Declaration
public virtual void SetLayer(short l)
Parameters
Type | Name | Description |
---|---|---|
System.Int16 | l | The number of the layer to place the object on. Must be between Efl.Gfx.Constants.StackLayerMin and Efl.Gfx.Constants.StackLayerMax. |
SetMappingAlpha(Boolean)
Alpha flag for map rendering. This sets alpha flag for map rendering. If the object is a type that has its own alpha settings, then this will take precedence. Only image objects support this currently (Efl.Canvas.Image (object still in beta stage) and its friends). Setting this to off stops alpha blending of the map area, and is useful if you know the object and/or all sub-objects is 100% solid.
Note that this may conflict with Efl.Gfx.IMapping.MappingSmooth depending on which algorithm is used for anti-aliasing. (Since EFL 1.22)
Declaration
public virtual void SetMappingAlpha(bool alpha)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | alpha |
|
SetMappingColor(Int32, Int32, Int32, Int32, Int32)
Color of a vertex in the map. This sets the color of the vertex in the map. Colors will be linearly interpolated between vertex points through the map. Color will multiply the "texture" pixels (like GL_MODULATE in OpenGL). The default color of a vertex in a map is white solid (255, 255, 255, 255) which means it will have no affect on modifying the texture pixels.
The color values must be premultiplied (ie. a
>= {r
, g
, b
}).
(Since EFL 1.22)
Declaration
public virtual void SetMappingColor(int idx, int r, int g, int b, int a)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | idx | ID of the point, from 0 to 3 (included). -1 can be used to set the color for all points, but it is invalid for get(). |
System.Int32 | r | Red (0 - 255) |
System.Int32 | g | Green (0 - 255) |
System.Int32 | b | Blue (0 - 255) |
System.Int32 | a | Alpha (0 - 255) |
SetMappingCoordAbsolute(Int32, Double, Double, Double)
A point's absolute coordinate on the canvas. This sets/gets the fixed point's coordinate in the map. Note that points describe the outline of a quadrangle and are ordered either clockwise or counter-clockwise. Try to keep your quadrangles concave and non-complex. Though these polygon modes may work, they may not render a desired set of output. The quadrangle will use points 0 and 1 , 1 and 2, 2 and 3, and 3 and 0 to describe the edges of the quadrangle.
The X and Y and Z coordinates are in canvas units. Z is optional and may or may not be honored in drawing. Z is a hint and does not affect the X and Y rendered coordinates. It may be used for calculating fills with perspective correct rendering.
Remember all coordinates are canvas global ones as with move and resize in the canvas.
This property can be read to get the 4 points positions on the canvas, or set to manually place them. (Since EFL 1.22)
Declaration
public virtual void SetMappingCoordAbsolute(int idx, double x, double y, double z)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | idx | ID of the point, from 0 to 3 (included). |
System.Double | x | Point X coordinate in absolute pixel coordinates. |
System.Double | y | Point Y coordinate in absolute pixel coordinates. |
System.Double | z | Point Z coordinate hint (pre-perspective transform). |
SetMappingPointCount(Int32)
Number of points of a map. This sets the number of points of map. Currently, the number of points must be multiples of 4. (Since EFL 1.22)
Declaration
public virtual void SetMappingPointCount(int count)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | count | The number of points of map |
SetMappingSmooth(Boolean)
Smoothing state for map rendering. This sets smoothing for map rendering. If the object is a type that has its own smoothing settings, then both the smooth settings for this object and the map must be turned off. By default smooth maps are enabled. (Since EFL 1.22)
Declaration
public virtual void SetMappingSmooth(bool smooth)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | smooth |
|
SetMappingUv(Int32, Double, Double)
Map point's U and V texture source point. This sets/gets the U and V coordinates for the point. This determines which coordinate in the source image is mapped to the given point, much like OpenGL and textures. Valid values range from 0.0 to 1.0.
By default the points are set in a clockwise order, as such: - 0: top-left, i.e. (0.0, 0.0), - 1: top-right, i.e. (1.0, 0.0), - 2: bottom-right, i.e. (1.0, 1.0), - 3: bottom-left, i.e. (0.0, 1.0). (Since EFL 1.22)
Declaration
public virtual void SetMappingUv(int idx, double u, double v)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | idx | ID of the point, from 0 to 3 (included). |
System.Double | u | Relative X coordinate within the image, from 0 to 1. |
System.Double | v | Relative Y coordinate within the image, from 0 to 1. |
SetNoRender(Boolean)
Disables all rendering on the canvas. This flag will be used to indicate to Evas that this object should never be rendered on the canvas under any circumstances. In particular, this is useful to avoid drawing clipper objects (or masks) even when they don't clip any object. This can also be used to replace the old source_visible flag with proxy objects.
This is different to the visible property, as even visible objects marked as "no-render" will never appear on screen. But those objects can still be used as proxy sources or clippers. When hidden, all "no-render" objects will completely disappear from the canvas, and hide their clippees or be invisible when used as proxy sources. (Since EFL 1.22)
Declaration
public virtual void SetNoRender(bool enable)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enable | Enable "no-render" mode. |
SetParagraphDirection(TextBidirectionalType)
This handles text paragraph direction of the given object. Even if the given object is not textblock or text, its smart child objects can inherit the paragraph direction from the given object. The default paragraph direction is inherit
.
(Since EFL 1.22)
Declaration
public virtual void SetParagraphDirection(TextBidirectionalType dir)
Parameters
Type | Name | Description |
---|---|---|
Efl.TextBidirectionalType | dir | Paragraph direction for the given object. |
SetPassEvents(Boolean)
Whether an Evas object is to pass (ignore) events.
If pass
is true
, it will make events on obj
to be ignored. They will be triggered on the next lower object (that is not set to pass events), instead (see Efl.Gfx.IStack.GetBelow()).
If pass
is false
events will be processed on that object as normal.
See also Efl.Canvas.Object.SetRepeatEvents(System.Boolean), Efl.Canvas.Object.SetPropagateEvents(System.Boolean) (Since EFL 1.22)
Declaration
public virtual void SetPassEvents(bool pass)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | pass | Whether |
SetPosition(Position2D)
Moves the given canvas object to the given location inside its canvas' viewport. If unchanged this call may be entirely skipped, but if changed this will trigger move events, as well as potential pointer,in or pointer,out events. (Since EFL 1.22)
Declaration
public virtual void SetPosition(Position2D pos)
Parameters
Type | Name | Description |
---|---|---|
Eina.Position2D | pos | A 2D coordinate in pixel units. |
SetPreciseIsInside(Boolean)
Whether to use precise (usually expensive) point collision detection for a given Evas object. Use this property to make Evas treat objects' transparent areas as not belonging to it with regard to mouse pointer events. By default, all of the object's boundary rectangle will be taken in account for them.
Warning: By using precise point collision detection you'll be making Evas more resource intensive. (Since EFL 1.22)
Declaration
public virtual void SetPreciseIsInside(bool precise)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | precise | Whether to use precise point collision detection. |
SetPropagateEvents(Boolean)
Whether events on a smart object's member should be propagated up to its parent.
This function has no effect if obj
is not a member of a smart object.
If prop
is true
, events occurring on this object will be propagated on to the smart object of which obj
is a member. If prop
is false
, events occurring on this object will not be propagated on to the smart object of which obj
is a member.
See also Efl.Canvas.Object.SetRepeatEvents(System.Boolean), Efl.Canvas.Object.SetPassEvents(System.Boolean). (Since EFL 1.22)
Declaration
public virtual void SetPropagateEvents(bool propagate)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | propagate | Whether to propagate events. |
SetRenderOp(RenderOp)
Render mode to be used for compositing the Evas object. Only two modes are supported: - Efl.Gfx.RenderOp.Blend means the object will be merged on top of objects below it using simple alpha compositing. - Efl.Gfx.RenderOp.Copy means this object's pixels will replace everything that is below, making this object opaque.
Please do not assume that Efl.Gfx.RenderOp.Copy mode can be used to "poke" holes in a window (to see through it), as only the compositor can ensure that. Copy mode should only be used with otherwise opaque widgets or inside non-window surfaces (e.g. a transparent background inside a buffer canvas). (Since EFL 1.22)
Declaration
public virtual void SetRenderOp(RenderOp render_op)
Parameters
Type | Name | Description |
---|---|---|
Efl.Gfx.RenderOp | render_op | Blend or copy. |
SetRepeatEvents(Boolean)
Whether an Evas object is to repeat events to objects below it.
If repeat
is true
, it will make events on obj
to also be repeated for the next lower object in the objects' stack (see see Efl.Gfx.IStack.GetBelow()).
If repeat
is false
, events occurring on obj
will be processed only on it.
(Since EFL 1.22)
Declaration
public virtual void SetRepeatEvents(bool repeat)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | repeat | Whether |
SetScale(Double)
Sets the scaling factor of an object. (Since EFL 1.22)
Declaration
public virtual void SetScale(double scale)
Parameters
Type | Name | Description |
---|---|---|
System.Double | scale | The scaling factor. |
SetSize(Size2D)
Changes the size of the given object. Note that setting the actual size of an object might be the job of its container, so this function might have no effect. Look at Efl.Gfx.IHint instead, when manipulating widgets. (Since EFL 1.22)
Declaration
public virtual void SetSize(Size2D size)
Parameters
Type | Name | Description |
---|---|---|
Eina.Size2D | size | A 2D size in pixel units. |
SetVisible(Boolean)
Shows or hides this object. (Since EFL 1.22)
Declaration
public virtual void SetVisible(bool v)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | v |
|
StackAbove(IStack)
Stack obj
immediately above
Objects, in a given canvas, are stacked in the order they're added. This means that, if they overlap, the highest ones will cover the lowest ones, in that order. This function is a way to change the stacking order for the objects.
Its intended to be used with objects belonging to the same layer in a given canvas, otherwise it will fail (and accomplish nothing).
If you have smart objects on your canvas and obj
is a member of one of them, then above
must also be a member of the same smart object.
Similarly, if obj
is not a member of a smart object, above
must not be either.
See also Efl.Gfx.IStack.GetLayer(), Efl.Gfx.IStack.SetLayer(System.Int16) and Efl.Gfx.IStack.StackBelow(Efl.Gfx.IStack) (Since EFL 1.22)
Declaration
public virtual void StackAbove(IStack above)
Parameters
Type | Name | Description |
---|---|---|
Efl.Gfx.IStack | above | The object above which to stack |
StackBelow(IStack)
Stack obj
immediately below
Objects, in a given canvas, are stacked in the order they're added. This means that, if they overlap, the highest ones will cover the lowest ones, in that order. This function is a way to change the stacking order for the objects.
Its intended to be used with objects belonging to the same layer in a given canvas, otherwise it will fail (and accomplish nothing).
If you have smart objects on your canvas and obj
is a member of one of them, then below
must also be a member of the same smart object.
Similarly, if obj
is not a member of a smart object, below
must not be either.
See also Efl.Gfx.IStack.GetLayer(), Efl.Gfx.IStack.SetLayer(System.Int16) and Efl.Gfx.IStack.StackBelow(Efl.Gfx.IStack) (Since EFL 1.22)
Declaration
public virtual void StackBelow(IStack below)
Parameters
Type | Name | Description |
---|---|---|
Efl.Gfx.IStack | below | The object below which to stack |
Translate(Double, Double, Double)
Apply a translation to the object using map. This does not change the real geometry of the object but will affect its visible position. (Since EFL 1.22)
Declaration
public virtual void Translate(double dx, double dy, double dz)
Parameters
Type | Name | Description |
---|---|---|
System.Double | dx | Distance in pixels along the X axis. |
System.Double | dy | Distance in pixels along the Y axis. |
System.Double | dz | Distance in pixels along the Z axis. |
UngrabKey(String, Modifier, Modifier)
Removes the grab on keyname
key events by obj
.
Removes a key grab on obj
if keyname
, modifiers
, and not_modifiers
match.
See also Efl.Canvas.Object.GrabKey(System.String, Efl.Input.Modifier, Efl.Input.Modifier, System.Boolean), Efl.Canvas.Object.GetKeyFocus(), Efl.Canvas.Object.SetKeyFocus(System.Boolean), and the legacy API evas_focus_get. (Since EFL 1.22)
Declaration
public virtual void UngrabKey(string keyname, Modifier modifiers, Modifier not_modifiers)
Parameters
Type | Name | Description |
---|---|---|
System.String | keyname | The key the grab is set for. |
Efl.Input.Modifier | modifiers | A mask of modifiers that must be present to trigger the event. |
Efl.Input.Modifier | not_modifiers | A mask of modifiers that must not not be present to trigger the event. |
Zoom(Double, Double, IEntity, Double, Double)
Apply a zoom to the object.
This zooms the points of the map from a center point. That center is defined by cx
and cy
. The zoomx
and zoomy
parameters specify how much to zoom in the X and Y direction respectively. A value of 1.0 means "don't zoom". 2.0 means "double the size". 0.5 is "half the size" etc.
By default, the center is at (0.5, 0.5). 0.0 means left or top while 1.0 means right or bottom. (Since EFL 1.22)
Declaration
public virtual void Zoom(double zoomx, double zoomy, IEntity pivot, double cx, double cy)
Parameters
Type | Name | Description |
---|---|---|
System.Double | zoomx | Zoom in X direction |
System.Double | zoomy | Zoom in Y direction |
Efl.Gfx.IEntity | pivot | A pivot object for the center point, can be |
System.Double | cx | X relative coordinate of the center point. |
System.Double | cy | y relative coordinate of the center point. |
ZoomAbsolute(Double, Double, Double, Double)
Apply a zoom to the object, using absolute coordinates.
This zooms the points of the map from a center point. That center is defined by cx
and cy
. The zoomx
and zoomy
parameters specify how much to zoom in the X and Y direction respectively. A value of 1.0 means "don't zoom". 2.0 means "double the size". 0.5 is "half the size" etc.
The coordinates of the center point are given in absolute canvas coordinates. See also Efl.Gfx.IMapping.Zoom(System.Double, System.Double, Efl.Gfx.IEntity, System.Double, System.Double) for a pivot-based zoom. (Since EFL 1.22)
Declaration
public virtual void ZoomAbsolute(double zoomx, double zoomy, double cx, double cy)
Parameters
Type | Name | Description |
---|---|---|
System.Double | zoomx | Zoom in X direction |
System.Double | zoomy | Zoom in Y direction |
System.Double | cx | X absolute coordinate in pixels of the center point. |
System.Double | cy | y absolute coordinate in pixels of the center point. |
Events
AnimatorTickEvent
Animator tick synchronized with screen vsync if possible. (Since EFL 1.22)
Declaration
public event EventHandler<ObjectAnimatorTickEventArgs> AnimatorTickEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Canvas.ObjectAnimatorTickEventArgs> |
FingerDownEvent
Finger pressed (finger id is known).
Declaration
public event EventHandler<InterfaceFingerDownEventArgs> FingerDownEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Input.InterfaceFingerDownEventArgs> |
FingerMoveEvent
Finger moved (current and previous positions are known).
Declaration
public event EventHandler<InterfaceFingerMoveEventArgs> FingerMoveEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Input.InterfaceFingerMoveEventArgs> |
FingerUpEvent
Finger released (finger id is known).
Declaration
public event EventHandler<InterfaceFingerUpEventArgs> FingerUpEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Input.InterfaceFingerUpEventArgs> |
FocusInEvent
A focus in event.
Declaration
public event EventHandler<InterfaceFocusInEventArgs> FocusInEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Input.InterfaceFocusInEventArgs> |
FocusOutEvent
A focus out event.
Declaration
public event EventHandler<InterfaceFocusOutEventArgs> FocusOutEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Input.InterfaceFocusOutEventArgs> |
HintsChangedEvent
Object hints changed. (Since EFL 1.22)
Declaration
public event EventHandler HintsChangedEvent
Event Type
Type | Description |
---|---|
System.EventHandler |
HoldEvent
All input events are on hold or resumed.
Declaration
public event EventHandler<InterfaceHoldEventArgs> HoldEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Input.InterfaceHoldEventArgs> |
KeyDownEvent
Keyboard key press.
Declaration
public event EventHandler<InterfaceKeyDownEventArgs> KeyDownEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Input.InterfaceKeyDownEventArgs> |
KeyUpEvent
Keyboard key release.
Declaration
public event EventHandler<InterfaceKeyUpEventArgs> KeyUpEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Input.InterfaceKeyUpEventArgs> |
PointerAxisEvent
Pen or other axis event update.
Declaration
public event EventHandler<InterfacePointerAxisEventArgs> PointerAxisEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Input.InterfacePointerAxisEventArgs> |
PointerCancelEvent
Main pointer button press was cancelled (button id is known). This can happen in rare cases when the window manager passes the focus to a more urgent window, for instance. You probably don't need to listen to this event, as it will be accompanied by an up event.
Declaration
public event EventHandler<InterfacePointerCancelEventArgs> PointerCancelEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Input.InterfacePointerCancelEventArgs> |
PointerDownEvent
Main pointer button pressed (button id is known).
Declaration
public event EventHandler<InterfacePointerDownEventArgs> PointerDownEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Input.InterfacePointerDownEventArgs> |
PointerInEvent
Pointer entered a window or a widget.
Declaration
public event EventHandler<InterfacePointerInEventArgs> PointerInEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Input.InterfacePointerInEventArgs> |
PointerMoveEvent
Main pointer move (current and previous positions are known).
Declaration
public event EventHandler<InterfacePointerMoveEventArgs> PointerMoveEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Input.InterfacePointerMoveEventArgs> |
PointerOutEvent
Pointer left a window or a widget.
Declaration
public event EventHandler<InterfacePointerOutEventArgs> PointerOutEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Input.InterfacePointerOutEventArgs> |
PointerUpEvent
Main pointer button released (button id is known).
Declaration
public event EventHandler<InterfacePointerUpEventArgs> PointerUpEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Input.InterfacePointerUpEventArgs> |
PointerWheelEvent
Mouse wheel event.
Declaration
public event EventHandler<InterfacePointerWheelEventArgs> PointerWheelEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Input.InterfacePointerWheelEventArgs> |
PositionChangedEvent
Object was moved, its position during the event is the new one. (Since EFL 1.22)
Declaration
public event EventHandler<EntityPositionChangedEventArgs> PositionChangedEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Gfx.EntityPositionChangedEventArgs> |
SizeChangedEvent
Object was resized, its size during the event is the new one. (Since EFL 1.22)
Declaration
public event EventHandler<EntitySizeChangedEventArgs> SizeChangedEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Gfx.EntitySizeChangedEventArgs> |
StackingChangedEvent
Object stacking was changed. (Since EFL 1.22)
Declaration
public event EventHandler StackingChangedEvent
Event Type
Type | Description |
---|---|
System.EventHandler |
VisibilityChangedEvent
Object's visibility state changed, the event value is the new state. (Since EFL 1.22)
Declaration
public event EventHandler<EntityVisibilityChangedEventArgs> VisibilityChangedEvent
Event Type
Type | Description |
---|---|
System.EventHandler<Efl.Gfx.EntityVisibilityChangedEventArgs> |