Constants

This page contains a list of constants used by the pyto_ui API.

UI Elements Colors

pyto_ui.COLOR_LABEL

The color for text labels containing primary content.

pyto_ui.COLOR_SECONDARY_LABEL

The color for text labels containing secondary content.

pyto_ui.COLOR_TERTIARY_LABEL

The color for text labels containing tertiary content.

pyto_ui.COLOR_QUATERNARY_LABEL

The color for text labels containing quaternary content.

pyto_ui.COLOR_SYSTEM_FILL

An overlay fill color for thin and small shapes.

pyto_ui.COLOR_SECONDARY_SYSTEM_FILL

An overlay fill color for medium-size shapes.

pyto_ui.COLOR_TERTIARY_SYSTEM_FILL

An overlay fill color for large shapes.

pyto_ui.COLOR_QUATERNARY_SYSTEM_FILL

An overlay fill color for large areas containing complex content.

pyto_ui.COLOR_PLACEHOLDER_TEXT

The color for placeholder text in controls or text views.

pyto_ui.COLOR_SYSTEM_BACKGROUND

The color for the main background of your interface.

pyto_ui.COLOR_SECONDARY_SYSTEM_BACKGROUND

The color for content layered on top of the main background.

pyto_ui.COLOR_TERTIARY_SYSTEM_BACKGROUND

The color for content layered on top of secondary backgrounds.

pyto_ui.COLOR_SYSTEM_GROUPED_BACKGROUND

The color for the main background of your grouped interface.

pyto_ui.COLOR_SECONDARY_GROUPED_BACKGROUND

The color for content layered on top of the main background of your grouped interface.

pyto_ui.COLOR_TERTIARY_GROUPED_BACKGROUND

The color for content layered on top of secondary backgrounds of your grouped interface.

pyto_ui.COLOR_SEPARATOR

The color for thin borders or divider lines that allows some underlying content to be visible.

pyto_ui.COLOR_OPAQUE_SEPARATOR

The color for borders or divider lines that hide any underlying content.

The color for links.

pyto_ui.COLOR_DARK_TEXT

The nonadaptable system color for text on a light background.

pyto_ui.COLOR_LIGHT_TEXT

The nonadaptable system color for text on a dark background.

Standard Colors

pyto_ui.COLOR_SYSTEM_BLUE

A blue color that automatically adapts to the current trait environment.

pyto_ui.COLOR_SYSTEM_GREEN

A green color that automatically adapts to the current trait environment.

pyto_ui.COLOR_SYSTEM_INDIGO

An indigo color that automatically adapts to the current trait environment.

pyto_ui.COLOR_SYSTEM_ORANGE

An orange color that automatically adapts to the current trait environment.

pyto_ui.COLOR_SYSTEM_PINK

A pink color that automatically adapts to the current trait environment.

pyto_ui.COLOR_SYSTEM_PURPLE

A purple color that automatically adapts to the current trait environment.

pyto_ui.COLOR_SYSTEM_RED

A red color that automatically adapts to the current trait environment.

pyto_ui.COLOR_SYSTEM_TEAL

A teal color that automatically adapts to the current trait environment.

pyto_ui.COLOR_SYSTEM_YELLOW

A yellow color that automatically adapts to the current trait environment.

pyto_ui.COLOR_SYSTEM_GRAY

The base gray color.

pyto_ui.COLOR_SYSTEM_GRAY2

A second-level shade of grey.

pyto_ui.COLOR_SYSTEM_GRAY3

A third-level shade of grey.

pyto_ui.COLOR_SYSTEM_GRAY4

A fourth-level shade of grey.

pyto_ui.COLOR_SYSTEM_GRAY5

A fifth-level shade of grey.

pyto_ui.COLOR_SYSTEM_GRAY6

A sixth-level shade of grey.

Fixed Colors

pyto_ui.COLOR_CLEAR

A color object with grayscale and alpha values that are both 0.0.

pyto_ui.COLOR_BLACK

A color object in the sRGB color space with a grayscale value of 0.0 and an alpha value of 1.0.

pyto_ui.COLOR_BLUE

