Namespace ElmSharp

Description

ElmSharp is a simple c# wrapper of native EFL elementary which is provide all the widget you need to build a full application. These APIs are at the beta status and may be changed in backward/forward-incompatible ways, and are not guarantee to be released.

Classes

AccelerateFactorMotionMapper

. The AccelerateFactorMotionMapper class.

AccelerateMotionMapper

The AccelerateMotionMapper class.

AnimationView

The AnimationView is designed to show and play animation of vector graphics based content. Currently ElmSharp AnimationView is supporting only json format (known for Lottie file as well).

Background

The Background is a widget that use for setting (solid) background decorations to a window (unless it has transparency enabled) or to any container object.

BlendEffect

Blend effect class.

BounceMotionMapper

The BounceMotionMapper class.

Box

The Box is a container that is used to arrange UI components in a linear order.

Button

The Button is a widget that works as a clickable input element to trigger events.

Calendar

The Calendar is a widget that helps applications to flexibly display a calender with day of the week, date, year, and month.

CalendarMark

The CalendarMark is an item for marking a Calendar's type, date, and repeat type.

Check

The Check is a widget that allows for toggling a value between true and false.

CheckStateChangedEventArgs

It inherits System.EventArgs. The CheckStateChangedEventArgs is an EventArgs to record the check's state. Include the old state and the new state.

ColorChangedEventArgs

It inherits System.EventArgs. Event ColorChanged of the ColorSelector contains ColorChangedEventArgs as a parameter. Refer to ColorSelectortype.

ColorEffect

Color effect class.

ColorSelector

The ColorSelector is a widget to set a series of colors. It also allows to load/save colors from/to the configuration with a unique identifier.

ColorSelectorItem

An instance to the ColorSelector item gets added.

Conformant

The Conformant is a widget that can be used in elementary applications to account for space taken up by the indicator, virtual keypad & softkey windows when running the illume2 module of E17.

Container

It inherits Widget. The Container is an abstract class. The other class inherits it to elementary, which is about displaying its widgets in a nice layout.

ContextPopup

It inherits Layout. The ContextPopup is a widget that when shown, pops up a list of items.

ContextPopupItem

It inherits ItemObject. An instance to the ContextPopup item is added.

CubicBezierMotionMapper

The CubicBezierMotionMapper class.

DateChangedEventArgs

It inherits System.EventArgs. The DateChanged event in the Calendar and the DateTimeChanged event in DateTimeSelector contain the DateChangedEventArgs as a parameter.

DateTimeSelector

It inherits Layout. The DateTimeSelector is a widget to display and input the date & time values. This widget displays the date and time as per the system's locale settings (Date includes Day, Month & Year) along with the defined separators and time including hour, minute & AM/PM fields. Separator for the AM/PM field is ignored.

DecelerateFactorMotionMapper

The DecelerateFactorMotionMapper class.

DecelerateMotionMapper

The DecelerateMotionMapper class.

DisplayedMonthChangedEventArgs

It inherits System.EventArgs. The DisplayedMonthChangedEvent in a calendar contains the DisplayedMonthChangedEventArgs as a parameter.

DivisorInterpolatedMotionMapper

The DivisorInterpolatedMotionMapper class.

EcoreAnimator

EcoreAnimator is a helper class. It provides the functions to manage animations.

EcoreEvent

The event class for EcoreEvent.

EcoreEvent<TEventArgs>

The EcoreEvent is a class to help create events that are being notified of events.

EcoreEventType

The EcoreEventType is a type of EcoreEvent. It includes some predefined instance.

EcoreKeyEventArgs

It inherits System.EventArgs. The EcoreKeyEventArgs is an EventArgs to record the Ecore event's key name and key code.

EcoreMainloop

EcoreMainloop is a helper class, which provides the functions relative to Ecore's main loop.

EcoreSynchronizationContext

Provides a synchronization context for the EFL application.

EcoreTimelineAnimator

EcoreTimelineAnimator is a helper class, which provides the functions to manage animations.

EdjeObject

The EdjeObject is a class that the evas object exists in.

EdjeTextPartObject

The EdjeTextPartObject is a class dealing with parts of type text.

EffectBase

The EffectBase class for TransitEffect.

Elementary

The Elementary is a general elementary, a VERY SIMPLE toolkit.

ElmScrollConfig

The ElmScrollConfig is a scrollable views's configuration.

Entry

The Entry is a convenience widget that shows a box in which the user can enter text.

EvasCanvas

