* @{
*/
+/**
+ * @brief Application configuration enumerations
+ * @SINCE_1_0.0
+ */
namespace Configuration
{
+
+/**
+ * @brief Enumeration about application context loss policy
+ * @SINCE_1_0.0
+ */
enum ContextLoss
{
APPLICATION_HANDLES_CONTEXT_LOSS, ///< Application will tear down and recreate UI on context loss and context regained signals. Dali doesn't need to retain data. @SINCE_1_0.0
}
/**
* @brief An Application class object should be created by every application
- * that wishes to use Dali. It provides a means for initialising the
+ * that wishes to use Dali.
+ *
+ * It provides a means for initialising the
* resources required by the Dali::Core.
*
* The Application class emits several signals which the user can
* Applications should follow the example below:
*
* @code
- * void CreateProgram(Application app)
+ * class ExampleController: public ConnectionTracker
* {
- * // Create Dali components...
- * // Can instantiate here, if required
- * }
+ * public:
+ * ExampleController( Application& application )
+ * : mApplication( application )
+ * {
+ * mApplication.InitSignal().Connect( this, &ExampleController::Create );
+ * }
+ *
+ * void Create( Application& application )
+ * {
+ * // Create Dali components...
+ * }
+ * ...
+ * private:
+ * Application& mApplication;
+ * };
*
* int main (int argc, char **argv)
* {
* Application app = Application::New(&argc, &argv);
- * app.InitSignal().Connect(&CreateProgram);
+ * ExampleController example( app );
* app.MainLoop();
* }
* @endcode
{
public:
- typedef Signal< void (Application&) > AppSignalType;
- typedef Signal< void (Application&, void *) > AppControlSignalType;
+ typedef Signal< void (Application&) > AppSignalType; ///< Application lifecycle signal and system signal callback type @SINCE_1_0.0
+ typedef Signal< void (Application&, void *) > AppControlSignalType; ///< Application control signal callback type @SINCE_1_0.0
/**
* @brief Decides whether a Dali application window is opaque or transparent.
public:
/**
- * @brief This starts the application. Choosing this form of main loop indicates that the default
+ * @brief This starts the application.
+ *
+ * Choosing this form of main loop indicates that the default
* application configuration of APPLICATION_HANDLES_CONTEXT_LOSS is used. On platforms where
* context loss can occur, the application is responsible for tearing down and re-loading UI.
* The application should listen to Stage::ContextLostSignal and Stage::ContextRegainedSignal.
/**
* @brief This starts the application, and allows the app to choose a different configuration.
+ *
* If the application plans on using the ReplaceSurface or ReplaceWindow API, then this will
* trigger context loss & regain.
* The application should listen to Stage::ContextLostSignal and Stage::ContextRegainedSignal.
/**
* @brief Retrieves the window used by the Application class.
+ *
* The application writer can use the window to change indicator and orientation
* properties.
* @SINCE_1_0.0
/**
* @brief Replace the current window.
+ *
* This will force context loss.
* If you plan on using this API in your application, then you should configure
* it to prevent discard behaviour when handling the Init signal.
/**
* @brief This signal is emitted when another application sends a launch request to the application.
+ *
* When the application is launched, this signal is emitted after the main loop of the application starts up.
* The passed parameter describes the launch request and contains the information about why the application is launched.
* @SINCE_1_0.0
* @{
*/
+/**
+ * @brief Enumerations for input method
+ * @SINCE_1_0.0
+ */
namespace InputMethod
{
/**
*
* The 'Action' button is traditionally the [RETURN] or [DONE] button.
*
- * Not all these actions are supported by all systems
+ * Not all these actions are supported by all systems.
*
* Setting a custom label will still require one of these actions to be set.
* @SINCE_1_0.0
*/
enum ActionButton
{
- ACTION_DEFAULT,
- ACTION_DONE,
- ACTION_GO,
- ACTION_JOIN,
- ACTION_LOGIN,
- ACTION_NEXT,
- ACTION_PREVIOUS,
- ACTION_SEARCH,
- ACTION_SEND,
- ACTION_SIGNIN,
- ACTION_UNSPECIFIED,
- ACTION_NONE
+ ACTION_DEFAULT, ///< Default action @SINCE_1_0.0
+ ACTION_DONE, ///< Done @SINCE_1_0.0
+ ACTION_GO, ///< Go action @SINCE_1_0.0
+ ACTION_JOIN, ///< Join action @SINCE_1_0.0
+ ACTION_LOGIN, ///< Login action @SINCE_1_0.0
+ ACTION_NEXT, ///< Next action @SINCE_1_0.0
+ ACTION_PREVIOUS, ///< Previous action @SINCE_1_0.0
+ ACTION_SEARCH, ///< Search action @SINCE_1_0.0
+ ACTION_SEND, ///< Send action @SINCE_1_0.0
+ ACTION_SIGNIN, ///< Sign in action @SINCE_1_0.0
+ ACTION_UNSPECIFIED, ///< Unspecified action @SINCE_1_0.0
+ ACTION_NONE ///< Nothing to do @SINCE_1_0.0
};
/**
* @brief Settings that can be changed in the system Input Method
*
- * Not all these settings are supported by all systems
+ * Not all these settings are supported by all systems.
* @SINCE_1_0.0
*/
enum Settings
{
- ACTION_BUTTON, // ActionButton // Apply the one of the ActionButton functions to the action button (return button)
- AUTO_CAPITALISE, // boolean // Capitalise first letter of each sentence automatically
- AUTO_COMPLETE, // boolean // Suggest words based on the current input
- AUTO_CORRECT // boolean // Automatically correct commonly misspelt words
+ ACTION_BUTTON, ///< ActionButton. Apply the one of the ActionButton functions to the action button (return button). @SINCE_1_0.0
+ AUTO_CAPITALISE, ///< boolean. Capitalise the first letter of each sentence automatically. @SINCE_1_0.0
+ AUTO_COMPLETE, ///< boolean. Suggest words based on the current input. @SINCE_1_0.0
+ AUTO_CORRECT ///< boolean. Automatically correct commonly misspelt words. @SINCE_1_0.0
};
} // namespace InputMethod
enum KEY
{
- DALI_KEY_INVALID = -1,
- DALI_KEY_ESCAPE = 9,
- DALI_KEY_BACKSPACE = 22,
- DALI_KEY_SHIFT_LEFT = 50,
- DALI_KEY_SHIFT_RIGHT = 62,
- DALI_KEY_CURSOR_UP = 111,
- DALI_KEY_CURSOR_LEFT = 113,
- DALI_KEY_CURSOR_RIGHT = 114,
- DALI_KEY_CURSOR_DOWN = 116,
- DALI_KEY_BACK = 166,
- DALI_KEY_CAMERA = 167,
- DALI_KEY_CONFIG = 168,
- DALI_KEY_POWER = 169,
- DALI_KEY_PAUSE = 170,
- DALI_KEY_CANCEL = 171,
- DALI_KEY_PLAY_CD = 172,
- DALI_KEY_STOP_CD = 173,
- DALI_KEY_PAUSE_CD = 174,
- DALI_KEY_NEXT_SONG = 175,
- DALI_KEY_PREVIOUS_SONG = 176,
- DALI_KEY_REWIND = 177,
- DALI_KEY_FASTFORWARD = 178,
- DALI_KEY_MEDIA = 179,
- DALI_KEY_PLAY_PAUSE = 180,
- DALI_KEY_MUTE = 181,
- DALI_KEY_MENU = 182,
- DALI_KEY_HOME = 183,
- DALI_KEY_HOMEPAGE = 187,
- DALI_KEY_WEBPAGE = 188,
- DALI_KEY_MAIL = 189,
- DALI_KEY_SCREENSAVER = 190,
- DALI_KEY_BRIGHTNESS_UP = 191,
- DALI_KEY_BRIGHTNESS_DOWN = 192,
- DALI_KEY_SOFT_KBD = 193,
- DALI_KEY_QUICK_PANEL = 194,
- DALI_KEY_TASK_SWITCH = 195,
- DALI_KEY_APPS = 196,
- DALI_KEY_SEARCH = 197,
- DALI_KEY_VOICE = 198,
- DALI_KEY_LANGUAGE = 199,
- DALI_KEY_VOLUME_UP = 200,
- DALI_KEY_VOLUME_DOWN = 201
+ DALI_KEY_INVALID = -1, ///< Invalid key value @SINCE_1_0.0
+ DALI_KEY_ESCAPE = 9, ///< Escape key @SINCE_1_0.0
+ DALI_KEY_BACKSPACE = 22, ///< Backspace key @SINCE_1_0.0
+ DALI_KEY_SHIFT_LEFT = 50, ///< Shift Left key @SINCE_1_0.0
+ DALI_KEY_SHIFT_RIGHT = 62, ///< Shift Right key @SINCE_1_0.0
+ DALI_KEY_CURSOR_UP = 111, ///< Cursor up key @SINCE_1_0.0
+ DALI_KEY_CURSOR_LEFT = 113, ///< Cursor left key @SINCE_1_0.0
+ DALI_KEY_CURSOR_RIGHT = 114, ///< Cursor right key @SINCE_1_0.0
+ DALI_KEY_CURSOR_DOWN = 116, ///< Cursor down key @SINCE_1_0.0
+ DALI_KEY_BACK = 166, ///< Back key @SINCE_1_0.0
+ DALI_KEY_CAMERA = 167, ///< Camera key @SINCE_1_0.0
+ DALI_KEY_CONFIG = 168, ///< Config key @SINCE_1_0.0
+ DALI_KEY_POWER = 169, ///< Power key @SINCE_1_0.0
+ DALI_KEY_PAUSE = 170, ///< Pause key @SINCE_1_0.0
+ DALI_KEY_CANCEL = 171, ///< Cancel key @SINCE_1_0.0
+ DALI_KEY_PLAY_CD = 172, ///< Play CD key @SINCE_1_0.0
+ DALI_KEY_STOP_CD = 173, ///< Stop CD key @SINCE_1_0.0
+ DALI_KEY_PAUSE_CD = 174, ///< Pause CD key @SINCE_1_0.0
+ DALI_KEY_NEXT_SONG = 175, ///< Next song key @SINCE_1_0.0
+ DALI_KEY_PREVIOUS_SONG = 176, ///< Previous song key @SINCE_1_0.0
+ DALI_KEY_REWIND = 177, ///< Rewind key @SINCE_1_0.0
+ DALI_KEY_FASTFORWARD = 178, ///< Fastforward key @SINCE_1_0.0
+ DALI_KEY_MEDIA = 179, ///< Media key @SINCE_1_0.0
+ DALI_KEY_PLAY_PAUSE = 180, ///< Play pause key @SINCE_1_0.0
+ DALI_KEY_MUTE = 181, ///< Mute key @SINCE_1_0.0
+ DALI_KEY_MENU = 182, ///< Menu key @SINCE_1_0.0
+ DALI_KEY_HOME = 183, ///< Home key @SINCE_1_0.0
+ DALI_KEY_HOMEPAGE = 187, ///< Homepage key @SINCE_1_0.0
+ DALI_KEY_WEBPAGE = 188, ///< Webpage key @SINCE_1_0.0
+ DALI_KEY_MAIL = 189, ///< Mail key @SINCE_1_0.0
+ DALI_KEY_SCREENSAVER = 190, ///< Screensaver key @SINCE_1_0.0
+ DALI_KEY_BRIGHTNESS_UP = 191, ///< Brightness up key @SINCE_1_0.0
+ DALI_KEY_BRIGHTNESS_DOWN = 192, ///< Brightness down key @SINCE_1_0.0
+ DALI_KEY_SOFT_KBD = 193, ///< Soft KBD key @SINCE_1_0.0
+ DALI_KEY_QUICK_PANEL = 194, ///< Quick panel key @SINCE_1_0.0
+ DALI_KEY_TASK_SWITCH = 195, ///< Task switch key @SINCE_1_0.0
+ DALI_KEY_APPS = 196, ///< Apps key @SINCE_1_0.0
+ DALI_KEY_SEARCH = 197, ///< Search key @SINCE_1_0.0
+ DALI_KEY_VOICE = 198, ///< Voice key @SINCE_1_0.0
+ DALI_KEY_LANGUAGE = 199, ///< Language key @SINCE_1_0.0
+ DALI_KEY_VOLUME_UP = 200, ///< Volume up key @SINCE_1_0.0
+ DALI_KEY_VOLUME_DOWN = 201 ///< Volume down key @SINCE_1_0.0
};
/**
* @param daliKey dali key enum
* @return true if the key is matched, false if not
*/
-DALI_IMPORT_API bool IsKey( const KeyEvent& keyEvent, KEY daliKey);
+DALI_IMPORT_API bool IsKey( const Dali::KeyEvent& keyEvent, Dali::KEY daliKey);
/**
* @}
* @brief Pointer to Dali::NativeImageSource.
* @SINCE_1_0.0
*/
-typedef IntrusivePtr<NativeImageSource> NativeImageSourcePtr;
+typedef Dali::IntrusivePtr<Dali::NativeImageSource> NativeImageSourcePtr;
/**
* @brief Used for displaying native images.
* (COLOR_DEPTH_24 and COLOR_DEPTH_32).
* @SINCE_1_0.0
* @param[out] pixbuf a vector to store the pixels in
- * @param[out] width width of image
- * @param[out] height height of image
+ * @param[out] width The width of image
+ * @param[out] height The height of image
* @param[out] pixelFormat pixel format used by image
* @return True if the pixels were gotten, and false otherwise.
*/
* @{
*/
+/**
+ * @brief Style change information.
+ * @SINCE_1_0.0
+ */
namespace StyleChange
{
~Timer();
/**
- * @brief Downcast an Object handle to Timer handle.
+ * @brief Downcast a handle to Timer handle.
*
* If handle points to a Timer object the downcast produces a valid
* handle. If not the returned handle is left uninitialized.
/**
* @brief Get the interval of timer.
+ *
* @returns Interval in milliseconds.
* @SINCE_1_0.0
*/
* @brief Signal emitted after specified time interval.
*
* The return of the callback decides whether signal emission stops or continues.
- * If the callback function returns false emission will stop, if true it will continue
+ * If the callback function returns false, emission will stop and if true, it will continue.
* This return value is ignored for one-shot events, which will always stop after the first execution.
* @returns The signal to Connect() with.
* @SINCE_1_0.0
}
/**
- * @brief The Text-to-speech Player.
+ * @brief The Text-to-speech (TTS) Player.
* @SINCE_1_0.0
*/
class DALI_IMPORT_API TtsPlayer : public BaseHandle
/**
* @brief Allows connection TTS state change signal.
- * Note: Only supported by some adaptor types.
* @SINCE_1_0.0
* @return A reference to the signal for connection.
+ * @note Only supported by some adaptor types.
*/
Dali::TtsPlayer::StateChangedSignalType& StateChangedSignal();
/**
* @brief The window class is used internally for drawing.
*
- * It has an orientation
- * and indicator properties.
+ * A Window has an orientation and indicator properties.
+ * You can get a valid Window handle by calling Dali::Application::GetWindow().
* @SINCE_1_0.0
*/
class DALI_IMPORT_API Window : public BaseHandle
*/
enum WindowOrientation
{
- PORTRAIT = 0,
- LANDSCAPE = 90,
- PORTRAIT_INVERSE = 180,
- LANDSCAPE_INVERSE = 270
+ PORTRAIT = 0, ///< Portrait orientation @SINCE_1_0.0
+ LANDSCAPE = 90, ///< Landscape orientation @SINCE_1_0.0
+ PORTRAIT_INVERSE = 180, ///< Portrait inverse orientation @SINCE_1_0.0
+ LANDSCAPE_INVERSE = 270 ///< Landscape inverse orientation @SINCE_1_0.0
};
/**
*/
enum IndicatorBgOpacity
{
- OPAQUE = 100, // Fully opaque indicator Bg
- TRANSLUCENT = 50, // Semi translucent indicator Bg
- TRANSPARENT = 0 // Fully transparent indicator Bg
+ OPAQUE = 100, ///< Fully opaque indicator Bg @SINCE_1_0.0
+ TRANSLUCENT = 50, ///< Semi translucent indicator Bg @SINCE_1_0.0
+ TRANSPARENT = 0 ///< Fully transparent indicator Bg @SINCE_1_0.0
};
/**
*/
enum IndicatorVisibleMode
{
- INVISIBLE = 0, // hide indicator
- VISIBLE = 1, // show indicator
- AUTO = 2 // hide in default, will show when necessary
+ INVISIBLE = 0, ///< Hide indicator @SINCE_1_0.0
+ VISIBLE = 1, ///< Show indicator @SINCE_1_0.0
+ AUTO = 2 ///< Hide in default, will show when necessary @SINCE_1_0.0
};
// Methods
/**
* @brief This sets whether the indicator bar should be shown or not.
* @SINCE_1_0.0
- * @param[in] visibleMode visible mode for indicator bar, VISIBLE in default
+ * @param[in] visibleMode Visible mode for indicator bar, VISIBLE in default
*/
void ShowIndicator( IndicatorVisibleMode visibleMode );
/**
* @brief This sets the opacity mode of indicator bar.
* @SINCE_1_0.0
- * @param[in] opacity - The opacity mode
+ * @param[in] opacity The opacity mode
*/
void SetIndicatorBgOpacity( IndicatorBgOpacity opacity );
projects / platform / core / uifw / dali-adaptor.git / commitdiff