A color object with RGB values of 0.0, 0.0, and 1.0 and an alpha value of 1.0.

pyto_ui.COLOR_BROWN

A color object with RGB values of 0.6, 0.4, and 0.2 and an alpha value of 1.0.

pyto_ui.COLOR_CYAN

A color object with RGB values of 0.0, 1.0, and 1.0 and an alpha value of 1.0.

pyto_ui.COLOR_DARK_GRAY

A color object with a grayscale value of 1/3 and an alpha value of 1.0.

pyto_ui.COLOR_GRAY

A color object with a grayscale value of 0.5 and an alpha value of 1.0.

pyto_ui.COLOR_GREEN

A color object with RGB values of 0.0, 1.0, and 0.0 and an alpha value of 1.0.

pyto_ui.COLOR_LIGHT_GRAY

A color object with a grayscale value of 2/3 and an alpha value of 1.0.

pyto_ui.COLOR_MAGENTA

A color object with RGB values of 1.0, 0.0, and 1.0 and an alpha value of 1.0.

pyto_ui.COLOR_ORANGE

A color object with RGB values of 1.0, 0.5, and 0.0 and an alpha value of 1.0.

pyto_ui.COLOR_PURPLE

A color object with RGB values of 0.5, 0.0, and 0.5 and an alpha value of 1.0.

pyto_ui.COLOR_RED

A color object with RGB values of 1.0, 0.0, and 0.0 and an alpha value of 1.0.

pyto_ui.COLOR_WHITE

A color object with a grayscale value of 1.0 and an alpha value of 1.0.

pyto_ui.COLOR_YELLOW

A color object with RGB values of 1.0, 1.0, and 0.0 and an alpha value of 1.0.

Keyboard Appearance

pyto_ui.KEYBOARD_APPEARANCE_DEFAULT

Specifies the default keyboard appearance for the current input method.

pyto_ui.KEYBOARD_APPEARANCE_LIGHT

Specifies a keyboard appearance suitable for a light UI look.

pyto_ui.KEYBOARD_APPEARANCE_DARK

Specifies a keyboard appearance suitable for a dark UI look.

Keyboard Type

pyto_ui.KEYBOARD_TYPE_DEFAULT

Specifies the default keyboard for the current input method.

pyto_ui.KEYBOARD_TYPE_ASCII_CAPABLE

Specifies a keyboard that displays standard ASCII characters.

pyto_ui.KEYBOARD_TYPE_ASCII_CAPABLE_NUMBER_PAD

Specifies a number pad that outputs only ASCII digits.

pyto_ui.KEYBOARD_TYPE_DECIMAL_PAD

Specifies a keyboard with numbers and a decimal point.

pyto_ui.KEYBOARD_TYPE_EMAIL_ADDRESS

Specifies a keyboard optimized for entering email addresses. This keyboard type prominently features the at (“@”), period (“.”) and space characters.

pyto_ui.KEYBOARD_TYPE_NAME_PHONE_PAD

Specifies a keypad designed for entering a person’s name or phone number. This keyboard type does not support auto-capitalization.

pyto_ui.KEYBOARD_TYPE_NUMBER_PAD

Specifies a numeric keypad designed for PIN entry. This keyboard type prominently features the numbers 0 through 9. This keyboard type does not support auto-capitalization.

pyto_ui.KEYBOARD_TYPE_NUMBERS_AND_PUNCTUATION

Specifies the numbers and punctuation keyboard.

pyto_ui.KEYBOARD_TYPE_PHONE_PAD

Specifies a keypad designed for entering telephone numbers. This keyboard type prominently features the numbers 0 through 9 and the “*” and “#” characters. This keyboard type does not support auto-capitalization.

pyto_ui.KEYBOARD_TYPE_TWITTER