Low-level Evas canvas functions. Subgroups will be present more than the high-level ones, though. Most of these functions deal with low-level Evas actions like: create/destroy raw canvases, not bound to any displaying engine. tell a canvas, I got focused (in a windowing context, for example). tell a canvas, a region should not be calculated anymore in rendering. tell a canvas, to render its contents immediately. Most users will be using Evas by means of the Ecore_Evas wrapper, which deals with all the above mentioned issues automatically for them. Thus, you will be looking at this section only if you're building low-level stuff. The groups within, present you functions that deal with the canvas directly too, and not yet with its objects. They are the functions you need to use at a minimum to get a working canvas.

EvasImage

This group provides the functions for image objects.

EvasKeyEventArgs

The EvasKeyEventArgs is a EvasKey EventArgs.

EvasMap

The EvasMap is an opaque handle to map points.

EvasObject

The EvasObject is a base class for other widget classes.

EvasObjectEvent

Event class for EvasObject.

EvasObjectEvent<TEventArgs>

Event class for EvasObject.

FadeEffect

Fade effect class.

FlipEffect

Flip effect class.

FlipSelector

The FlipSelector is a widget to show a set of text items, one at a time, with the same sheet switching style as the clock widget when one changes the current displaying sheet.

FlipSelectorItem

The item class of FlipSelector.

FloatingButton

The FloatingButton is a widget to add the floating area for buttons.

GenGrid

It inherits Layout. The GenGrid is a widget that aims to position objects in a grid layout, while actually creating and rendering only the visible ones. It has two directions in which a given GenGrid widget expands while placing its items, horizontal and vertical. The gengrid items are represented through the GenItemClass definition field details.

GenGridItem

It inherits GenItem. An instance to the gengrid item is added. It contains the Update() method to update a gengrid item which is given.

GenGridItemClass

It represents the gengrid item class definition field details.

GenGridItemEventArgs

It inherits System.EventArgs. It contains the item which is the GenGridItem type. All events of the GenGrid contain GenGridItemEventArgs as a parameter.

GenItem

It inherits ItemObject. A base class for GenGridItem and GenListItem. It contains the GenItem class and data to display the data.

GenItemClass

It represents the GenGrid or GenList item class definition field details. It has some display styles, such as "default", "full", and "group_index".

GenList

It inherits Layout. The GenList is a widget that aims to have a more expansive list than the simple List in ElmSharp that could have more flexible items and allow many more entries while still being fast and low on memory usage. At the same time it was also made to be able to do tree structures. But the price to pay is more complex when it comes to usage. If all you want is a simple list with icons and a single text, use List widget.

GenListItem

It inherits GenItem. A instance to the genlist item is added. It contains the Update() method to update a genlist item which is given.

GenListItemEventArgs

It inherits System.EventArgs. It contains an item which is GenListItem type. All events of the GenList contain GenListItemEventArgs as a parameter.

GestureLayer

The GestureLayer is used to detect gestures. Inherits Widget.

GestureLayer.Config

Config is a static class, it provides gestureLayer's timeout information.

Hoversel

The hoversel is a button that pops up a list of items.

HoverselItem

The HoverselItem is the item of Hoversel.

HoverselItemEventArgs

The HoverselItemEventArgs is a HoverselItem's EventArgs.

Icon

The Icon is a widget that displays the standard icon images ("delete", "edit", "arrows", etc.) or images coming from a custom file (PNG, JPG, EDJE, etc.), on the icon context. Inherits Image.

Image

The Image is a widget that allows one to load and display an image file on it, be it from a disk file or from a memory region. Inherits Widget.

Index

The Index widget gives you an index for fast access to whichever group of the other UI items one might have. Inherits Layout.

IndexItem

The IndexItem is used to manage the index item. Inherits ItemObject.

InputGenerator

InputGenerator provides functions to initialize/deinitialize input devices and to generation touch / key events.

ItemObject

The ItemObject is used to manage the item object.

ItemObjectExtension

The ItemObjectExtension is used to manage the item object extension.

Label

The Label is a widget to display text, with a simple HTML-like markup. Inherits Layout.

Layout

This is a container widget that takes a standard edje design file and wraps it very thinly in a widget. Inherits Widget.

LinearMotionMapper

The LinearMotionMapper class.

List

It inherits Layout. The List is a widget that aims to display a simple list item which has 2 icons, 1 text, and can be selected. For more robust lists, GenList should probably be used.

ListItem

It inherits ItemObject. An instance to the list item is added. It contains the Text, LeftIcon, and RightIcon properties to show the list item which is given.

ListItemEventArgs

It inherits System.EventArgs. It contains an item which is ListItem type. All the events of a list contain ListItemEventArgs as a parameter.

MultiButtonEntry

