/* * Copyright (c) 2020, SmartDeviceLink Consortium, Inc. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright notice, this * list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following * disclaimer in the documentation and/or other materials provided with the * distribution. * * Neither the name of the SmartDeviceLink Consortium Inc. nor the names of * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ #import "SDLEnum.h" /** * Names of the text fields that can appear on a SDL display. Used in TextFieldName. * * @since SDL 1.0 */ typedef SDLEnum SDLTextFieldName NS_TYPED_ENUM; /** * The first line of the first set of main fields of the persistent display. Applies to SDLShow. */ extern SDLTextFieldName const SDLTextFieldNameMainField1; /** * The second line of the first set of main fields of the persistent display. Applies to SDLShow. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameMainField2; /** * The first line of the second set of main fields of the persistent display. Applies to SDLShow. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameMainField3; /** * The second line of the second set of main fields of the persistent display. Applies to SDLShow. @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameMainField4; /** The title line of the persistent display. Applies to SDLShow. @since SDL 6.0 */ extern SDLTextFieldName const SDLTextFieldNameTemplateTitle; /** * The status bar on the NGN display. Applies to SDLShow. */ extern SDLTextFieldName const SDLTextFieldNameStatusBar; /** * Text value for MediaClock field. Must be properly formatted according to MediaClockFormat. Applies to SDLShow. * * @discussion This field is commonly used to show elapsed or remaining time in an audio track or audio capture. * * @deprecated in SmartDeviceLink 7.1.0 * @added in SmartDeviceLink 1.0.0 */ extern SDLTextFieldName const SDLTextFieldNameMediaClock __deprecated; /** * The track field of NGN type ACMs. This field is only available for media applications on a NGN display. Applies to SDLShow. * * @discussion This field is commonly used to show the current track number */ extern SDLTextFieldName const SDLTextFieldNameMediaTrack; /** * The first line of the alert text field. Applies to SDLAlert. */ extern SDLTextFieldName const SDLTextFieldNameAlertText1; /** * The second line of the alert text field. Applies to SDLAlert. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameAlertText2; /** * The third line of the alert text field. Applies to SDLAlert. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameAlertText3; /** * Long form body of text that can include newlines and tabs. Applies to SDLScrollableMessage. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameScrollableMessageBody; /** * First line suggestion for a user response (in the case of VR enabled interaction). * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameInitialInteractionText; /** * First line of navigation text. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameNavigationText1; /** * Second line of navigation text. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameNavigationText2; /** * Estimated Time of Arrival time for navigation. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameETA; /** * Total distance to destination for navigation. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameTotalDistance; /** * First line of text for audio pass thru. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameAudioPassThruDisplayText1; /** * Second line of text for audio pass thru. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameAudioPassThruDisplayText2; /** * Header text for slider. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameSliderHeader; /** * Footer text for slider * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameSliderFooter; /** * Primary text for SDLChoice */ extern SDLTextFieldName const SDLTextFieldNameMenuName; /** * Secondary text for SDLChoice */ extern SDLTextFieldName const SDLTextFieldNameSecondaryText; /** * Tertiary text for SDLChoice */ extern SDLTextFieldName const SDLTextFieldNameTertiaryText; /** * Optional text to label an app menu button (for certain touchscreen platforms) */ extern SDLTextFieldName const SDLTextFieldNameMenuTitle; /** * Optional name / title of intended location for SDLSendLocation * * @since SDL 4.0 */ extern SDLTextFieldName const SDLTextFieldNameLocationName; /** * Optional description of intended location / establishment (if applicable) for SDLSendLocation * * @since SDL 4.0 */ extern SDLTextFieldName const SDLTextFieldNameLocationDescription; /** * Optional location address (if applicable) for SDLSendLocation * * @since SDL 4.0 */ extern SDLTextFieldName const SDLTextFieldNameAddressLines; /** * Optional hone number of intended location / establishment (if applicable) for SDLSendLocation * * @since SDL 4.0 */ extern SDLTextFieldName const SDLTextFieldNamePhoneNumber; /** * Optional time to destination field for ShowConstantTBT * * @added in SmartDeviceLink 7.1.0 */ extern SDLTextFieldName const SDLTextFieldNameTimeToDestination; /** * Turn text for turnList parameter of UpdateTurnList * * @added in SmartDeviceLink 7.1.0 */ extern SDLTextFieldName const SDLTextFieldNameTurnText; /** * The first line of the subtle alert text field; applies to `SubtleAlert` `alertText1` * * @since SDL 7.0.0 */ extern SDLTextFieldName const SDLTextFieldNameSubtleAlertText1; /** * The second line of the subtle alert text field; applies to `SubtleAlert` `alertText2` * * @since SDL 7.0.0 */ extern SDLTextFieldName const SDLTextFieldNameSubtleAlertText2; /** * A text field in the soft button of a subtle alert; applies to `SubtleAlert` `softButtons` * * @since SDL 7.0.0 */ extern SDLTextFieldName const SDLTextFieldNameSubtleAlertSoftButtonText; /** * Secondary text for AddCommand * * @added in SmartDeviceLink 7.0.0 */ extern SDLTextFieldName const SDLTextFieldNameMenuCommandSecondaryText; /** * Tertiary text for AddCommand * * @added in SmartDeviceLink 7.0.0 */ extern SDLTextFieldName const SDLTextFieldNameMenuCommandTertiaryText; /** * Secondary text for AddSubMenu * * @added in SmartDeviceLink 7.0.0 */ extern SDLTextFieldName const SDLTextFieldNameMenuSubMenuSecondaryText; /** * Tertiary text for AddSubMenu * * @added in SmartDeviceLink 7.0.0 */ extern SDLTextFieldName const SDLTextFieldNameMenuSubMenuTertiaryText;