Class Widget
Definition
- Namespace:
- ElmSharp
- Assembly:
- ElmSharp.dll
The Widget is an abstract class and the parent of other widgets. Inherits from EvasObject.
public abstract class Widget : AccessibleObject, IAccessibleObject
- Inheritance
- Derived
- Implements
Constructors
View SourceWidget()
Creates and initializes a new instance of the Widget class.
Declaration
protected Widget()
Widget(EvasObject)
Creates and initializes a new instance of the Widget class.
Declaration
protected Widget(EvasObject parent)
Parameters
Type | Name | Description |
---|---|---|
EvasObject | parent | The parent of the new Widget instance. |
Properties
View SourceAllowTreeFocus
Sets or gets whether a widget and its children are focusable or not.
Declaration
public bool AllowTreeFocus { get; set; }
Property Value
Type | Description |
---|---|
bool |
BackgroundColor
Sets or gets the background color of the widget.
Declaration
public virtual Color BackgroundColor { get; set; }
Property Value
Type | Description |
---|---|
Color |
Remarks
It could be overridden by special child class.
IsAutoMirroredMode
Sets or gets the widget's mirrored mode setting. When widget is set to automatic mode(true), it follows the system mirrored mode.
Declaration
public bool IsAutoMirroredMode { get; set; }
Property Value
Type | Description |
---|---|
bool |
IsEnabled
Sets or gets the state of the widget, which might be enabled or disabled.
Declaration
public virtual bool IsEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool |
IsFocusAllowed
Gets whether a widget is focusable or not.
Declaration
public bool IsFocusAllowed { get; }
Property Value
Type | Description |
---|---|
bool |
Remarks
Widgets which are meant to be interacted with by input events, are created able to be focused by default.
IsFocused
Gets whether this widget is focused.
Declaration
public bool IsFocused { get; }
Property Value
Type | Description |
---|---|
bool |
IsMirroredMode
Sets or gets the widget's mirrored mode.
Declaration
public bool IsMirroredMode { get; set; }
Property Value
Type | Description |
---|---|
bool |
Opacity
Sets or gets the opacity of the widget.
Declaration
public virtual int Opacity { get; set; }
Property Value
Type | Description |
---|---|
int |
Remarks
It could be overridden by special child class.
Style
Sets or gets the style of the widget.
Declaration
public string Style { get; set; }
Property Value
Type | Description |
---|---|
string |
Text
Sets or gets the text of the widget.
Declaration
public virtual string Text { get; set; }
Property Value
Type | Description |
---|---|
string |
Remarks
It could be overridden by special child class.
Methods
View SourceAllowFocus(bool)
Sets the ability for a widget to be focused.
Declaration
public void AllowFocus(bool isAllowFocus)
Parameters
Type | Name | Description |
---|---|---|
bool | isAllowFocus | true if the object can be focused, false if not(and on errors). |
FocusNext(FocusDirection)
Gives focus to the next widget in the widget tree.
Declaration
public void FocusNext(FocusDirection direction)
Parameters
Type | Name | Description |
---|---|---|
FocusDirection | direction | Direction to move the focus. |
GetPartColor(string)
Gets color of the particular part of the widget.
Declaration
public virtual Color GetPartColor(string part)
Parameters
Type | Name | Description |
---|---|---|
string | part | The name of the particular part. |
Returns
Type | Description |
---|---|
Color | The color of the particular part. |
Remarks
This method is a virtual method, it could be overridden by special child class.
GetPartOpacity(string)
Gets opacity of the particular part of the widget.
Declaration
public int GetPartOpacity(string part)
Parameters
Type | Name | Description |
---|---|---|
string | part | The name of the particular part. |
Returns
Type | Description |
---|---|
int | Opacity value of the particular part. |
GetPartText(string)
Gets text of a particular part of the widget.
Declaration
public virtual string GetPartText(string part)
Parameters
Type | Name | Description |
---|---|---|
string | part | The name of the particular part. |
Returns
Type | Description |
---|---|
string | Text of the particular part of the widget. |
OnRealized()
The callback of the Realized event.
Declaration
protected override void OnRealized()
Overrides
View SourceSetContent(EvasObject, bool)
Sets content to the widget.
Declaration
public void SetContent(EvasObject content, bool preserveOldContent)
Parameters
Type | Name | Description |
---|---|---|
EvasObject | content | The content. |
bool | preserveOldContent | true, preserve old content will be unset and not be deleted. false, preserve old content will be deleted. |
See Also
View SourceSetContent(EvasObject)
Sets content to the widget, and the preserve old content will be deleted.
Declaration
public void SetContent(EvasObject content)
Parameters
Type | Name | Description |
---|---|---|
EvasObject | content | The content. |
See Also
View SourceSetFocus(bool)
Sets the widget to be focused or not.
Declaration
public void SetFocus(bool isFocus)
Parameters
Type | Name | Description |
---|---|---|
bool | isFocus | Whether be focused. |
SetNextFocusObject(EvasObject, FocusDirection)
Sets the next widget with specific focus direction.
Declaration
public void SetNextFocusObject(EvasObject next, FocusDirection direction)
Parameters
Type | Name | Description |
---|---|---|
EvasObject | next | Focus next widget. |
FocusDirection | direction | Focus direction. |
SetPartColor(string, Color)
Sets color of a particular part of the widget.
Declaration
public virtual void SetPartColor(string part, Color color)
Parameters
Type | Name | Description |
---|---|---|
string | part | The name of the particular part. |
Color | color | The color to be set to the widget. |
Remarks
This method is a virtual method, it could be overridden by special child class.
SetPartContent(string, EvasObject, bool)
Sets content to the particular part of the widget.
Declaration
public virtual bool SetPartContent(string part, EvasObject content, bool preserveOldContent)
Parameters
Type | Name | Description |
---|---|---|
string | part | The name of the particular part. |
EvasObject | content | The content. |
bool | preserveOldContent | true, preserve old content will be unset and not be deleted. false, preserve old content will be deleted. |
Returns
Type | Description |
---|---|
bool |
See Also
View SourceSetPartContent(string, EvasObject)
Sets content to the particular part of the widget, and the preserve old content will be deleted.
Declaration
public virtual bool SetPartContent(string part, EvasObject content)
Parameters
Type | Name | Description |
---|---|---|
string | part | The name of the particular part. |
EvasObject | content | The content. |
Returns
Type | Description |
---|---|
bool |
See Also
View SourceSetPartOpacity(string, int)
Sets opacity of the particular part of the widget.
Declaration
public void SetPartOpacity(string part, int opacity)
Parameters
Type | Name | Description |
---|---|---|
string | part | The name of the particular part. |
int | opacity | The opacity of the particular part. |
SetPartText(string, string)
Sets text to the particular part of the widget.
Declaration
public virtual bool SetPartText(string part, string text)
Parameters
Type | Name | Description |
---|---|---|
string | part | The name of the particular part. |
string | text | The text. |
Returns
Type | Description |
---|---|
bool |
SignalEmit(string, string)
Sends a signal to the edje object of the widget.
Declaration
public void SignalEmit(string emission, string source)
Parameters
Type | Name | Description |
---|---|---|
string | emission | The signal's name. |
string | source | The signal's source. |
UpdatePartContents(EvasObject, string)
Updates the part contents.
Declaration
protected void UpdatePartContents(EvasObject content, string part = "__default__")
Parameters
Type | Name | Description |
---|---|---|
EvasObject | content | The content which is put into the part. |
string | part | The updated part. |
Events
View SourceFocused
Focused will be triggered when the widget is focused.
Declaration
public event EventHandler Focused
Event Type
Type | Description |
---|---|
System.EventHandler |
Unfocused
Unfocused will be triggered when the widget is unfocused.
Declaration
public event EventHandler Unfocused
Event Type
Type | Description |
---|---|
System.EventHandler |