Package net.gini.android.capture.help
See: Description
-
Class Summary Class Description FileImportActivity Screen API and Component API On the File Import Screen users can get information about how import files from other apps via "open with". SupportedFormatsActivity Screen API and Component API The Supported Formats Screen shows information about the document formats supported by the Gini Capture SDK. PhotoTipsActivity Screen API and Component API On the Photo Tips Screen users can get information about how to take better pictures. HelpActivity <h3>Screen API and Component API</h3><p> On the Help Screen users can get information about how to best use the Gini Capture SDK. </p> <p> This Activity can be used for both Screen and Component APIs. </p><h3>Customizing the Help Screen</h3><p> Customizing the look of the Help Screen is done via overriding of app resources. </p> <p> The following items are customizable: <ul> <li> <b>Background color:</b> via the color resource named {@code gc_help_activity_background} </li> <li> <b>Help list item background color:</b> via the color resource name {@code gc_help_item_background} </li> <li> <b>Help list item text style:</b> via overriding the style named {@code GiniCaptureTheme.Help.Item.TextStyle} </li> <li> <b>Help list item labels:</b> via overriding the string resources found in the {@link DefaultHelpItem} enum </li> </ul> </p><p> <b>Important:</b> All overriden styles must have their respective {@code Root.} prefixed style as their parent. Ex.: the parent of {@code GiniCaptureTheme.Onboarding.Message.TextStyle} must be {@code Root.GiniCaptureTheme.Onboarding.Message.TextStyle}. </p><h3>Customizing the Action Bar</h3><p> Customizing the Action Bar is done via overriding of app resources and each one - except the title string resource - is global to all Activities ({@link CameraActivity}, {@link NoResultsActivity}, {@link HelpActivity}, {@link ReviewActivity}, {@link AnalysisActivity}). </p> <p> The following items are customizable: <ul> <li> <b>Background color:</b> via the color resource named {@code gc_action_bar} (highly recommended for Android 5+: customize the status bar color via {@code gc_status_bar}) </li> <li> <b>Title:</b> via the string resource name {@code gc_title_help} </li> <li> <b>Title color:</b> via the color resource named {@code gc_action_bar_title} </li> <li><b>Back button:</b> via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named {@code gc_action_bar_back} </li> </ul> </p> Custom Shows a custom help item with the given title and starts an activity with the given intent when clicked. HelpItem This sealed class declares the items which can be shown in the Help Screen. -
Object Summary Object Description Companion PhotoTips Shows tips for taking better pictures. FileImportGuide Shows a guide for importing files from other apps via "open with". SupportedFormats Shows information about the document formats supported by the Gini Capture SDK.