Specifies a keyboard optimized for Twitter text entry, with easy access to the at (“@”) and hash (“#”) characters.

pyto_ui.KEYBOARD_TYPE_URL

Specifies a keyboard optimized for URL entry. This keyboard type prominently features the period (“.”) and slash (“/”) characters and the “.com” string.

Specifies a keyboard optimized for web search terms and URL entry. This keyboard type prominently features the space and period (“.”) characters.

Return Key Type

pyto_ui.RETURN_KEY_TYPE_DEFAULT

Specifies that the visible title of the Return key is “return”.

pyto_ui.RETURN_KEY_TYPE_CONTINUE

Specifies that the visible title of the Return key is “Continue”.

pyto_ui.RETURN_KEY_TYPE_DONE

Specifies that the visible title of the Return key is “Done”.

pyto_ui.RETURN_KEY_TYPE_EMERGENCY_CALL

Specifies that the visible title of the Return key is “Emergency Call”.

pyto_ui.RETURN_KEY_TYPE_GO

Specifies that the visible title of the Return key is “Go”.

pyto_ui.RETURN_KEY_TYPE_GOOGLE

Specifies that the visible title of the Return key is “Google”.

pyto_ui.RETURN_KEY_TYPE_JOIN

Specifies that the visible title of the Return key is “Join”.

pyto_ui.RETURN_KEY_TYPE_NEXT

Specifies that the visible title of the Return key is “Next”.

pyto_ui.RETURN_KEY_TYPE_ROUTE

Specifies that the visible title of the Return key is “Route”.

Specifies that the visible title of the Return key is “Search”.

pyto_ui.RETURN_KEY_TYPE_SEND

Specifies that the visible title of the Return key is “Send”.

pyto_ui.RETURN_KEY_TYPE_YAHOO

Specifies that the visible title of the Return key is “Yahoo”.

Auto Capitalization

pyto_ui.AUTO_CAPITALIZE_NONE

Specifies that there is no automatic text capitalization.

pyto_ui.AUTO_CAPITALIZE_ALL

Specifies automatic capitalization of all characters, such as for entry of two-character state abbreviations for the United States.

pyto_ui.AUTO_CAPITALIZE_SENTENCES

Specifies automatic capitalization of the first letter of each sentence.

pyto_ui.AUTO_CAPITALIZE_WORDS

Specifies automatic capitalization of the first letter of each word.

Font Text Style

pyto_ui.FONT_TEXT_STYLE_BODY

The font used for body text.

pyto_ui.FONT_TEXT_STYLE_CALLOUT

The font used for callouts.

pyto_ui.FONT_TEXT_STYLE_CAPTION_1

The font used for standard captions.

pyto_ui.FONT_TEXT_STYLE_CAPTION_2

The font used for alternate captions.

pyto_ui.FONT_TEXT_STYLE_FOOTNOTE

The font used in footnotes.

pyto_ui.FONT_TEXT_STYLE_HEADLINE

The font used for headings.

pyto_ui.FONT_TEXT_STYLE_SUBHEADLINE

The font used for subheadings.

pyto_ui.FONT_TEXT_STYLE_LARGE_TITLE

The font style for large titles.

pyto_ui.FONT_TEXT_STYLE_TITLE_1

The font used for first level hierarchical headings.

pyto_ui.FONT_TEXT_STYLE_TITLE_2

The font used for second level hierarchical headings.

pyto_ui.FONT_TEXT_STYLE_TITLE_3

The font used for third level hierarchical headings.

Font Size

pyto_ui.FONT_LABEL_SIZE

Returns the standard font size used for labels.

pyto_ui.FONT_BUTTON_SIZE

Returns the standard font size used for buttons.

pyto_ui.FONT_SMALL_SYSTEM_SIZE

Returns the size of the standard small system font.

pyto_ui.FONT_SYSTEM_SIZE

Returns the size of the standard system font.

Button Type

pyto_ui.BUTTON_TYPE_SYSTEM

A system style button, such as those shown in navigation bars and toolbars.

pyto_ui.BUTTON_TYPE_CONTACT_ADD

A contact add button.

pyto_ui.BUTTON_TYPE_CUSTOM

No button style.

pyto_ui.BUTTON_TYPE_DETAIL_DISCLOSURE

A detail disclosure button.

pyto_ui.BUTTON_TYPE_INFO_DARK

An information button that has a dark background.

pyto_ui.BUTTON_TYPE_INFO_LIGHT

An information button that has a light background.

Gesture Type

pyto_ui.GESTURE_TYPE_LONG_PRESS

A long press gesture.

pyto_ui.GESTURE_TYPE_PAN

A dragging gesture.

pyto_ui.GESTURE_TYPE_TAP

A tap gesture.

Gesture State

pyto_ui.GESTURE_STATE_POSSIBLE

The gesture recognizer has not yet recognized its gesture, but may be evaluating touch events. This is the default state.

pyto_ui.GESTURE_STATE_BEGAN

The gesture recognizer has received touch objects recognized as a continuous gesture. It sends its action message (or messages) at the next cycle of the run loop.

pyto_ui.GESTURE_STATE_CHANGED

The gesture recognizer has received touches recognized as a change to a continuous gesture. It sends its action message (or messages) at the next cycle of the run loop.

pyto_ui.GESTURE_STATE_ENDED

The gesture recognizer has received touches recognized as the end of a continuous gesture. It sends its action message (or messages) at the next cycle of the run loop and resets its state to possible.

pyto_ui.GESTURE_STATE_CANCELLED

The gesture recognizer has received touches resulting in the cancellation of a continuous gesture. It sends its action message (or messages) at the next cycle of the run loop and resets its state to possible.

pyto_ui.GESTURE_STATE_RECOGNIZED

The gesture recognizer has received a multi-touch sequence that it recognizes as its gesture. It sends its action message (or messages) at the next cycle of the run loop and resets its state to possible.

Touch Type

pyto_ui.TOUCH_TYPE_DIRECT

A touch resulting from direct contact with the screen.

pyto_ui.TOUCH_TYPE_INDIRECT

A touch that did not result from contact with the screen.

pyto_ui.TOUCH_TYPE_PENCIL

A touch from Apple Pencil.

Auto Resizing

pyto_ui.FLEXIBLE_WIDTH

Resizing performed by expanding or shrinking a view’s width.

pyto_ui.FLEXIBLE_HEIGHT

Resizing performed by expanding or shrinking a view’s height.

pyto_ui.FLEXIBLE_TOP_MARGIN

Resizing performed by expanding or shrinking a view in the direction of the top margin.

pyto_ui.FLEXIBLE_BOTTOM_MARGIN

Resizing performed by expanding or shrinking a view in the direction of the bottom margin.

pyto_ui.FLEXIBLE_LEFT_MARGIN

Resizing performed by expanding or shrinking a view in the direction of the left margin.

pyto_ui.FLEXIBLE_RIGHT_MARGIN

Resizing performed by expanding or shrinking a view in the direction of the right margin.

Content Mode

pyto_ui.CONTENT_MODE_SCALE_TO_FILL

The option to scale the content to fit the size of itself by changing the aspect ratio of the content if necessary.

pyto_ui.CONTENT_MODE_SCALE_ASPECT_FIT

The option to scale the content to fit the size of the view by maintaining the aspect ratio. Any remaining area of the view’s bounds is transparent.

pyto_ui.CONTENT_MODE_SCALE_ASPECT_FILL

The option to scale the content to fill the size of the view. Some portion of the content may be clipped to fill the view’s bounds.

pyto_ui.CONTENT_MODE_REDRAW

The option to redisplay the view when the bounds change by invoking the setNeedsDisplay() method.

pyto_ui.CONTENT_MODE_CENTER

The option to center the content in the view’s bounds, keeping the proportions the same.

pyto_ui.CONTENT_MODE_TOP

The option to center the content aligned at the top in the view’s bounds.

pyto_ui.CONTENT_MODE_BOTTOM

The option to center the content aligned at the bottom in the view’s bounds.

pyto_ui.CONTENT_MODE_LEFT

The option to align the content on the left of the view.

pyto_ui.CONTENT_MODE_RIGHT

The option to align the content on the right of the view.

pyto_ui.CONTENT_MODE_TOP_LEFT

The option to align the content in the top-left corner of the view.

pyto_ui.CONTENT_MODE_TOP_RIGHT

The option to align the content in the top-right corner of the view.

pyto_ui.CONTENT_MODE_BOTTOM_LEFT

The option to align the content in the bottom-left corner of the view.

pyto_ui.CONTENT_MODE_BOTTOM_RIGHT

The option to align the content in the bottom-right corner of the view.

Horizontal Alignment

pyto_ui.HORZONTAL_ALIGNMENT_CENTER

Aligns the content horizontally in the center of the control.

pyto_ui.HORZONTAL_ALIGNMENT_FILL

Aligns the content horizontally to fill the content rectangles; text may wrap and images may be stretched.

pyto_ui.HORZONTAL_ALIGNMENT_LEADING

Aligns the content horizontally from the leading edge of the control.

pyto_ui.HORZONTAL_ALIGNMENT_LEFT

Aligns the content horizontally from the left of the control (the default).

pyto_ui.HORZONTAL_ALIGNMENT_RIGHT

Aligns the content horizontally from the right of the control.

pyto_ui.HORZONTAL_ALIGNMENT_TRAILING

Aligns the content horizontally from the trailing edge of the control.

Vertical Alignment

pyto_ui.VERTICAL_ALIGNMENT_BOTTOM

Aligns the content vertically at the bottom in the control.

pyto_ui.VERTICAL_ALIGNMENT_CENTER

Aligns the content vertically in the center of the control.

pyto_ui.VERTICAL_ALIGNMENT_FILL

Aligns the content vertically to fill the content rectangle; images may be stretched.

pyto_ui.VERTICAL_ALIGNMENT_TOP

Aligns the content vertically at the top in the control (the default).

Text Alignment

pyto_ui.TEXT_ALIGNMENT_LEFT

Text is visually left aligned.

pyto_ui.TEXT_ALIGNMENT_RIGHT

Text is visually right aligned.

pyto_ui.TEXT_ALIGNMENT_CENTER

Text is visually center aligned.

pyto_ui.TEXT_ALIGNMENT_JUSTIFIED

Text is justified.

pyto_ui.TEXT_ALIGNMENT_NATURAL

Use the default alignment associated with the current localization of the app. The default alignment for left-to-right scripts is left, and the default alignment for right-to-left scripts is right.

Line Break Mode

pyto_ui.LINE_BREAK_MODE_BY_WORD_WRAPPING

Wrapping occurs at word boundaries, unless the word itself doesn’t fit on a single line.

pyto_ui.LINE_BREAK_MODE_BY_CHAR_WRAPPING

Wrapping occurs before the first character that doesn’t fit.

pyto_ui.LINE_BREAK_MODE_BY_CLIPPING

Lines are simply not drawn past the edge of the text container.

pyto_ui.LINE_BREAK_MODE_BY_TRUNCATING_HEAD

The line is displayed so that the end fits in the container and the missing text at the beginning of the line is indicated by an ellipsis glyph. Although this mode works for multiline text, it is more often used for single line text.

pyto_ui.LINE_BREAK_MODE_BY_TRUNCATING_TAIL

The line is displayed so that the beginning fits in the container and the missing text at the end of the line is indicated by an ellipsis glyph. Although this mode works for multiline text, it is more often used for single line text.

pyto_ui.LINE_BREAK_MODE_BY_TRUNCATING_MIDDLE

The line is displayed so that the beginning and end fit in the container and the missing text in the middle is indicated by an ellipsis glyph. This mode is used for single-line layout; using it with multiline text truncates the text into a single line.

Table View Cell Style

pyto_ui.TABLE_VIEW_CELL_STYLE_DEFAULT

A simple style for a cell with a text label (black and left-aligned) and an optional image view.

pyto_ui.TABLE_VIEW_CELL_STYLE_SUBTITLE

A style for a cell with a left-aligned label across the top and a left-aligned label below it in smaller gray text.

pyto_ui.TABLE_VIEW_CELL_STYLE_VALUE1

A style for a cell with a label on the left side of the cell with left-aligned and black text; on the right side is a label that has smaller blue text and is right-aligned. The Settings application uses cells in this style.

pyto_ui.TABLE_VIEW_CELL_STYLE_VALUE2

A style for a cell with a label on the left side of the cell with text that is right-aligned and blue; on the right side of the cell is another label with smaller text that is left-aligned and black. The Phone/Contacts application uses cells in this style.

Accessory Type

pyto_ui.ACCESSORY_TYPE_NONE

No accessory view.

pyto_ui.ACCESSORY_TYPE_CHECKMARK

A checkmark image.

pyto_ui.ACCESSORY_TYPE_DETAIL_BUTTON

An information button.

pyto_ui.ACCESSORY_TYPE_DETAIL_DISCLOSURE_BUTTON

An information button and a disclosure (chevron) control.

pyto_ui.ACCESSORY_TYPE_DISCLOSURE_INDICATOR

A chevron-shaped control for presenting new content.

Table View Style

pyto_ui.TABLE_VIEW_STYLE_PLAIN

A plain table view.

pyto_ui.TABLE_VIEW_STYLE_GROUPED

A table view whose sections present distinct groups of rows.

Text Field Border Style

pyto_ui.TEXT_FIELD_BORDER_STYLE_NONE

The text field does not display a border.

pyto_ui.TEXT_FIELD_BORDER_STYLE_BEZEL

Displays a bezel-style border for the text field. This style is typically used for standard data-entry fields.

pyto_ui.TEXT_FIELD_BORDER_STYLE_LINE

Displays a thin rectangle around the text field.

pyto_ui.TEXT_FIELD_BORDER_STYLE_ROUNDED_RECT

Displays a rounded-style border for the text field.

Button Item Style

pyto_ui.BUTTON_ITEM_STYLE_PLAIN

Glows when tapped. The default item style.

pyto_ui.BUTTON_ITEM_STYLE_DONE

The style for a done button—for example, a button that completes some task and returns to the previous view.

System Item

pyto_ui.SYSTEM_ITEM_ACTION

The system action button.

pyto_ui.SYSTEM_ITEM_ADD

The system plus button containing an icon of a plus sign.

pyto_ui.SYSTEM_ITEM_BOOKMARKS

The system bookmarks button.

pyto_ui.SYSTEM_ITEM_CAMERA

The system camera button.

pyto_ui.SYSTEM_ITEM_CANCEL

The system Cancel button, localized.

pyto_ui.SYSTEM_ITEM_COMPOSE

The system compose button.

pyto_ui.SYSTEM_ITEM_DONE

The system Done button, localized.

pyto_ui.SYSTEM_ITEM_EDIT

The system Edit button, localized.

pyto_ui.SYSTEM_ITEM_FAST_FORWARD

The system fast forward button.

pyto_ui.SYSTEM_ITEM_FLEXIBLE_SPACE

Blank space to add between other items. The space is distributed equally between the other items. Other item properties are ignored when this value is set.

pyto_ui.SYSTEM_ITEM_ORGANIZE

The system organize button.

pyto_ui.SYSTEM_ITEM_PAUSE

The system pause button.

pyto_ui.SYSTEM_ITEM_PLAY

The system play button.

pyto_ui.SYSTEM_ITEM_REDO

The system redo button.

pyto_ui.SYSTEM_ITEM_REFRESH

The system refresh button.

pyto_ui.SYSTEM_ITEM_REPLY

The system reply button.

pyto_ui.SYSTEM_ITEM_REWIND

The system rewind button.

pyto_ui.SYSTEM_ITEM_SAVE

The system Save button, localized.

The system search button.

pyto_ui.SYSTEM_ITEM_STOP

The system stop button.

pyto_ui.SYSTEM_ITEM_TRASH

The system trash button.

pyto_ui.SYSTEM_ITEM_UNDO

The system undo button.

Presentation Mode

pyto_ui.PRESENTATION_MODE_SHEET

A presentation style that displays the content centered in the screen.

pyto_ui.PRESENTATION_MODE_FULLSCREEN

A presentation style in which the presented view covers the screen.

pyto_ui.PRESENTATION_MODE_WIDGET

A presentation mode style which simulates a Today Widget. Should be used in app to preview how a widget will look.

Appearance

pyto_ui.APPEARANCE_UNSPECIFIED

An unspecified interface style.

pyto_ui.APPEARANCE_LIGHT

The light interface style.

pyto_ui.APPEARANCE_DARK

The dark interface style.