NativeScript/tns-core-modules/ui/enums/enums.d.ts

declare module "ui/enums" {

    import animationModule = require("ui/animation");

    /**
     * Represents a soft keyboard flavor.
     */
    module KeyboardType {
        /**
         * Android: [TYPE_CLASS_DATETIME](http://developer.android.com/reference/android/text/InputType.html#TYPE_CLASS_DATETIME) | [TYPE_DATETIME_VARIATION_NORMAL](http://developer.android.com/reference/android/text/InputType.html#TYPE_DATETIME_VARIATION_NORMAL)
         * iOS:  [UIKeyboardTypeNumbersAndPunctuation](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UITextInputTraits_Protocol/index.html#//apple_ref/c/tdef/UIKeyboardType)
         */
        export var datetime: string;

        /**
         * Android: [TYPE_CLASS_PHONE](http://developer.android.com/reference/android/text/InputType.html#TYPE_CLASS_PHONE)
         * iOS:  [UIKeyboardTypePhonePad](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UITextInputTraits_Protocol/index.html#//apple_ref/c/tdef/UIKeyboardType)
         */
        export var phone: string;

        /**
         * Android: [TYPE_CLASS_NUMBER](http://developer.android.com/reference/android/text/InputType.html#TYPE_CLASS_NUMBER) | [TYPE_NUMBER_VARIATION_NORMAL](http://developer.android.com/intl/es/reference/android/text/InputType.html#TYPE_NUMBER_VARIATION_NORMAL) | [TYPE_NUMBER_FLAG_SIGNED](http://developer.android.com/reference/android/text/InputType.html#TYPE_NUMBER_FLAG_SIGNED) | [TYPE_NUMBER_FLAG_DECIMAL](http://developer.android.com/reference/android/text/InputType.html#TYPE_NUMBER_FLAG_DECIMAL)
         * iOS:  [UIKeyboardTypeNumbersAndPunctuation](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UITextInputTraits_Protocol/index.html#//apple_ref/c/tdef/UIKeyboardType)
         */
        export var number: string;

        /**
         * Android: [TYPE_CLASS_TEXT](http://developer.android.com/reference/android/text/InputType.html#TYPE_CLASS_TEXT) | [TYPE_TEXT_VARIATION_URI](http://developer.android.com/reference/android/text/InputType.html#TYPE_TEXT_VARIATION_URI)
         * iOS:  [UIKeyboardTypeURL](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UITextInputTraits_Protocol/index.html#//apple_ref/c/tdef/UIKeyboardType)
         */
        export var url: string;

        /**
         * Android: [TYPE_CLASS_TEXT](http://developer.android.com/reference/android/text/InputType.html#TYPE_CLASS_TEXT) | [TYPE_TEXT_VARIATION_EMAIL_ADDRESS](http://developer.android.com/reference/android/text/InputType.html#TYPE_TEXT_VARIATION_EMAIL_ADDRESS)
         * iOS:  [UIKeyboardTypeEmailAddress](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UITextInputTraits_Protocol/index.html#//apple_ref/c/tdef/UIKeyboardType)
         */
        export var email: string;
    }

    /**
     * Represents the flavor of the return key on the soft keyboard.
     */
    module ReturnKeyType {
        /**
         * Android: [IME_ACTION_DONE](http://developer.android.com/reference/android/view/inputmethod/EditorInfo.html#IME_ACTION_DONE)
         * iOS: [UIReturnKeyDone](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UITextInputTraits_Protocol/index.html#//apple_ref/c/tdef/UIReturnKeyType)
         */
        export var done: string;

        /**
         * Android: [IME_ACTION_NEXT](http://developer.android.com/reference/android/view/inputmethod/EditorInfo.html#IME_ACTION_NEXT)
         * iOS: [UIReturnKeyNext](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UITextInputTraits_Protocol/index.html#//apple_ref/c/tdef/UIReturnKeyType)
         */
        export var next: string;

        /**
         * Android: [IME_ACTION_GO](http://developer.android.com/reference/android/view/inputmethod/EditorInfo.html#IME_ACTION_GO)
         * iOS: [UIReturnKeyGo](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UITextInputTraits_Protocol/index.html#//apple_ref/c/tdef/UIReturnKeyType)
         */
        export var go: string;

        /**
         * Android: [IME_ACTION_SEARCH](http://developer.android.com/reference/android/view/inputmethod/EditorInfo.html#IME_ACTION_SEARCH)
         * iOS: [UIReturnKeySearch](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UITextInputTraits_Protocol/index.html#//apple_ref/c/tdef/UIReturnKeyType)
         */
        export var search: string;

        /**
         * Android: [IME_ACTION_SEND](http://developer.android.com/reference/android/view/inputmethod/EditorInfo.html#IME_ACTION_SEND)
         * iOS: [UIReturnKeySend](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UITextInputTraits_Protocol/index.html#//apple_ref/c/tdef/UIReturnKeyType)
         */
        export var send: string;
    }

