Namespace Tizen.NUI

    Classes

    AbsoluteLayout

    [Draft] This class implements a absolute layout, allowing explicit positioning of children. Positions are from the top left of the layout and can be set using the View.Position and alike.

    AccessibilityDoGestureSignal

    Adaptor

    An Adaptor object is used to initialize and control how Dali runs.

    It provides the lifecycle interface that allows the application writer to provide their own main loop and other platform related features.

    The Adaptor class provides a means for initialising the resources required by the Dali::Core.

    When dealing with platform events, the application writer must ensure that DALi is called in a thread-safe manner.

    As soon as the Adaptor class is created and started, the application writer can initialise their view objects straight away or as required by the main loop they intend to use (there is no need to wait for an initialize signal as per the Tizen.NUI.Application class).

    AlphaFunction

    Alpha functions are used in animations to specify the rate of change of the animation parameter over time.
    Understanding an animation as a parametric function over time, the alpha function is applied to the parameter of the animation before computing the final animation value.

    Animatable

    Animatable.

    AnimatedImageVisual

    A class encapsulating the property map of the animated image (AGIF) visual.

    Animation

    Animation can be used to animate the properties of any number of objects, typically view.
    If the "Finished" event is connected to a member function of an object, it must be disconnected before the object is destroyed.
    This is typically done in the object destructor, and requires either the animation handle to be stored.
    The overall animation time is superseded by the values given in the animation time used when calling the AnimateTo(), AnimateBy(), AnimateBetween() and AnimatePath() methods.
    If any of the individual calls to those functions exceeds the overall animation time (Duration), then the overall animation time is automatically extended.

    ApplicationTransitionManager

    This ApplicationTransitionManager class is a class to control transition motion of application.

    ArcVisual

    A class encapsulating the property map of the arc visual.

    AutofillContainer

    AutofillContainer controls several text input boxes.

    AutofillContainer.AuthenticationEventArgs

    Event arguments that passed via the Authentication event.

    AutofillContainer.ListEventArgs

    AutofillContainer list event arguments.

    AuxiliaryMessageEventArgs

    Auxiliary Message Event arguments This has the three members as key, value and options. Options has the list of string

    BackKeyManager

    BackKeyManager is a class to manager back key event.

    BaseHandle

    BaseHandle is a handle to an internal Dali resource.

    BaseHandle.FocusRequestArgs

    Contains event arguments for the FocusChangeRequested event.

    BorderVisual

    A class encapsulating the property map of the border visual.

    Camera

    Capture

    Capture snapshots the current scene and save as a file. Applications should follow the example below to create capture :

    Capture capture = new Capture();

    If required, you can also subscribe Finished event :

    capture.Finished += onCaptureFinished;

    At the subcribed event handler, user can know whether capture finish succeeded state.

    private void onCaptureFinished(object sender, CaptureFinishedEventArgs e)
    {
      if(e.Success) { //capture success, do something. }
      else { //capture failure, do something. }
    }

    suppose that we want to capture View 'A'. And, the View 'A' is overlapped by another View 'B' that is not a child of 'A'. in this case, if source is root of scene, the captured image includes a part of View 'B' on the 'A'. however, if source is just View 'A', the result includes only 'A'.

    CaptureFinishedEventArgs

    CaptureFinishedEventArgs

    Clipboard

    Clipboard.

    ClipboardDataSelectedEventArgs

    ClipboardDataSelectedEventArgs is a class to record clipboard selected event arguments which will be sent to user.
    This is to catch data selection event.

    Color

    The Color class.

    ColorVisual

    A class encapsulating the property map of the color visual.

    Container

    The Container is an abstract class to be inherited from by classes that desire to have views added to them.

    CubeTransitionCrossEffect

    CubeTransitionEffect

    Cube Transition Effect base class, used to apply custom effects to a Cube Transition instance.

    CubeTransitionEffect.TransitionCompletedEventArgs

    CubeTransitionFoldEffect

    CubeTransitionWaveEffect

    CustomViewRegistry

    View the Registry singleton. Used for registering controls and any scriptable properties they have (see ScriptableProperty).

    Internal Design from C# to C++

    • Each custom C# view should have it's static constructor called before any JSON file is loaded. Static constructors for a class will only run once ( they are run per control type, not per instance). Example of running a static constructor: System.Runtime.CompilerServices.RuntimeHelpers.RunClassConstructor (typeof(Spin).TypeHandle); Inside the static constructor the control should register it's type with the ViewRegistry For example:

    static Spin() { ViewRegistry.Instance.Register(CreateInstance, typeof(Spin) ); }

    The control should also provide a CreateInstance function, which gets passed to the ViewRegistry. // Eventually it will be called if DALi Builderfinds a Spin control in a JSON file. static CustomView CreateInstance() { return new Spin(); }

    The DALi C++ equivalent of this is

    TypeRegistration mType( typeid(Toolkit::Spin), typeid(Toolkit::Control), CreateInstance );

    DefaultBorder

    This class creates a border UI.

    DefaultRuler

    Degree

    An angle in degrees.
    This reduces ambiguity when using methods which accept angles in degrees or radians.

    Disposable

    Disposable class.

    DpTypeConverter

    Default DpTypeConverter class to convert dp types.

    DragAndDrop

    DragAndDrop controls the drag object and data.

    EncodedImageBuffer

    Class for Encoded Image Buffer. Buffer comes from System.IO.Stream. This data will decode internally when you use GeneratedUrl as View's ResourceUrl. Note: This class doesn't allow to fix/change anything. Only constructor allow to setup data.

    EnvironmentVariable

    EnvironmentVariable

    Extents

    Extents class describing the a collection of uint16_t.

    FadeTransition

    FadeTransition class is a cluster of properties for the fade transition of a View.

    FixedRuler

    FlexLayout

    This class implements a flex layout. The flex layout implementation is based on open source Facebook Yoga layout engine. For more information about the flex layout API and how to use it please refer to https://yogalayout.com/docs/ We implement the subset of the API in the class below.

    FocusChangingEventArgs

    Event arguments passed via the FocusChanging signal.

    FocusManager

    Provides the functionality of handling keyboard navigation and maintaining the two-dimensional keyboard focus chain.
    It provides functionality of setting the focus and moving the focus in four directions( i.e., left, right, up, and down).
    It also draws a highlight for the focused view and sends an event when the focus is changed.

    FocusManager.FocusChangedEventArgs

    Event arguments that passed via the FocusChanged signal.

    FocusManager.FocusedViewActivatedEventArgs

    Event arguments that passed via the FocusedViewEnterKey signal.

    FocusManager.FocusedViewEnterKeyEventArgs

    Do not use this, that will be deprecated.

    FocusManager.FocusGroupChangedEventArgs

    Event arguments that passed via the FocusGroupChanged signal.

    FocusManager.PreFocusChangeEventArgs

    Event arguments that passed via the PreFocusChange signal.

    FontClient

    FontClient provides access to font information and resources.

    FrameBuffer

    FrameBuffer.Attachment

    FrameUpdateCallbackInterface

    GaussianBlurView

    GaussianBlurView is a class for applying a render process that blurs an image.

    Geometry

    Geometry is handle to an object that can be used to define a geometric elements.

    Gesture

    Base structure for different gestures that an application can receive.
    A Gesture is an event that is produced from a combination of several touch events in a particular order or within a certain time frame (for example, pinch).

    GestureDetector

    GestureDetectors analyses a stream of touch events and attempt to determine the intention of the user.
    An view is attached to a gesture detector and if the detector recognises a pattern in its analysis, it will trigger a detected event to the application.
    This is the base class for different gesture detectors available and provides functionality that is common to all the gesture detectors.

    GestureOptions

    This is a calss that sets the configuration options of Gestures

    GetResourcesProvider

    A class to get resources in current application.

    GLWindow

    The GLWindow class is to draw with native GLES.
    This class is the special window. It is for native GLES application.
    So, some special functions and type are supported.
    In addition, basic window's functions are supported, too.

    GLWindow.FocusChangedEventArgs

    The focus changed event argument.

    GLWindow.KeyEventArgs

    Key event arguments.

    GLWindow.ResizedEventArgs

    Feeds a key event into the window. This resized event arguments.

    GLWindow.TouchEventArgs

    The touch event argument.

    GLWindow.VisibilityChangedEventArgs

    VisibilityChangedArgs

    GradientVisual

    A class encapsulating the property map of the gradient visual.

    Graphics

    Graphics Backend Type.

    GraphicsCapabilities

    GraphicsTypeConverter

    GraphicsTypeConverter class to convert types.

    GraphicsTypeExtensions

    The GraphicTypeExtensions class is graphics type converter for pixel based object. Density independent pixel(dp) unit is our basic target type and you can get converted value by PxToDp(), and you can get original pixel by PxToDp(). One dp is a virtual pixel unit that's roughly equal to one pixel on a medium-density(160dpi) screen. See GraphicsTypeManager and GraphicsTypeConverter also.

    GraphicsTypeManager

    GraphicsTypeManager class to manage various types.

    GridLayout

    GridLayout is a 2D grid pattern layout that consists of a set of rows and columns.

    Hover

    Hover events are a collection of points at a specific moment in time.
    When a multi-event occurs, each point represents the points that are currently being hovered or the points where a hover has stopped.

    ImageLoader

    A class containing methods providing image loading

    ImageLoading

    A class containing methods providing image loading

    ImageShadow

    The Shadow composed of image for View

    ImageUrl

    Url for Image

    ImageVisual

    A class encapsulating the property map of the image visual.

    InputMethod

    A class encapsulating the input method map.

    InputMethodContext

    Specifically manages the input method framework (IMF) that enables the virtual or hardware keyboards.

    InputMethodContext.ActivatedEventArgs

    InputMethodContext activated event arguments.

    InputMethodContext.CallbackData

    Data required by the IMF from the callback.

    InputMethodContext.ContentReceivedEventArgs

    InputMethodContext content received event arguments.

    InputMethodContext.EventData

    This structure is used to pass on data from the IMF regarding predictive text.

    InputMethodContext.EventReceivedEventArgs

    InputMethodContext event receives event arguments.

    InputMethodContext.KeyboardTypeChangedEventArgs

    InputMethodContext keyboard type changed event arguments.

    InputMethodContext.LanguageChangedEventArgs

    InputMethodContext language changed event arguments.

    InputMethodContext.ResizedEventArgs

    InputMethodContext resized event arguments.

    InputMethodContext.StatusChangedEventArgs

    InputMethodContext status changed event arguments.

    Item

    ItemCollection

    ItemCollection.ItemCollectionEnumerator

    ItemFactory

    ItemIdCollection

    ItemIdCollection.ItemIdCollectionEnumerator

    ItemLayout

    ItemRange

    ItemView

    Key

    The key structure is used to store a key press.

    KeyFrames

    A set of key frames for a property that can be animated using DALi animation.
    This allows the generation of key frame objects from individual Property::Values.

    KeyValue

    KeyValue class.

    Layer

    Layers provide a mechanism for overlaying groups of actors on top of each other.

    Layer.VisibilityChangedEventArgs

    Event arguments of visibility changed.

    LayoutGroup

    [Draft] LayoutGroup class providing container functionality.

    LayoutItem

    [Draft] Base class for layouts. It is used to layout a View It can be laid out by a LayoutGroup.

    LayoutTransition

    LayoutTransition stores the animation setting for a transition condition.

    LinearLayout

    [Draft] This class implements a linear box layout, automatically handling right to left or left to right direction change.

    LongPressGesture

    A long press gesture is emitted when the user holds the screen with the stated number of fingers.
    A long press gesture finishes when all touches have been released.

    LongPressGestureDetector

    This class emits a signals when a long press gesture occurs that meets the requirements set by the application.
    For any valid long press, two signals will be emitted:

    • First identifying the beginning (state = Started) i.e. when fingers held down for the required time.
    • Second identifying the ending (state = Finished) i.e. when fingers are released.

    LongPressGestureDetector.DetectedEventArgs

    Event arguments that passed via the LongPressGestureEvent signal.

    Matrix

    The Matrix class represents transformations and projections.
    The matrix is stored as a flat array and is Column Major, i.e. the storage order is as follows (numbers represent indices of array):

    0   4   8   12
    1   5   9   13
    2   6   10  14
    3   7   11  15

    Each axis is contiguous in memory, so the x-axis corresponds to elements 0, 1, 2 and 3, the y-axis corresponds to elements 4, 5, 6, 7, the z-axis corresponds to elements 12, 13, 14 and 15, and the translation vector corresponds to elements 12, 13 and 14.

    Matrix3

    A 3x3 matrix.
    The matrix is stored as a flat array and is Column Major, i.e. the storage order is as follows (numbers represent indices of array):

    0   3   6
    1   4   7
    2   5   8

    Each axis is contiguous in memory, so the x-axis corresponds to elements 0, 1, and 2, the y-axis corresponds to elements 3, 4, 5, the z-axis corresponds to elements 6, 7, and 8.

    MeshVisual

    A class encapsulating the property map of the mesh visual.

    MouseInOut

    MouseInOut is used when the mouse enters or exits a window.

    MouseRelative

    MouseRelative is used when relative mouse movement occurs in the window.

    NativeImageInterface

    NativeImageQueue

    NativeImageQueue is a class for displaying an image resource using queue.

    NativeImageSource

    NPatchVisual

    A class encapsulating the property map of the n-patch image visual.

    NUIApplication

    Represents an application that have a UI screen. The NUIApplication class has a default stage.

    NUIComponentApplication

    The class for supporting multi-components application model.

    NUIEventType

    Class that represents the type of NUI event for backends. This class can be converted from string type.

    NUIFrameComponent

    The class for showing UI module

    NUIGadget

    This class represents a NUIGadget controlled lifecycles.

    NUIGadgetInfo

    This class provides properties to get information the gadget.

    NUIGadgetLifecycleChangedEventArgs

    Arguments for the event raised when the NUIGadget lifecycle is changed.

    NUIGadgetManager

    This class has the methods and events of the NUIGadgetManager.

    NUIGadgetResourceManager

    This class has the methods of the NUIGadgetResourceManager.

    NUIWatchApplication

    Represents an application that can make watch-face.

    NUIWatchApplication.AmbientChangedEventArgs

    Event arguments that passed via ambient tick event signal.

    NUIWatchApplication.AmbientTickEventArgs

    Event arguments that passed via ambient tick event signal.

    NUIWatchApplication.TimeTickEventArgs

    Event arguments that passed via time tick event signal.

    NUIWidgetApplication

    Represents an application that have UI screen. The NUIWidgetApplication class has a default stage.

    PaddingType

    The gesture state.

    Palette

    A helper class to extract prominent colors from an image.

    A number of colors with different profiles are extracted from the image: Vibrant, Vibrant Dark, Vibrant Light, Muted, Muted Dark, Muted Light

    These can be retrieved from the appropriate getter method.

    Palette.Swatch

    Represents a color swatch generated from an image's palette. The RGB color can be retrieved calling getRgb()

    PanGesture

    A PanGesture is emitted when the user moves one or more fingers in a particular direction.
    A pan gesture will end in the following ways:

    • User releases the primary finger (the first touch).
    • User has more fingers on the screen than the maximum specified.
    • User has less fingers on the screen than the minimum specified.
    • Cancelled by the system.
      A pan gesture will continue to be sent to the actor under than initial pan until it ends.

    PanGestureDetector

    This class emits a signals when a pan gesture occurs.

    PanGestureDetector.DetectedEventArgs

    Event arguments that are passed via the PanGestureEvent signal.

    Path

    A 3D parametric curve.
    Paths can be used to animate the position and orientation of actors.

    PinchGesture

    A PinchGesture is emitted when the user moves two fingers towards or away from each other.
    A pinch gesture will continue to be sent to the actor under the center point of the pinch until the pinch ends.

    PinchGestureDetector

    It tries to detect when the user moves two touch points towards or away from each other.

    PinchGestureDetector.DetectedEventArgs

    Event arguments that passed via the PinchGestureEvent signal.

    PixelBuffer

    The PixelBuffer object holds a pixel buffer. The PixelBuffer keeps ownership of its initial buffer. However, the user is free to modify the pixel data, either directly or via image operations.

    In order to upload the pixel data to the texture memory, there are two possibilities, either convert it back to a PixelData object, which releases the PixelBuffer object, leaving the user with an empty handle (ideal for one-time indirect image manipulation) or create a new PixelData object from this object, leaving the buffer intact (ideal for continuous manipulation).

    PixelData

    The PixelData object holds a pixel buffer.
    The PixelData takes over the ownership of the pixel buffer.
    The buffer memory must not be released outside of this class, instead, the PixelData object will release it automatically when the reference count falls to zero.

    PointerConstraints

    PointerConstraints is used when pointer is locked/unlocked

    PointTypeConverter

    Default PointTypeConverter class to convert point types.

    Position

    Position is a three-dimensional vector.

    Position2D

    Position2D is a two-dimensional vector.

    PrimitiveVisual

    A class encapsulating the property map of the primitive visual.

    PropertyArray

    An array of property values.

    PropertyBuffer

    PropertyBuffer is a handle to an object that contains a buffer of structured data.
    PropertyBuffers can be used to provide data to Geometry objects.

    PropertyCondition

    A condition that can be evaluated on a Property Value

    PropertyKey

    A key type which can be either a std::string or a Property::Index.

    PropertyMap

    A map of property values, the key type could be string or Property::Index.

    PropertyNotification

    Issues a notification upon a condition of the property being met. See PropertyCondition for available defined conditions.

    PropertyNotification.NotifyEventArgs

    Event arguments that passed via Notify signal

    PropertyValue

    A value-type representing a property value.

    Radian

    An angle in radians.

    Rectangle

    The Rectangle class.

    RefObject

    RelativeLayout

    RelativeLayout calculates the size and position of all the children based on their relationship to each other.

    RelativeVector2

    RelativeVector2 is a two-dimensional vector. Both values (x and y) should be between [0, 1].

    RelativeVector3

    RelativeVector3 is a three-dimensional vector. All values (x, y, z and w) should be between [0, 1].

    RelativeVector4

    RelativeVector4 is a four-dimensional vector. All values (x, y, and z) should be between [0, 1].

    RelayoutContainer

    An interface to encapsulate the information required for relayout.

    Renderer

    Renderer is a handle to an object used to show content by combining a Geometry, a TextureSet and a shader.

    Renderer.Ranges

    RenderTask

    RenderTaskList

    Rotation

    The Rotation class.

    RotationGesture

    A RotationGesture is emitted when the user moves two fingers in a circular motion.
    A rotation gesture will continue to be sent to the actor under the center point of the rotation until the rotation ends.

    RotationGestureDetector

    It tries to detect when the user moves two touch points in a circular motion.

    RotationGestureDetector.DetectedEventArgs

    Event arguments that passed via the RotationGestureEvent signal.

    Ruler

    RulerDomain

    RulerPtr

    SafeFrameBrokerHandle

    Sampler

    Sampler is a handle to an object that can be used to provide the sampling parameters to sample textures.

    ScaleTransition

    ScaleTransition provides smoothly appearing/disappearing scale effects for target View. If this transition is for appearing, the View comes out with the scale factor applied and will be animated to its original scale. If this transition is for disappearing, the View starts at its original size and will finally become scaled by scale factor and vanishes.

    ScriptableProperty

    Adds this attribute to any property belonging to a view (control) you want to be scriptable from JSON.

    ScrollView

    ScrollView contains views that can be scrolled manually (via touch).

    ScrollView.Property

    This should be internal, do not use.

    ScrollView.SnapEvent

    Snaps signal event's data.

    ScrollView.SnapStartedEventArgs

    Event arguments that passed via the SnapStarted signal.

    ScrollViewEffect

    ScrollView Effect base class, used to apply custom effects to a ScrollView instance.

    ScrollViewPagePathEffect

    ScrollView Page Path Effect. This effect causes Views to follow a given path. The opacity of the view will be 0.0 at the beginning of the path and will go to 1.0 as it is approximating to half of the path to return to 0.0 at the end of the path.

    Shader

    Shader.

    Shader.Hint

    Hint.

    Shadow

    Represents a shadow with color and blur radius for a View.

    ShadowBase

    The base class to describe basic shadow.

    Size

    A three-dimensional size.

    Size2D

    A two-dimensional size.

    SlideTransition

    SlideTransition class is a cluster of properties for the slide transition of a View. SlideTransition provides smoothly appearing/disappearing effects for target Control. The direction the target Control is comming from or going to can be selected in the pre-defined directions at the SlideTransitionDirection {UP, DOWN, LEFT, RIGHT} And, to use custom direction, the direction can be set by using Vector2.

    Spin

    Spins the CustomView class.

    SpTypeConverter

    Default SpTypeConverter class to convert dp types.

    StringToVoidSignal

    StyleManager

    The StyleManager informs applications of the system theme change, and supports application theme change at runtime.
    Applies various styles to controls using the properties system.
    On theme change, it automatically updates all controls, then raises a event to inform the application.
    If the application wants to customize the theme, RequestThemeChange needs to be called.
    It provides the path to the application resource root folder, from there the filename can be specified along with any subfolders, for example, Images, Models, etc.

    StyleManager.StyleChangedEventArgs

    Style changed event arguments.

    SVGVisual

    A class encapsulating the property map of the SVG visual.

    TapGesture

    A TapGesture is emitted when the user taps the screen with the stated number of fingers a stated number of times.

    TapGestureDetector

    This class emits a signal when a tap gesture occurs that meets the requirements set by the application.
    A TapGesture is a discrete gesture, which means it does not have any state information attached.

    TapGestureDetector.DetectedEventArgs

    Event arguments that are passed via the TapGestureEvent signal.

    TextShadow

    The Text Shadow for TextLabel.

    Texture

    Texture represents a texture object used as input or output by shaders.

    TextureSet

    TextureSet is a handle to an object that specifies the set of images used as textures by a renderer.
    The images have to be ordered in the same order they are declared in the shader.

    TextVisual

    A class encapsulating the property map of the text visual.

    Theme

    Basically, the Theme is a dictionary of ViewStyles that can decorate NUI Views. Each ViewStyle item is identified by a string key that can be matched the StyleName.

    The main purpose of providing theme is to separate style details from the structure. Managing style separately makes it easier to customize the look of application by user context. Also since a theme can be created from xaml file, it can be treated as a resource. This enables sharing styles with other applications.

    ThemeChangedEventArgs

    The event arguments that hold data for the event ThemeChanged.

    ThemeManager

    This static module provides methods that can manage NUI Theme.

    TimePeriod

    TimePeriod is used to define delay and duration of a process such as Transition. TimePeriod is composed of Delay and Duration in milliseconds

    Timer

    Mechanism to issue simple periodic or one-shot events.
    Timer is provided for application developers to be able to issue simple periodic or one-shot events. Please note that the timer callback functions should return as soon as possible because they block the next SignalTick. Please note that timer signals are not in sync with DALi's render timer.
    This class is a handle class so it can be stack allocated and used as a member.

    Timer.TickEventArgs

    Event arguments that passed via the tick event.

    Touch

    Touch events are a collection of points at a specific moment in time.
    When a multi-touch event occurs, each point represents the points that are currently being touched or the points where a touch has stopped.

    Transition

    Transition class is a cluster of properties for the transition of View pair.

    TransitionBase

    TransitionBase class is a base class for all Transition. Each Transition child classes inherits this base class.

    TransitionComponents

    Parts of the transition that can be configured to provide a custom effect.

    TransitionData

    This object translates data from a property array of maps into an array of animators. This is normally used when animating visuals.

    TransitionGroup

    TransitionGroup class is a cluster of properties to use multiple Transitions on a target. FadeTransition, ScaleTransition, and SlideTransition can be added on this group with AddTransition method. The transitions can be started at the same time or can be started sequentially in order.

    TransitionList

    Define a List of LayoutTransitions

    TransitionOptions

    This TransitionOptions class is a class to control Transition motion. This class includes multiple options for the Transition. NUI supports various kinds of Transitions such as App transition, Page transition, and so on.

    TTSPlayer

    The Text-to-speech (TTS) player.

    TTSPlayer.StateChangedEventArgs

    State changed argument.

    TypeInfo

    TypeInfo class for instantiation of registered types and introspection of their actions and signals.

    TypeRegistry

    The TypeRegistry allows registration of type instance creation functions. These can then be created later by name and down cast to the appropriate type.

    Vector2

    A two-dimensional vector.

    Vector3

    A three-dimensional vector.

    Vector4

    A four-dimensional vector.

    VertexBuffer

    VertexBuffer is a handle to an object that contains a buffer of structured data.
    VertexBuffers can be used to provide data to Geometry objects.

    ViewWrapper

    ViewWrapper.

    VisualAnimator

    A class encapsulating the property map of the transition data.

    VisualBase

    Sets whether the actor should be focusable by keyboard navigation.
    Visuals reuse geometry, shader etc. across controls. They ensure that the renderer and texture sets exist only when control is on window.
    Each visual also responds to actor size and color change, and provides clipping at the renderer level.

    VisualFactory

    The VisualFactory is a singleton object that provides and shares visuals between views.

    VisualMap

    A class encapsulating the transform map of the visual.

    WatchTime

    The WatchTime class is used to get time for the WatchApplication.
    A WatchTime has a time handle from watch application framework.
    You can get time(hour, minute, second, millisecond) and date(year, month, day)
    on receiving timeTick signal.

    WeakEvent<T>

    The WeakEvent without holding strong reference of event handler.

    WebBackForwardList

    WebBackForwardList is a class for back-forward list of web view.

    WebBackForwardListItem

    WebBackForwardListItem is a class for back-forward list item of web view.

    WebCertificate

    It is a class for certificate of web view.

    WebConsoleMessage

    It is a class for console message of web view.

    WebContext

    WebContext is a class for context of web view.

    WebContextMenu

    It is a class for context menu of web view.

    WebContextMenuItem

    It is a class for context menu item of web view.

    WebCookieManager

    WebCookieManager is a class for cookie manager of web view.

    WebFormRepostPolicyDecisionMaker

    It is a class for form repost policy decision maker of web view.

    WebFrame

    It is a class for frame of web view.

    WebHitTestResult

    It is a class for hit test result of web view.

    WebHttpAuthHandler

    It is a class for http authencation handler of web view.

    WebHttpRequestInterceptor

    It is a class for http request interceptor of web view.

    WebPageLoadError

    It is a class for load error of page of web view.

    WebPasswordData

    It is a class for password data of web view.

    WebPolicyDecisionMaker

    It is a class for policy decision maker of web view.

    WebSecurityOrigin

    It is a class for security origin of web view.

    WebSettings

    WebSettings is a class for settings of web view.

    WebViewCertificateReceivedEventArgs

    Event arguments that passed via the WebView.CertificateConfirmed / WebView.SslCertificateChanged.

    WebViewConsoleMessageReceivedEventArgs

    Event arguments that passed via the WebView.ConsoleMessageReceived.

    WebViewContextMenuHiddenEventArgs

    Event arguments that passed via the WebView.ContextMenuHidden.

    WebViewContextMenuShownEventArgs

    Event arguments that passed via the WebView.ContextMenuShown.

    WebViewFormRepostPolicyDecidedEventArgs

    Event arguments that passed via the WebView.FormRepostPolicyDecided.

    WebViewHttpAuthRequestedEventArgs

    Event arguments that passed via the WebView.HttpAuthRequested.

    WebViewPageLoadErrorEventArgs

    Event arguments that passed via the WebView.PageLoadError.

    WebViewPageLoadEventArgs

    Event arguments that passed via the WebView.PageLoadStarted or WebView.PageLoadFinished.

    WebViewPolicyDecidedEventArgs

    Event arguments that passed via the WebView.ResponsePolicyDecided, WebView.NavigationPolicyDecided or WebView.NewWindowPolicyDecided.

    WebViewScrollEdgeReachedEventArgs

    Event arguments that passed via the WebView.ScrollEdgeReached.

    WebViewTextFoundEventArgs

    Event arguments that passed via the WebView.TextFound.

    WebViewUrlChangedEventArgs

    Event arguments that passed via the WebView.UrlChanged.

    Wheel

    The wheel event structure is used to store a wheel rolling, it facilitates processing of the wheel rolling and passing to other libraries like Toolkit.
    There is a key modifier which relates to keys like Alt, Shift, and Ctrl functions are supplied to check if they have been pressed when the wheel is being rolled.
    We support a mouse device and there may be another custom device that support the wheel event. The device type is specified as \e type.
    The mouse wheel event can be sent to the specific actor but the custom wheel event will be sent to the window.

    Widget

    Widget provides some common functionality required by all custom widget.

    WidgetView

    The WidgetView is a class for displaying the widget image and controlling the widget.
    Input events that the WidgetView gets are delivered to the widget.

    WidgetView.WidgetViewEventArgs

    Event arguments of the widget view.

    WidgetViewManager

    WidgetViewManager manages addition of WidgetView controls. This class provides the functionality of adding the widget views and controlling the widgets.

    Window

    The window class is used internally for drawing.
    The window has an orientation and indicator properties.

    Window.AccessibilityHighlightEventArgs

    AccessibilityHighlightArgs

    Window.FocusChangedEventArgs

    The focus changed event argument.

    Window.HoverEventArgs

    Event arguments that passed via the hover signal.

    Window.InsetsChangedEventArgs

    InsetsChangedEventArgs

    Window.KeyEventArgs

    Key event arguments.

    Window.MouseInOutEventArgs

    MouseInOut evnet arguments.

    Window.MouseRelativeEventArgs

    MouseRelative evnet arguments.

    Window.PointerConstraintsEventArgs

    PointerConstraints evnet arguments.

    Window.ResizedEventArgs

    Feeds a key event into the window. This resized event arguments.

    Window.SafeNativeWindowHandle

    Contains and encapsulates Native Window handle.

    Window.TouchEventArgs

    The touch event argument.

    Window.TransitionEffectEventArgs

    TransitionEffectArgs

    Window.VisibilityChangedEventArgs

    VisibilityChangedArgs

    Window.WheelEventArgs

    Wheel event arguments.

    Window.WindowFocusChangedEventArgs

    Do not use this, that will be deprecated.

    WindowData

    This class represents the default window data for an Application object. It contains information about the default window.

    WindowMoveCompletedEventArgs

    Move Completed event is sent when window has been moved the display server. It is triggered by calling RequestMoveToServer().

    WindowMovedEventArgs

    Move event is sent when window is resized by user or the display server.

    WindowOrientationChangedEventArgs

    OrientationChangedArgs

    WindowResizeCompletedEventArgs

    Resize Completed event is sent when window has been resized the display server. It is triggered by calling RequestResizeToServer().

    XmlnsDefinitionAttribute

    Specifies a mapping on a per-assembly basis between a XAML namespace and a CLR namespace,
    which is then used for type resolution by a XAML object writer or XAML schema context.

    Structs

    AnchorPoint

    [Obsolete("Do not use this, that will be deprecated.")]

    BorderVisualProperty

    This specifies properties of the BorderVisual.

    ClipEvent

    This specifies clipboard event data.

    ColorVisualProperty

    This specifies properties of the ColorVisual.

    DragData

    This specifies drag data.

    DragEvent

    This specifies drag event.

    FontFamily

    FontFamily constant.

    FontSizeScale

    FontSizeScale constant.

    GradientVisualProperty

    This specifies properties of the GradientVisual.

    HiddenInputProperty

    The HiddenInput property.

    ImageVisualProperty

    This specifies properties of the ImageVisual.

    LayoutLength

    [Draft] A type that represents a layout length. Currently, this implies pixels, but could be extended to handle device dependant sizes, etc.

    MeasuredSize

    [Draft] Class that encodes a measurement and a measure state, which is set if the measured size is too small.

    MeasureSpecification

    [Draft] A MeasureSpecification is used during the Measure pass by a LayoutGroup to inform it's children how to be measured. For instance, it may measure a child with an exact width and an unspecified height in order to determine height for width.

    MeshVisualProperty

    This specifies properties of the MeshVisual.

    NpatchImageVisualProperty

    This specifies properties of the NpatchImageVisual.

    Offset

    Offset has left, right, bottom, top value.

    ParentOrigin

    ParentOrigin constants.

    PivotPoint

    PivotPoint constants.

    PositionAxis

    PositionAxis constants.

    PrimitiveVisualProperty

    This specifies properties of the PrimitiveVisual.

    SelectionPopupStyleProperty

    The SelectionPopupStyle property.

    SlideTransitionDirection

    Pre-defined SlideTransition Direction

    TextVisualProperty

    This specifies properties of the TextVisual.

    Visual

    This specifies visual types.

    Visual.Property

    This specifies visual properties.

    Visual.ShaderProperty

    This specifies shader properties.

    Interfaces

    FocusManager.ICustomFocusAlgorithm

    ICustomFocusAlgorithm is used to provide the custom keyboard focus algorithm for retrieving the next focusable view.
    The application can implement the interface and override the keyboard focus behavior.
    If the focus is changing within a layout container, then the layout container is queried first to provide the next focusable view.
    If this does not provide a valid view, then the Keyboard FocusManager will check focusable properties to determine the next focusable actor.
    If focusable properties are not set, then the keyboard FocusManager calls the GetNextFocusableView() method of this interface.

    IBorderInterface

    This is the interface used to draw the border UI.

    ICustomAwareDeviceFocusAlgorithm

    ICustomAwareDeviceFocusAlgorithm inherits from FocusManager.ICustomFocusAlgorithm ICustomAwareDeviceFocusAlgorithm is used to provide the custom keyboard focus algorithm for retrieving the next focusable view.
    The application can implement the interface and override the keyboard focus behavior.
    If the focus is changing within a layout container, then the layout container is queried first to provide the next focusable view.
    If this does not provide a valid view, then the Keyboard FocusManager will check focusable properties to determine the next focusable actor.
    If focusable properties are not set, then the keyboard FocusManager calls the GetNextFocusableView() method of this interface.
    This interface calls GetNextFocusableView() with deviceName.

    ILayoutParent

    [Draft] Interface that defines a layout Parent. Enables a layout child to access methods on its parent, e.g. Remove (during unparenting)

    Enums

    AlphaFunction.BuiltinFunctions

    This specifies the various types of BuiltinFunctions.

    AlphaFunction.Modes

    This specifies which mode is set for AlphaFunction.

    Animatable.Capability

    Enumeration for Handle's capabilities that can be queried.

    AnimatableProperties

    The properties that can be animated.

    Animation.EndActions

    Enumeration for what to do when the animation ends, stopped, or destroyed.

    Animation.Interpolation

    Enumeration for what interpolation method to use on key-frame animations.

    Animation.LoopingModes

    Enumeration for what looping mode is in.

    Animation.States

    Enumeration for what state the animation is in.

    ArcVisual.CapType

    Enumeration for the cap style of the arc line.

    AutofillContainer.ItemHint

    Enumeration for hint of the autofill item.

    AutoScrollStopMode

    Auto scrolling stop behavior.

    BlendEquationType

    Enumeration for blend equation.

    BlendFactorType

    Enumeration for blend factor.

    BlendModeType

    Enumeration for blend mode.

    CacheModel

    Enumeration for setting cache model of a WebView.

    CameraType

    Enumeration for type determination of how the camera operates.

    CircularAlignment

    Enumeration for Circular alignment. The @p horizontalAlignment and @p verticalAlignment can be used to align the text within the text area.

    ClippingModeType

    Enumeration for the ClippingMode describing how this actor's children will be clipped against it.

    ColorBlendingMode

    Defines how a color is blended.

    ColorMode

    This specifies whether the actor uses its own color or inherits.

    CookieAcceptPolicy

    Enumeration for setting cache model of a WebView.

    CustomViewBehaviour

    This specifies customView behavior types.

    DefaultItemLayoutProperty

    DefaultItemLayoutType

    DepthFunctionType

    Enumeration for depth functions.

    DepthTestModeType

    Enumeration for depth buffer test (read) modes.

    DepthWriteModeType

    Enumeration for depth buffer write modes.

    DeviceClassType

    An enum of Device Class types.

    DeviceSubClassType

    An enum of Device Subclass types.

    DimensionType

    This specifies the dimension of the width or the height for size negotiation.

    DirectionBias

    The Direction Bias type.

    DisposeTypes

    DragSourceEventType

    Drag source event type.

    DragType

    Drag event type.

    DrawModeType

    Enumeration for the instance of how the actor and it's children will be drawn.

    EllipsisPosition

    An enum of ellipsis position.

    EncodedImageBuffer.ImageTypes

    The list of type of encoded image buffer. It will be used when we want to specify the buffer data type.

    FaceCullingModeType

    Enumeration for face culling mode.

    FilterModeType

    The filter mode type.

    FittingModeType

    This specifies fitting mode types. Fitting options, used when resizing images to fit desired dimensions.
    A fitting mode controls the region of a loaded image to be mapped to the desired image rectangle.
    All fitting modes preserve the aspect ratio of the image contents.

    FlexLayout.AlignmentType

    Enumeration for the alignment of the flex items or lines when the items or lines do not use all the available space on the cross-axis.

    FlexLayout.FlexDirection

    Enumeration for the direction of the main axis in the flex container. This determines the direction that flex items are laid out in the flex container.

    FlexLayout.FlexJustification

    Enumeration for the alignment of the flex items when the items do not use all available space on the main-axis.

    FlexLayout.FlexWrapType

    Enumeration for the wrap type of the flex container when there is no enough room for all the items on one flex line.

    FlexLayout.PositionType

    Enumeration for the position type of the flex item how it is positioned within its parent.

    FontSizeType

    Enumeration for the size type of font.

    FontSlantType

    Enumeration type for the font's slant.

    FontWeightType

    Enumeration type for the font's weight.

    FontWidthType

    Enumeration type for the font's width.

    FrameBuffer.Attachment.Mask

    FrameError

    Enumeration for the frame error.

    FrameType

    Enable FrameBroker(Caller) or FrameProvider(Callee)

    Geometry.Type

    Enumeration for the description of the type of geometry, used to determine how the coordinates will be used.

    Gesture.GestureType

    Enumeration for type of gesture.

    Gesture.SourceDataType

    This is the data of source type

    Gesture.SourceType

    This is the value of which source the gesture was started with. (ex : mouse)

    Gesture.StateType

    Enumeration for state of the gesture.

    GestureSourceType

    Gesture source type. Deprecated. This value will be deleted without notice. Please do not use it.

    GLESVersion

    This Enumeration is used the GLES version for EGL configuration. It is for GLWindow and GLView.

    GLRenderingMode

    Enumeration for rendering mode This Enumeration is used to choose the rendering mode. It is for GLWindow and GLView.

    GLWindow.GLWindowOrientation

    Enumeration for orientation of the window is the way in which a rectangular page is oriented for normal viewing.

    GlyphType

    Enumeration type for the glyph type.

    GradientVisualSpreadMethodType

    This specifies SpreadMethod types.
    SpreadMethod defines what happens if the gradient starts or ends inside the bounds of the target rectangle.

    GradientVisualUnitsType

    The type of coordinate system for certain attributes of the points in a gradient.

    Graphics.BackendType

    Graphics Backend Type.

    GridLayout.Alignment

    The alignment of the grid layout child.

    GridLayout.Orientation

    Enumeration for the direction in which the content is laid out

    GridLayout.StretchFlags

    The value how child is resized within its space.

    HiddenInputModeType

    The type for HiddenInput mode.

    HorizontalAlignment

    Enumeration for the horizontal alignment of objects such as texts and layout items.

    HorizontalAlignmentType

    Enumeration for horizontal alignment types.

    InputFilterType

    Enumeration for the type of InputFilter.

    InputMethod.ActionButtonTitleType

    Specifies what the Input Method "action" button functionality is set to.

    InputMethod.AutoCapitalType

    Autocapitalization Types.

    InputMethod.CategoryType

    SetType that can be changed in the system input method.

    InputMethod.NormalLayoutType

    Available variation for the normal layout.

    InputMethod.NumberOnlyLayoutType

    Available variation for the number only layout.

    InputMethod.PanelLayoutType

    Input panel (virtual keyboard) layout types..

    InputMethod.PasswordLayoutType

    Available variation for the password layout.

    InputMethodContext.EventType

    Events that are generated by the IMF.

    InputMethodContext.InputPanelAlign

    Enumeration for align of the input panel.

    InputMethodContext.InputPanelLanguage

    Enumeration for the language mode of the input panel.

    InputMethodContext.KeyboardType

    Enumeration for the types of keyboard.

    InputMethodContext.State

    Enumeration for the state of the input panel.

    InputMethodContext.TextDirection

    The direction of the text.

    Key.StateType

    Enumeration for specifying the state of the key event.

    Layer.LayerBehavior

    Enumeration for the behavior of the layer.

    LinearLayout.Alignment

    [Draft] Enumeration for the alignment of the linear layout items

    LinearLayout.Orientation

    [Draft] Enumeration for the direction in which the content is laid out

    LineWrapMode

    An enum of the line wrap mode of text controls.

    LoadPolicyType

    Specifies the load policy types.
    Decides when the image texture should be loaded.

    MeasuredSize.StateType

    Measured states for a Size value.

    MeasureSpecification.ModeType

    Size mode for this MeasureSpecification

    MeshVisualShadingModeValue

    The shading mode used by the mesh visual.

    MouseButton

    Mouse device button type.

    MouseInOut.StateType

    The state of the mouse event.

    MouseRelative.StateType

    The state of the mouse event.

    NativeImageQueue.ColorFormat

    NativeImageSource.ColorDepth

    NotificationLevel

    An enum of notification window's priority level.

    NUIApplication.ThemeOptions

    Enumeration for theme options of the NUIApplication.

    NUIApplication.WindowMode

    Enumeration for deciding whether a NUI application window is opaque or transparent.

    NUIGadgetLifecycleState

    Enumeration for the lifecycle state of the NUIGadget.

    NUIGadgetType

    Enumeration for the type of the NUIGadget.

    PixelData.ReleaseFunction

    Enumeration for function to release the pixel buffer.

    PixelFormat

    Enumeration for Pixel formats.
    Pixel format, default color depth is RGBA 32 bit with alpha.

    PointStateType

    Enumeration for point state type.

    PrimitiveVisualShapeType

    The primitive shape to render as a primitive visual.

    ProjectionMode

    Enumeration for the projection modes.

    PropertyAccessMode

    This specifies the property access mode types.
    Enumeration for the access mode for custom properties.

    PropertyKey.KeyType

    The type of key.

    PropertyNotification.NotifyMode

    Enumeration for description of how to check condition.

    PropertyType

    This specifies all the property types.
    Enumeration for the property types supported.

    RelativeLayout.Alignment

    The alignment of the relative layout child.

    ReleasePolicyType

    Specifies the release policy types.
    Decides if the image should be cached in different conditions.

    RenderingBehaviorType

    Enumeration for Setting the rendering behavior of a Window.

    RenderModeType

    Enumeration for the controls of how this renderer uses its stencil properties and writes to the color buffer.

    RenderTask.RefreshRate

    ResizePolicyType

    Enumeration for size negotiation resize policies.

    Ruler.RulerType

    SamplingModeType

    This specifies sampling mode types. Filtering options are used when resizing images to sample original pixels.
    A SamplingMode controls how pixels in an input image are sampled and combined to generate each pixel of a destination image during scaling.
    NoFilter and Box modes do not guarantee that the output pixel array exactly matches the rectangle specified by the desired dimensions and the FittingMode,
    but all other filter modes do if the desired dimensions are not more than the raw dimensions of the input image file.

    ScreenOffMode

    An enum of screen mode.

    ScriptableProperty.ScriptableType

    The enum of ScriptableType

    ScrollModeType

    This specifies all the scroll mode type.

    ScrollState

    An enum of the scroll state of the text editor.

    Shader.Hint.Value

    Enumeration for the hint value.

    SizeScalePolicyType

    Enumeration for policies to determine how an actor should resize itself when having its size set in size negotiation.

    StencilFunctionType

    Enumeration for the comparison function used on the stencil buffer.

    StencilOperationType

    Enumeration for specifying the action to take when the stencil (or depth) test fails during stencil test.

    StyleChangeType

    Types of style change. Enumeration for the StyleChange type.

    TextDirection

    An enum of text directions.

    TextLayout

    Enumeration for Text Layout.

    TextureType

    The texture type.

    TransitionCondition

    The conditions for transitions.

    TTSPlayer.TTSMode

    Enumeration for the instance of TTS mode.

    TTSPlayer.TTSState

    Enumeration for the instance of TTS state.

    UnderlineType

    Enumeration for the type of Underline.

    VerticalAlignment

    Enumeration for the vertical alignment of objects such as texts and layout items.

    VerticalAlignmentType

    Enumeration for vertical alignment types.

    VerticalLineAlignment

    An enum of vertical line alignments.

    VisibilityChangeType

    The visibility change type.

    Visual.AlignType

    This specifies visual align types.

    Visual.Type

    The index for the visual type.

    VisualFittingModeType

    The values of this enum determine how the visual should fit into the view.

    VisualTransformPolicyType

    This specifies policy types that could be used by the transform for the offset or size.

    VisualTransformPropertyType

    This specifies all the transform property types.

    WebCertificate.PolicyDecisionErrorType

    WebConsoleMessage.SeverityLevel

    Enumeration for level of log severity.

    WebContext.ApplicationType

    Application type

    WebContext.CacheModelType

    Cache model

    WebContextMenuItem.ItemTag

    Enum that provides the tags of items for the context menu.

    WebContextMenuItem.ItemType

    Enum that defines the types of the items for the context menu.

    WebCookieManager.CookieAcceptPolicyType

    Enumeration for cookie accept policy

    WebCookieManager.CookiePersistentStorageType

    Enumeration for cookie persistent storage type.

    WebHitTestResult.ResultContext

    Enumeration for context of hit test result.

    WebPageLoadError.ErrorCode

    Enumeration for the load error code

    WebPageLoadError.ErrorType

    Enumeration for the load error type

    WebPolicyDecisionMaker.DecisionType

    Decision type

    WebPolicyDecisionMaker.NavigationType

    Policy navigation type

    WebViewScrollEdgeReachedEventArgs.Edge

    The enumeration for edge.

    Wheel.WheelType

    The type of the wheel event.

    Widget.TerminationType

    Enumeration for termination type of widget

    Window.BorderDirection

    This is an enum for the resize direction or move value when the border area is touched.

    Window.BorderResizePolicyType

    This enum is the policy when resizing the border window.

    Window.EffectState

    Enumeration for transition effect's state.

    Window.EffectStates

    Enumeration for transition effect's state.

    Window.EffectType

    Enumeration for transition effect's type.

    Window.EffectTypes

    Enumeration for transition effect's type.

    Window.InsetsPartState

    The state of insets part.

    Window.InsetsPartType

    The type of insets part.

    Window.KeyGrabMode

    Enumeration for the key grab mode for platform-level APIs.

    Window.ResizeDirection

    Enumeration for window resized mode by display server.

    Window.WindowOrientation

    Enumeration for orientation of the window is the way in which a rectangular page is oriented for normal viewing.

    WindowLayoutType

    An enum of window layout types.

    WindowType

    An enum of window types.

    WrapModeType

    This specifies wrap mode types.
    WrapModeU and WrapModeV separately decide how the texture should be sampled when the u and v coordinate exceeds the range of 0.0 to 1.0.

    Delegates

    ApplicationTransitionManager.AnimationEventHandler

    AnimationEventHandler for FrameBroker animation

    Clipboard.ClipboardCallback

    User callback for clipboard event.

    DaliEventHandler<T, U>

    [UnmanagedFunctionPointer(CallingConvention.Cdecl)] this should be removed with EventHandler from .NET

    DaliEventHandlerWithReturnType<T, U, R>

    [UnmanagedFunctionPointer(CallingConvention.Cdecl)]

    DragAndDrop.DragAndDropEventHandler

    DragAndDrop.DragAndDropWindowEventHandler

    DragAndDrop.SourceEventHandler

    EventHandlerWithReturnType<T, U, R>

    [UnmanagedFunctionPointer(CallingConvention.Cdecl)]

    Extents.ExtentsChangedCallback

    Constructor

    GLWindow.GLInitializeCallbackType

    Type of callback to initialize native GL code.

    GLWindow.GLRenderFrameCallbackType

    Type of callback to render to frame to use native GL code.

    GLWindow.GLTerminateCallbackType

    Type of callback to cleanup native GL resource.

    ItemFactory.SwigDelegateItemFactory_0

    ItemFactory.SwigDelegateItemFactory_1

    ItemFactory.SwigDelegateItemFactory_2

    NUIApplication.XamlLoadedHandler

    Xaml loaded delegate.

    ReturnTypeEventHandler<TSource, TEvent, TReturn>

    [UnmanagedFunctionPointer(CallingConvention.Cdecl)]

    WebContext.DownloadStartedCallback

    The callback function that is invoked when download is started.

    WebContext.HttpRequestInterceptedCallback

    The callback function that is invoked when http request need be intercepted.

    WebContext.MimeOverriddenCallback

    The callback function that is invoked when current mime type need be overridden.

    WebContext.PasswordDataListAcquiredCallback

    The callback function that is invoked when password data list is acquired.

    WebContext.SecurityOriginListAcquiredCallback

    The callback function that is invoked when security origin list is acquired.

    WebContext.StorageUsageAcquiredCallback

    The callback function that is invoked when storage usage is acquired.

    Window.FrameCallbackType

    Type of callback which is called when the frame rendering is done by graphics driver or when the frame is displayed on display.

    Back to top Copyright © 2016-2025 Samsung
    Generated by DocFX