It inherits Layout. The MultiButtonEntry is a widget, that lets a user enter text and each chunk of the text managed as a set of buttons. Each text button is inserted by pressing the "return" key. If there is no space in the current row, a new button is added to the next row. When a text button is pressed, it will become focused. Backspace removes the focus. When the multi-button entry loses focus, items longer than one line are shrunk to one line. The typical use case of multi-button entry is composing emails/messages to a group of addresses, each of which is an item that can be clicked for further actions.

MultiButtonEntryItem

It inherits ItemObject. MutltiButtonEntryItem is an item, which is added to MultiButtonEntry. It contains Next and Prev properties to get the next and previous item.

MultiButtonEntryItemEventArgs

It inherits System.EventArgs. The MultiButtonEntryItemEventArgs is a argument for all events of MultiButtonEntry. It contains the Item which is MultiButtonEntryItem type.

NamedHint

Predefined values for the hint properties in EvasObject.

Naviframe

The Naviframe is a widget to stand for the navigation frame. It's a views manager for applications. Inherits Widget.

NaviframeEventArgs

The NaviframeEventArgs is an event arguments class for naviframe. Inherits EventArgs.

NaviItem

The NaviItem is a widget that contain the contents to show in Naviframe. Inherits ItemObject

Panel

The Panel is a container that can contain subobjects.

Panes

The Panes is a widget that adds a draggable bar between two contents. When dragged, this bar resizes the contents' size.

Polygon

The Polygon is a widget that is used to draw a polygon (filled).

Popup

The Popup is a widget that is an enhancement of notify. In addition to content area, there are two optional sections, namely title area and action area.

PopupItem

The PopupItem is a class that includes the icon and text.

ProgressBar

The ProgressBar is a widget for visually representing the progress status of a given job or task.

Radio

The Radio is a widget that allows for 1 or more options to be displayed, and have the user choose only 1 of them.

Rectangle

The Rectangle is a class that is used to draw a solid colored rectangle.

ResizingEffect

Resizing effect class.

RotationEffect

Rotation effect class.

Scroller

The Scroller is a container that holds and clips a single object and allows you to scroll across it.

SinusoidalFactorMotionMapper

The SinusoidalFactorMotionMapper class.

SinusoidalMotionMapper

The SinusoidalMotionMapper class.

Slider

The Slider is a widget that adds a draggable slider widget for selecting the value of something within a range.

SmartEvent

It inherits IInvalidatable. EvasObject can elect the SmartEvent occurring inside them, to be reported back to their users via delegates. This way, you can extend EvasObject's own EvasObjectEvent. They are defined by an event string, which identifies them uniquely.

SmartEvent<TEventArgs>

It inherits IInvalidatable. The event with TEventArgs for EvasObject. EvasObject can elect the SmartEvent occurring inside them, to be reported back to their users via delegates. This way, you can extend EvasObject's own EvasObjectEvent. They are defined by an event string, which identifies them uniquely.

Spinner

The Spinner is a widget that increases or decreases the numeric values using arrow buttons, or edit values directly. Inherits Layout.

SpringMotionMapper

The SpringMotionMapper class.

Table

The Table is a container widget to arrange other widgets in a table where items can span multiple columns or rows. Inherits Container.

Toolbar

The Toolbar is a widget that displays a list of items inside a box.

ToolbarItem

The ToolbarItem is an item of the toolbar.

ToolbarItemEventArgs

Event arguments for events of ToolbarItem.

Transit

Transit is designed to apply various animated transition effects, such as translation, rotation, etc. For using these effects, create a transit and add the desired transition effects.

TranslationEffect

Translation effect class.

Utility

This class is a static class for utility methods.

Widget

The Widget is an abstract class and the parent of other widgets. Inherits from EvasObject.

Window

The Window is a container that contains the graphical user interface of a program.

WipeEffect

Wipe effect class.

ZoomEffect

Zoom effect class.

Structs

Color

The Color is a struct to record the check's state.

GestureLayer.LineData

The struct of LineData.

GestureLayer.MomentumData

The struct of MomentumData.

GestureLayer.RotateData

The struct of RotateData.

GestureLayer.TapData

The struct of TapData.

GestureLayer.ZoomData

The struct of ZoomData.

Point

The Point is a struct that defines the 2D point as a pair of generic type.

Point3D

The Point3D is a struct that defines a 3D point.

Rect

The Rect is a struct that represents the rectangular space.

Size

The Size is a struct defining the height and width as a pair of generic type.

Interfaces

IAnimatorMotionMapper

The AnimatorMotionMapper interface.

IInvalidatable

IInvalidatable is an interface, which can be overrided by its children class. Inherits IDisposable.

Enums

AnimationViewState

Enumeration for the AnimationView state

AspectControl

Enumeration for the aspect control.

AutoCapital

Enumeration for defining the autocapitalization types.

BackgroundOptions

Enumeration for the background types.