    /**
     * Represents a text-align enumeration.
     */
    module TextAlignment {
        /**
         * Represents left text-align.
         */
        export var left: string;

        /**
         * Represents center text-align.
         */
        export var center: string;

        /**
         * Represents right text-align.
         */
        export var right: string;
    }

    /**
     * Orientation indicates a direction of a layout that can exist in a horizontal or vertical state.
     */
    module Orientation {
        /**
         * Layout should be horizontally oriented.
         */
        export var horizontal: string;
        /**
         * Layout should be vertically oriented.
         */
        export var vertical: string;
    }

    /**
     * Orientation of a device.
     */
    module DeviceOrientation {
        /**
         * Portrait orientation.
         */
        export var portrait: string;
        /**
         * Landscape orientation.
         */
        export var landscape: string;
        /**
         * Orientation cannot be determined.
         */
        export var unknown: string;
    }

    /**
     * HorizontalAlignment indicates where an element should be displayed on the horizontal axis relative to the allocated layout slot of the parent element.
     */
    module HorizontalAlignment {
        /**
         * An element should be left aligned.
         */
        export var left: string;

        /**
         * An element should be center aligned.
         */
        export var center: string;

        /**
         * An element should be right aligned.
         */
        export var right: string;

        /**
         * An element should be stretched to fill all the available size.
         */
        export var stretch: string;
    }

    /**
     * VerticalAlignment indicates where an element should be displayed on the horizontal axis relative to the allocated layout slot of the parent element.
     */
    module VerticalAlignment {
        /**
         * An element should be top aligned.
         */
        export var top: string;

        /**
         * An element should be center aligned.
         */
        export var center: string;

        /**
         * Same as center. An element should be aligned in the middle.
         */
        export var middle: string;

        /**
         * An element should be bottom aligned.
         */
        export var bottom: string;

        /**
         * An element should be stretched to fill all the available size.
         */
        export var stretch: string;
    }

    /**
     * Describes how content is resized to fill its allocated space.
     */
    module Stretch {
        /**
         * The image preserves its original size.
         */
        export var none: string;

        /**
         * The image is resized to fill in the destination dimensions while it preserves its native aspect ratio.
         */
        export var aspectFill: string;

        /**
         * The image is resized to fit the destination dimensions while it preserves
         * its native aspect ratio. If the aspect ratio of the destination rectangle differs from the image,
         * the image is clipped to fit in the destination
         */
        export var aspectFit: string;

        /**
         * The image is resized to fill the destination dimensions. The aspect ratio is not preserved.
         */
        export var fill: string;
    }

    /**
     * Represents the visibility mode of a view.
     */
    export module Visibility {
        /**
         * The view is visible.
         */
        export var visible: string;

        /**
         * Obsolete. Please use 'collapse' instead!
         */
        export var collapsed: string;

        /**
         * The view is not visible and won't take place in the layout.
         */
        export var collapse: string;
    }

    /**
     * A flag enum that represents common font attributes.
     */
    module FontAttributes {
        /**
         * Denotes that text should be drawn in a normal style.
         */
        export var Normal: number;

        /**
         * Denotes that text should be drawn in a bold weight.
         */
        export var Bold: number;

        /**
         * Denotes that text should be drawn in a italic style.
         */
        export var Italic: number;
    }

    /**
     * Describes the type of a device
     */
    module DeviceType {
        /**
         * Indicates a smart-phone device.
         */
        export var Phone: string;

        /**
         * Indicates a tablet device.
         */
        export var Tablet: string;
    }

    /**
     * Represents an enumeration specifying when the text property of an EditableTextBase will be updated.
     */
    module UpdateTextTrigger {
        /**
         * The text property will be udpaded when the widget loses focus.
         */
        export var focusLost: string;

        /**
         * The text property will be udpaded on every single character typed by the user.
         */
        export var textChanged: string;
    }

    /**
     * Specifies common accuracy values.
     */
    module Accuracy {
        /**
         * The default accuracy. About 300 meters.
         */
        export var any: number;

        /**
         * High accuracy. About 3 meters.
         */
        export var high: number;
    }

    /**
     * Specifies the Dock position of a child element that is inside a DockLayout.
     */
    module Dock {
        /**
         * A child element that is positioned on the left side of the DockLayout.
         */
        export var left: string;

        /**
         * A child element that is positioned on the top side of the DockLayout.
         */
        export var top: string;

        /**
         * A child element that is positioned on the right side of the DockLayout.
         */
        export var right: string;

        /**
         * A child element that is positioned on the bottom side of the DockLayout.
         */
        export var bottom: string;
    }

    /**
     * Represents the auto-capitalization style for a text input.
     */
    module AutocapitalizationType {
        /**
         * Do not capitalize any text automatically.
         */
        export var none: string;

        /**
         * Capitalize the first letter of each word automatically.
         */
        export var words: string;

        /**
         * Capitalize the first letter of each sentence automatically.
         */
        export var sentences: string;

        /**
         * Capitalize all characters automatically.
         */
        export var allCharacters: string;
    }

