* @brief An Application class object should be created by every application
* that wishes to use Dali.
*
- * It provides a means for initialising the
+ * It provides a means for initializing the
* resources required by the Dali::Core.
*
* The Application class emits several signals which the user can
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.
+ * @brief Enumeration for deciding whether a Dali application window is opaque or transparent.
* @SINCE_1_0.0
*/
enum WINDOW_MODE
* @PRIVLEVEL_PUBLIC
* @PRIVILEGE_DISPLAY
* @param[in,out] argc A pointer to the number of arguments
- * @param[in,out] argv A pointer the the argument list
+ * @param[in,out] argv A pointer to the argument list
* @return A handle to the Application
*/
static Application New( int* argc, char **argv[] );
/**
- * @brief This is the constructor for applications with a name
+ * @brief This is the constructor for applications with a name.
*
* @SINCE_1_0.0
* @PRIVLEVEL_PUBLIC
* @PRIVILEGE_DISPLAY
* @param[in,out] argc A pointer to the number of arguments
- * @param[in,out] argv A pointer the the argument list
+ * @param[in,out] argv A pointer to the argument list
* @param[in] stylesheet The path to user defined theme file
* @return A handle to the Application
* @note If the stylesheet is not specified, then the library's default stylesheet will not be overridden.
static Application New( int* argc, char **argv[], const std::string& stylesheet );
/**
- * @brief This is the constructor for applications with a name
+ * @brief This is the constructor for applications with a name.
*
* @SINCE_1_0.0
* @PRIVLEVEL_PUBLIC
* @PRIVILEGE_DISPLAY
* @param[in,out] argc A pointer to the number of arguments
- * @param[in,out] argv A pointer the the argument list
+ * @param[in,out] argv A pointer to the argument list
* @param[in] stylesheet The path to user defined theme file
* @param[in] windowMode A member of WINDOW_MODE
* @return A handle to the Application
static Application New( int* argc, char **argv[], const std::string& stylesheet, WINDOW_MODE windowMode );
/**
- * @brief Construct an empty handle
+ * @brief Constructs an empty handle.
* @SINCE_1_0.0
*/
Application();
/**
- * @brief Copy Constructor
+ * @brief Copy Constructor.
* @SINCE_1_0.0
* @param[in] application Handle to an object
*/
Application( const Application& application );
/**
- * @brief Assignment operator
+ * @brief Assignment operator.
* @SINCE_1_0.0
* @param[in] application Handle to an object
* @return A reference to this
Application& operator=( const Application& application );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
void MainLoop(Configuration::ContextLoss configuration);
/**
- * @brief This lowers the application to bottom without actually quitting it
+ * @brief This lowers the application to bottom without actually quitting it.
* @SINCE_1_0.0
*/
void Lower();
/**
* @brief Ensures that the function passed in is called from the main loop when it is idle.
* @SINCE_1_0.0
- * @param[in] callback The function to call.
- * @return true if added successfully, false otherwise
+ * @param[in] callback The function to call
+ * @return @c true if added successfully, @c false otherwise
*
* @note Function must be called from main event thread only
*
Window GetWindow();
/**
- * @brief Replace the current window.
+ * @brief Replaces 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.
+ * it to prevent discard behavior when handling the Init signal.
* @SINCE_1_0.0
* @param[in] windowPosition The position and size parameters of the new window
* @param[in] name The name of the new window
*/
void ReplaceWindow(PositionSize windowPosition, const std::string& name);
+ /**
+ * @brief Get path application resources are stored at
+ *
+ * @SINCE_1_2.2
+ * @return the full path of the resources
+ */
+ static std::string GetResourcePath();
+
+
public: // Stereoscopy
/**
- * @brief Set the viewing mode for the application.
+ * @brief Sets the viewing mode for the application.
* @SINCE_1_0.0
- * @param[in] viewMode The new viewing mode.
+ * @param[in] viewMode The new viewing mode
*/
void SetViewMode( ViewMode viewMode );
/**
- * @brief Get the current viewing mode.
+ * @brief Gets the current viewing mode.
* @SINCE_1_0.0
- * @return The current viewing mode.
+ * @return The current viewing mode
*/
ViewMode GetViewMode() const;
/**
- * @brief Set the stereo base (eye separation) for Stereoscopic 3D
+ * @brief Sets the stereo base (eye separation) for Stereoscopic 3D.
*
* The stereo base is the distance in millimetres between the eyes. Typical values are
* between 50mm and 70mm. The default value is 65mm.
* @SINCE_1_0.0
- * @remarks SetStereoBase() is supported in mobile applications only.
* @param[in] stereoBase The stereo base (eye separation) for Stereoscopic 3D
*/
void SetStereoBase( float stereoBase );
/**
- * @brief Get the stereo base (eye separation) for Stereoscopic 3D
+ * @brief Gets the stereo base (eye separation) for Stereoscopic 3D.
*
* @SINCE_1_0.0
- * @remarks GetStereoBase() is supported in mobile applications only.
* @return The stereo base (eye separation) for Stereoscopic 3D
*/
float GetStereoBase() const;
public: // Signals
/**
- * @brief The user should connect to this signal to determine when they should initialise
+ * @brief The user should connect to this signal to determine when they should initialize
* their application.
* @SINCE_1_0.0
* @return The signal to connect to
/**
* @brief The user should connect to this signal to determine when they should terminate
- * their application
+ * their application.
* @SINCE_1_0.0
* @return The signal to connect to
*/
AppSignalType& ResumeSignal();
/**
- * @brief This signal is sent when the system requires the user to reinitialise itself.
+ * @brief This signal is sent when the system requires the user to reinitialize itself.
* @SINCE_1_0.0
* @return The signal to connect to
*/
AppSignalType& ResetSignal();
/**
- * @brief This signal is emitted when the window the application is rendering on is resized.
+ * @DEPRECATED_1_1.43 Use Window::ResizedSignal() instead.
+ * @brief This signal is emitted when the window application rendering on is resized.
* @SINCE_1_0.0
* @return The signal to connect to
*/
AppSignalType& MemoryLowSignal();
public: // Not intended for application developers
+ /// @cond internal
/**
- * @internal
- * @brief Internal constructor
+ * @brief Internal constructor.
* @SINCE_1_0.0
*/
explicit DALI_INTERNAL Application(Internal::Adaptor::Application* application);
+ /// @endcond
};
/**
projects / platform / core / uifw / dali-adaptor.git / blobdiff