CalendarMarkRepeatType

Enumeration for event periodicity, used to define if a mark should be repeated beyond the event's day. It's set when a mark is added.

CalendarSelectable

Enumeration for defining which fields of a tm struct will be taken into account.

CalendarSelectMode

Enumeration for the mode, which determines how a user could select a day.

ColorSelectorMode

Enumeration for the modes of ColorSelector.

ContextPopupDirection

Enumeration for the ContextPopup direction types.

CopyAndPasteMode

Enumeration for defining the entry's copy and paste policy.

DateTimeFieldType

Enumeration for the datetime field types for DateTimeSelector.

DisplayRotation

Enumeration for the display rotation of window.

EvasEventFlag

Flags for the events.

EvasObjectCallbackType

Enumeration for EvasObjectCallbackType.

FlipAxis

Enumeration for the axis along which flip effect should be applied.

FloatingButtonMode

Enumeration for the FloatingButtonMode.

FloatingButtonPosition

Enumeration for the FloatingButtonPosition.

FocusAutoScrollMode

Focus Autoscroll mode.

FocusDirection

Enumeration for the focus direction.

GenItemSelectionMode

Enumeration for the selection modes of GenItem.

GenListItemFieldType

The type of the item's part types.

GenListItemType

Enumeration for setting the genlist item types.

GenListMode

Enumeration for setting the genlist's resizing behavior, transverse axis scrolling, and items cropping.

GestureLayer.GestureState

Enumeration for the gesture states.

GestureLayer.GestureType

Enumeration for the supported gesture types.

IconLookupOrder

Enumeration for the icon lookup order. Should look for icons in the theme, FDO paths, or both.

ImageBorderFillMode

Enumeration for the fill mode of the image border.

ImageOrientation

Enumeration for the possible orientation options.

IndicatorMode

Enumeration for the indicator mode.

InputDeviceType

Enumeration of device type generated events.

InputHints

Enumeration that defines the types of Input Hints.

InputPanelLanguage

Enumeration for defining the input panel (virtual keyboard) language modes.

InputPanelLayout

Enumeration for describing the InputPanel layout types.

InputPanelReturnKeyType

Enumeration for defining the "Return" key types on the input panel (virtual keyboard).

InputPointerType

Enumeration of pointer event types.

InputTouchType

Enumeration of touch event types.

KeyboardMode

Enumeration for the keyboard mode.

LabelSlideMode

Enumeration for the slide modes of a label widget.

ListMode

Enumeration for setting the list's resizing behavior, transverse axis scrolling, and items cropping.

NotificationLevel

Enumeration of notification window's priority level.

PanelDirection

Enumeration for the PanelDirection types.

PopupOrientation

Enumeration for the popup orientation types.

RenderOp

How the object should be rendered to output.

ScreenMode

Enumeration of screen mode.

ScrollBarVisiblePolicy

Enumeration for the visible type of scrollbar.

ScrollBlock

Enumeration for the visible type of scrollbar.

ScrollSingleDirection

Type that controls how the content is scrolled.

ScrollToPosition

Enumeration for defining where to position the item in the genlist.

SliderIndicatorVisibleMode

Enumeration for the Slider's indicator visiblity mode.

StatusBarMode

Enumeration for the indicator opacity.

TextFormat

Enumeration for the text format types.

ToolbarIconLookupOrder

Enumeration for the icon lookup order of the toolbar.

ToolbarSelectionMode

Enumeration for the selection mode of the toolbar.

ToolbarShrinkMode

Enumeration for setting the toolbar items display behavior, it can be scrollable, can show a menu with exceeding items, or simply hide them.

TooltipOrientation

Enumeration for the Tooltip orientation.

TweenMode

Enumration for the type of acceleration used in transition.

WindowType

Enumeration for the window type.

WipeDirection

Enumeration for the direction in which the wipe effect should occur.

WipeType

Enumeration for whether the wipe effect should show or hide the object.

WrapType

Enumeration for the wrap types.

Delegates

Calendar.DateFormatDelegate

This delegate type is used to format the string that will be used to display month and year.

EcoreEvent<TEventArgs>.EventInfoParser

EventInfoParser delegate of the EcoreEvent class.

EvasObject.GetTooltipContentDelegate

Called when a widget's tooltip is activated and needs content.

EvasObjectEvent<TEventArgs>.SmartEventInfoParser

SmartEventInfoParser delegate of the EvasObjectEvent class.

GenItem.GetTooltipContentDelegate

The delegate returning the tooltip contents.

GenItemClass.DeleteDelegate

The delegate to define DeleteHandler.

SmartEvent<TEventArgs>.SmartEventInfoParser

The delegate for creating smart event item arguments.