    /**
     * Defines the recognized image formats.
     */
    module ImageFormat {
        /**
         * The W3C Portable Network Graphics (PNG) image format.
         */
        export var png: string;

        /**
         * The Joint Photographic Experts Group (JPEG) image format.
         */
        export var jpeg: string;
    }

    /**
     * Specifies NavigationBar visibility mode.
     */
    module NavigationBarVisibility {
        /**
         * NavigationBar will be visible if there if frame backstack canGoBack is true or if the page Action Bar is not empty.
         */
        export var auto: string;

        /**
         * NavigationBar will be hidden.
         */
        export var never: string;

        /**
         * NavigationBar will be visible.
         */
        export var always: string;
    }

    /**
     * Specifies the visibility of the application bar icon
     */
    export module AndroidActionBarIconVisibility {
        export var auto: string;
        export var never: string;
        export var always: string;
    }

    /**
     * Specifies android MenuItem position.
     */
    module AndroidActionItemPosition {
        /**
         * Always show this item as a button in an Action Bar.
         */
        export var actionBar: string;

        /**
         * Show this item as a button in an Action Bar if the system decides there is room for it.
         */
        export var actionBarIfRoom: string;

        /**
         * Never show this item as a button in an Action Bar.
         */
        export var popup: string;
    }

    /**
     * Specifies different font styles.
     */
    export module FontStyle {
        /**
         * Normal font style.
         */
        export var normal: string;

        /**
         * Italic font style.
         */
        export var italic: string;
    }

    /**
     * Specifies different text decorations.
     */
    export module TextDecoration {
        /**
         * No decoration.
         */
        export var none: string;

        /**
         * Text decoration underline.
         */
        export var underline: string;

        /**
         * Text decoration line-through.
         */
        export var lineThrough: string;
    }

    /**
     * Specifies different text transforms.
     */
    export module TextTransform {
        /**
         * No transform.
         */
        export var none: string;

        /**
         * Text transform capitalize.
         */
        export var capitalize: string;

        /**
         * Text transform uppercase.
         */
        export var uppercase: string;

        /**
         * Text transform lowercase.
         */
        export var lowercase: string;
    }

    /**
     * Specifies different white spaces.
     */
    export module WhiteSpace {
        /**
         * Normal wrap.
         */
        export var normal: string;

        /**
         * No wrap.
         */
        export var nowrap: string;
    }

    /**
     * Specifies different font weights.
     */
    export module FontWeight {
        /**
         * Thin font weight. CSS font-weight 100.
         */
        export var thin: string;
        
        /**
         * Extra-light / Ultra-light font weight. CSS font-weight 200.
         */
        export var extraLight: string;
        
        /**
         * Light font weight. CSS font-weight 300.
         */
        export var light: string;

        /**
         * Normal font weight. CSS font-weight 400.
         */
        export var normal: string;

        /**
         * Medium font weight. CSS font-weight 500.
         */
        export var medium: string;

        /**
         * Semi-bold / Demi-bold font weight. CSS font-weight 600.
         */
        export var semiBold: string;
        
        /**
         * Bold font weight. CSS font-weight 700.
         */
        export var bold: string;

        /**
         * Extra-bold / Ultra-bold font weight. CSS font-weight 800.
         */
        export var extraBold: string;

        /**
         * Black font weight. CSS font-weight 900.
         */
        export var black: string;
    }

    /**
     * Specifies background repeat.
     */
    export module BackgroundRepeat {
        export var repeat: string;
        export var repeatX: string;
        export var repeatY: string;
        export var noRepeat: string;
    }

    /**
     * Specifies android MenuItem position.
     */
    module IOSActionItemPosition {
        /**
         * Show this item at the left of the navigation bar.
         */
        export var left: string;

        /**
         * Show this item at the right of the action bar.
         */
        export var right: string;
    }

    /**
     * Represents an animation curve type.
     */
    export module AnimationCurve {

        /**
         * Default value. Specifies a transition effect with a slow start, then fast, then end slowly (equivalent to cubic-bezier(0.25,0.1,0.25,1))
         */
        export var ease: string;
        
        /**
         * An ease-in curve causes the animation to begin slowly, and then speed up as it progresses.
         */
        export var easeIn: string;

        /**
         * An ease-out curve causes the animation to begin quickly, and then slow down as it completes.
         */
        export var easeOut: string;

        /**
         * An ease-in ease-out curve causes the animation to begin slowly, accelerate through the middle of its duration, and then slow again before completing.
         */
        export var easeInOut: string;

        /**
         * A linear animation curve causes an animation to occur evenly over its duration.
         */
        export var linear: string;

        /**
         * A spring animation curve causes an animation to produce a spring (bounce) effect.
         */
        export var spring: string;

        /**
         * A custom cubic bezier function defined by its two control points. Possible values are numeric values from 0 to 1
         */
        export function cubicBezier(x1: number, y1: number, x2: number, y2: number): animationModule.CubicBezierAnimationCurve;
    }
}