- Change @since 1.1.x to @SINCE_1_1.x to follow the new doxygen tagging rule.
- Add @SINCE_1_0.0 for all symbols not having @since tag.
- Sort the order of doxygen tags as guided by the Tizen guideline.
('platform','deprecated','brief','details','since_tizen','privlevel',
'privilege', 'remarks','param','return','retval','exception','pre','post',
'note','see')
Change-Id: I99ce2a063f1d28130bc7951de212c47b5af06509
{
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.
- APPLICATION_DOES_NOT_HANDLE_CONTEXT_LOSS, ///< Application expects Dali to retain data ( increased memory footprint )
+ 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
+ APPLICATION_DOES_NOT_HANDLE_CONTEXT_LOSS, ///< Application expects Dali to retain data ( increased memory footprint ) @SINCE_1_0.0
};
} // Configuration
}
}
/**
- * An Application class object should be created by every application
+ * @brief An Application class object should be created by every application
* that wishes to use Dali. It provides a means for initialising the
* resources required by the Dali::Core.
*
* @endcode
*
* When the above options are found, they are stripped from argv, and argc is updated appropriately.
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API Application : public BaseHandle
{
typedef Signal< void (Application&, void *) > AppControlSignalType;
/**
- * Decides whether a Dali application window is opaque or transparent.
+ * @brief Decides whether a Dali application window is opaque or transparent.
+ * @SINCE_1_0.0
*/
enum WINDOW_MODE
{
- OPAQUE = 0, ///< The window will be opaque
- TRANSPARENT = 1 ///< The window transparency will match the alpha value set in Dali::Stage::SetBackgroundcolor()
+ OPAQUE = 0, ///< The window will be opaque @SINCE_1_0.0
+ TRANSPARENT = 1 ///< The window transparency will match the alpha value set in Dali::Stage::SetBackgroundcolor() @SINCE_1_0.0
};
public:
/**
- * This is the constructor for applications without an argument list.
+ * @brief This is the constructor for applications without an argument list.
+ * @SINCE_1_0.0
*/
static Application New();
/**
- * This is the constructor for applications.
+ * @brief This is the constructor for applications.
*
+ * @SINCE_1_0.0
* @param[in,out] argc A pointer to the number of arguments
* @param[in,out] argv A pointer the the argument list
*/
static Application New( int* argc, char **argv[] );
/**
- * This is the constructor for applications with a name
+ * @brief This is the constructor for applications with a name
*
+ * @SINCE_1_0.0
* @param[in,out] argc A pointer to the number of arguments
* @param[in,out] argv A pointer the the argument list
* @param[in] stylesheet The path to user defined theme file
static Application New( int* argc, char **argv[], const std::string& stylesheet );
/**
- * This is the constructor for applications with a name
+ * @brief This is the constructor for applications with a name
*
+ * @SINCE_1_0.0
* @param[in,out] argc A pointer to the number of arguments
* @param[in,out] argv A pointer the the argument list
* @param[in] stylesheet The path to user defined theme file
static Application New( int* argc, char **argv[], const std::string& stylesheet, WINDOW_MODE windowMode );
/**
- * Construct an empty handle
+ * @brief Construct an empty handle
+ * @SINCE_1_0.0
*/
Application();
/**
- * Copy Constructor
+ * @brief Copy Constructor
+ * @SINCE_1_0.0
*/
Application( const Application& application );
/**
- * Assignment operator
+ * @brief Assignment operator
+ * @SINCE_1_0.0
*/
Application& operator=( const Application& applicaton );
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~Application();
public:
/**
- * 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.
+ * @SINCE_1_0.0
*/
void MainLoop();
/**
- * This starts the application, and allows the app to choose a different configuration.
+ * @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.
+ * @SINCE_1_0.0
*/
void MainLoop(Configuration::ContextLoss configuration);
/**
- * 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();
/**
- * This quits the application. Tizen applications should use Lower to improve re-start performance unless they need to Quit completely.
+ * @brief This quits the application. Tizen applications should use Lower to improve re-start performance unless they need to Quit completely.
+ * @SINCE_1_0.0
*/
void Quit();
/**
- * Ensures that the function passed in is called from the main loop when it is idle.
+ * @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
+ *
* @note Function must be called from main event thread only
*
* A callback of the following type may be used:
* void MyFunction();
* @endcode
*
- * @param[in] callback The function to call.
- * @return true if added successfully, false otherwise
- *
* @note Ownership of the callback is passed onto this class.
*/
bool AddIdle( CallbackBase* callback );
/**
- * Retrieves the window used by the Application class.
+ * @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
* @return A handle to the window
*/
Window GetWindow();
/**
- * Replace the current window.
+ * @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.
+ * @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
*/
public: // Stereoscopy
/**
- * Set the viewing mode for the application.
+ * @brief Set the viewing mode for the application.
+ * @SINCE_1_0.0
* @param[in] viewMode The new viewing mode.
*/
void SetViewMode( ViewMode viewMode );
/**
- * Get the current viewing mode.
+ * @brief Get the current viewing mode.
+ * @SINCE_1_0.0
* @return The current viewing mode.
*/
ViewMode GetViewMode() const;
/**
- * Set the stereo base (eye separation) for Stereoscopic 3D
+ * @brief Set the stereo base (eye separation) for Stereoscopic 3D
*
+ * @SINCE_1_0.0
* @param[in] stereoBase The stereo base (eye separation) for Stereoscopic 3D
*/
void SetStereoBase( float stereoBase );
/**
- * Get the stereo base (eye separation) for Stereoscopic 3D
+ * @brief Get the stereo base (eye separation) for Stereoscopic 3D
*
+ * @SINCE_1_0.0
* @return The stereo base (eye separation) for Stereoscopic 3D
*/
float GetStereoBase() const;
public: // Signals
/**
- * 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 initialise
* their application.
+ * @SINCE_1_0.0
*/
AppSignalType& InitSignal();
/**
- * The user should connect to this signal to determine when they should terminate
+ * @brief The user should connect to this signal to determine when they should terminate
* their application
+ * @SINCE_1_0.0
*/
AppSignalType& TerminateSignal();
/**
- * The user should connect to this signal if they need to perform any special
+ * @brief The user should connect to this signal if they need to perform any special
* activities when the application is about to be paused.
+ * @SINCE_1_0.0
*/
AppSignalType& PauseSignal();
/**
- * The user should connect to this signal if they need to perform any special
+ * @brief The user should connect to this signal if they need to perform any special
* activities when the application has resumed.
+ * @SINCE_1_0.0
*/
AppSignalType& ResumeSignal();
/**
- * 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 reinitialise itself.
+ * @SINCE_1_0.0
*/
AppSignalType& ResetSignal();
/**
- * This signal is emitted when the window the application is rendering on is resized.
+ * @brief This signal is emitted when the window the application is rendering on is resized.
+ * @SINCE_1_0.0
*/
AppSignalType& ResizeSignal();
/**
- * This signal is emitted when another application sends a launch request to the application.
+ * @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
*/
AppControlSignalType& AppControlSignal();
/**
- * This signal is emitted when the language is changed on the device.
+ * @brief This signal is emitted when the language is changed on the device.
+ * @SINCE_1_0.0
*/
AppSignalType& LanguageChangedSignal();
/**
- * This signal is emitted when the region of the device is changed.
+ * @brief This signal is emitted when the region of the device is changed.
+ * @SINCE_1_0.0
*/
AppSignalType& RegionChangedSignal();
/**
- * This signal is emitted when the battery level of the device is low.
+ * @brief This signal is emitted when the battery level of the device is low.
+ * @SINCE_1_0.0
*/
AppSignalType& BatteryLowSignal();
/**
- * This signal is emitted when the memory level of the device is low.
+ * @brief This signal is emitted when the memory level of the device is low.
+ * @SINCE_1_0.0
*/
AppSignalType& MemoryLowSignal();
public: // Not intended for application developers
/**
- * Internal constructor
+ * @brief Internal constructor
+ * @SINCE_1_0.0
*/
explicit DALI_INTERNAL Application(Internal::Adaptor::Application* application);
};
* 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
{
* @brief Settings that can be changed in the system Input Method
*
* Not all these settings are supported by all systems
+ * @SINCE_1_0.0
*/
enum Settings
{
/**
* @brief Mapping of keyboard and mouse button event keycodes to platform specific codes.
+ * @SINCE_1_0.0
*/
enum KEY
/**
* @brief Check if a key event is for a specific DALI KEY.
*
+ * @SINCE_1_0.0
* @param keyEvent reference to a keyEvent structure
* @param daliKey dali key enum
* @return true if the key is matched, false if not
class NativeImageSource;
/**
* @brief Pointer to Dali::NativeImageSource.
+ * @SINCE_1_0.0
*/
typedef IntrusivePtr<NativeImageSource> NativeImageSourcePtr;
* The native image source can be created internally or
* externally by X11 or ECORE-X11.
*
- * @since DALi 1.1.4
+ * @SINCE_1_1.4
*/
class DALI_IMPORT_API NativeImageSource : public NativeImageInterface
{
/**
* @brief When creating a native image the color depth has to be specified.
+ * @SINCE_1_0.0
*/
enum ColorDepth
{
- COLOR_DEPTH_DEFAULT, ///< Uses the current X screen default depth (recommended)
- COLOR_DEPTH_8, ///< 8 bits per pixel
- COLOR_DEPTH_16, ///< 16 bits per pixel
- COLOR_DEPTH_24, ///< 24 bits per pixel
- COLOR_DEPTH_32 ///< 32 bits per pixel
+ COLOR_DEPTH_DEFAULT, ///< Uses the current X screen default depth (recommended) @SINCE_1_0.0
+ COLOR_DEPTH_8, ///< 8 bits per pixel @SINCE_1_0.0
+ COLOR_DEPTH_16, ///< 16 bits per pixel @SINCE_1_0.0
+ COLOR_DEPTH_24, ///< 24 bits per pixel @SINCE_1_0.0
+ COLOR_DEPTH_32 ///< 32 bits per pixel @SINCE_1_0.0
};
/**
* @brief Create a new NativeImageSource.
*
* Depending on hardware the width and height may have to be a power of two.
+ * @SINCE_1_0.0
* @param[in] width The width of the image.
* @param[in] height The height of the image.
* @param[in] depth color depth of the image.
/**
* @brief Create a new NativeImageSource from an existing native image.
*
+ * @SINCE_1_0.0
* @param[in] nativeImageSource must be a X11 pixmap or a Ecore_X_Pixmap
* @return A smart-pointer to a newly allocated image.
*/
/**
* @brief Retrieve the internal native image.
*
+ * @SINCE_1_0.0
* @return Any object containing the internal native image.
*/
Any GetNativeImageSource();
*
* This is only supported for 24 bit RGB and 32 bit RGBA internal formats
* (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
* @brief Convert the current pixel contents to either a JPEG or PNG format
* and write that to the filesytem.
*
+ * @SINCE_1_0.0
* @param[in] filename Identify the filesytem location at which to write the
* encoded image. The extension determines the encoding used.
* The two valid encoding are (".jpeg"|".jpg") and ".png".
/**
* @brief Private constructor
+ * @SINCE_1_0.0
* @param[in] width The width of the image.
* @param[in] height The height of the image.
* @param[in] depth color depth of the image.
* @brief A reference counted object may only be deleted by calling Unreference().
*
* The implementation should destroy the NativeImage resources.
+ * @SINCE_1_0.0
*/
DALI_INTERNAL virtual ~NativeImageSource();
* @brief Undefined copy constructor
*
* This avoids accidental calls to a default copy constructor.
+ * @SINCE_1_0.0
* @param[in] nativeImageSource A reference to the object to copy.
*/
DALI_INTERNAL NativeImageSource( const NativeImageSource& nativeImageSource );
* @brief Undefined assignment operator.
*
* This avoids accidental calls to a default assignment operator.
+ * @SINCE_1_0.0
* @param[in] rhs A reference to the object to copy.
*/
DALI_INTERNAL NativeImageSource& operator=(const NativeImageSource& rhs);
enum Type
{
- DEFAULT_FONT_CHANGE, ///< Denotes that the default font has changed.
- DEFAULT_FONT_SIZE_CHANGE, ///< Denotes that the default font size has changed.
- THEME_CHANGE ///< Denotes that the theme has changed.
+ DEFAULT_FONT_CHANGE, ///< Denotes that the default font has changed. @SINCE_1_0.0
+ DEFAULT_FONT_SIZE_CHANGE, ///< Denotes that the default font size has changed. @SINCE_1_0.0
+ THEME_CHANGE ///< Denotes that the theme has changed. @SINCE_1_0.0
};
} // namespace StyleChange
*
* This class is a handle class so it can be stack allocated and used
* as a member.
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API Timer : public BaseHandle
{
public: // Signal typedefs
- typedef Signal< bool () > TimerSignalType; ///< Timer finished signal callback type
+ typedef Signal< bool () > TimerSignalType; ///< Timer finished signal callback type @SINCE_1_0.0
public: // API
* @brief Constructor, creates an uninitialized timer.
*
* Call New to fully construct a timer.
+ * @SINCE_1_0.0
*/
Timer();
/**
* @brief Create an tick Timer that emits periodic signal.
*
+ * @SINCE_1_0.0
* @param[in] milliSec Interval in milliseconds.
* @return a new timer
*/
/**
* @brief Copy constructor.
*
+ * @SINCE_1_0.0
* @param[in] timer The handle to copy. The copied handle will point at the same implementation
*/
Timer( const Timer& timer );
/**
* @brief Assignment operator.
*
+ * @SINCE_1_0.0
* @param[in] timer The handle to copy. This handle will point at the same implementation
* as the copied handle.
* @return Reference to this timer handle
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~Timer();
* If handle points to a Timer object the downcast produces a valid
* handle. If not the returned handle is left uninitialized.
*
+ * @SINCE_1_0.0
* @param[in] handle to An object
* @return handle to a Timer object or an uninitialized handle
*/
* @brief Start timer.
*
* In case a Timer is already running it's time is reset and timer is restarted.
+ * @SINCE_1_0.0
*/
void Start();
/**
* @brief Stop timer.
+ * @SINCE_1_0.0
*/
void Stop();
* @brief Sets a new interval on the timer and starts the timer.
*
* Cancels the previous timer.
+ * @SINCE_1_0.0
* @param milliSec Interval in milliseconds.
*/
void SetInterval( unsigned int milliSec );
/**
* @brief Get the interval of timer.
* @returns Interval in milliseconds.
+ * @SINCE_1_0.0
*/
unsigned int GetInterval() const;
/**
* @brief Tells whether timer is running.
+ * @SINCE_1_0.0
* @return Whether Timer is started or not.
*/
bool IsRunning() const;
* If the callback function returns false emission will stop, 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
*/
TimerSignalType& TickSignal();
/**
* @brief The Text-to-speech Player.
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API TtsPlayer : public BaseHandle
{
/**
* @brief Enumeration of TTS mode.
+ * @SINCE_1_0.0
*/
enum Mode
{
- DEFAULT = 0, ///< Default mode for normal application
- NOTIFICATION, ///< Notification mode
- SCREEN_READER, ///< Screen reader mode
+ DEFAULT = 0, ///< Default mode for normal application @SINCE_1_0.0
+ NOTIFICATION, ///< Notification mode @SINCE_1_0.0
+ SCREEN_READER, ///< Screen reader mode @SINCE_1_0.0
MODE_NUM
};
/**
* @brief Enumeration of TTS state.
+ * @SINCE_1_0.0
*/
enum State
{
- UNAVAILABLE = 0, ///< Player is not available
- READY, ///< Player is ready to play
- PLAYING, ///< Player is playing
- PAUSED ///< Player is paused
+ UNAVAILABLE = 0, ///< Player is not available @SINCE_1_0.0
+ READY, ///< Player is ready to play @SINCE_1_0.0
+ PLAYING, ///< Player is playing @SINCE_1_0.0
+ PAUSED ///< Player is paused @SINCE_1_0.0
};
public: // Typedefs
/**
* @brief Type of signal emitted when the TTS state changes.
+ * @SINCE_1_0.0
*/
typedef Signal< void ( const Dali::TtsPlayer::State, const Dali::TtsPlayer::State ) > StateChangedSignalType;
* @brief Create an uninitialized handle.
*
* This can be initialized by calling TtsPlayer::Get().
+ * @SINCE_1_0.0
*/
TtsPlayer();
/**
* @brief Gets the singleton of the TtsPlayer for the given mode.
*
+ * @SINCE_1_0.0
* @param mode the mode of tts-player
* @return A handle of the Ttsplayer for the given mode.
*/
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~TtsPlayer();
/**
* @brief This copy constructor is required for (smart) pointer semantics.
*
+ * @SINCE_1_0.0
* @param [in] handle A reference to the copied handle
*/
TtsPlayer(const TtsPlayer& handle);
/**
* @brief This assignment operator is required for (smart) pointer semantics.
*
+ * @SINCE_1_0.0
* @param [in] rhs A reference to the copied handle
* @return A reference to this
*/
/**
* @brief Start playing the audio data synthesized from the specified text.
*
- * @pre The TtsPlayer needs to be initialized.
+ * @SINCE_1_0.0
* @param[in] text to play.
+ * @pre The TtsPlayer needs to be initialized.
*/
void Play(const std::string& text);
/**
* @brief Stops playing the utterance.
+ * @SINCE_1_0.0
* @pre The TtsPlayer needs to be initialized.
*/
void Stop();
/**
* @brief Pauses the currently playing utterance.
+ * @SINCE_1_0.0
* @pre The TtsPlayer needs to be initialized.
*/
void Pause();
/**
* @brief Resumes the previously paused utterance.
+ * @SINCE_1_0.0
* @pre The TtsPlayer needs to be initialized.
*/
void Resume();
/**
* @brief Gets the current state of the player.
+ * @SINCE_1_0.0
* @pre The TtsPlayer needs to be initialized.
*/
State GetState();
/**
* @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.
*/
Dali::TtsPlayer::StateChangedSignalType& StateChangedSignal();
/**
* @brief This constructor is used by TtsPlayer::Get().
+ * @SINCE_1_0.0
* @param[in] ttsPlayer A pointer to the TTS player.
*/
explicit DALI_INTERNAL TtsPlayer( Internal::Adaptor::TtsPlayer* ttsPlayer );
*
* It has an orientation
* and indicator properties.
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API Window : public BaseHandle
{
/**
* @brief Orientation of the window.
+ * @SINCE_1_0.0
*/
enum WindowOrientation
{
/**
* @brief Opacity of the indicator.
+ * @SINCE_1_0.0
*/
enum IndicatorBgOpacity
{
/**
* @brief Visible mode of the indicator.
+ * @SINCE_1_0.0
*/
enum IndicatorVisibleMode
{
/**
* @brief Create an initialized handle to a new Window.
+ * @SINCE_1_0.0
* @param[in] windowPosition The position and size of the window
* @param[in] name The window title
* @param[in] isTransparent Whether window is transparent
/**
* @brief Create an initialized handle to a new Window.
+ * @SINCE_1_0.0
* @param[in] windowPosition The position and size of the window
* @param[in] name The window title
* @param[in] className The window class name
*
* This can be initialized using Dali::Application::GetWindow() or
* Dali::Window::New()
+ * @SINCE_1_0.0
*/
Window();
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~Window();
/**
* @brief This copy constructor is required for (smart) pointer semantics.
*
+ * @SINCE_1_0.0
* @param [in] handle A reference to the copied handle
*/
Window(const Window& handle);
/**
* @brief This assignment operator is required for (smart) pointer semantics.
*
+ * @SINCE_1_0.0
* @param [in] rhs A reference to the copied handle
* @return A reference to this
*/
/**
* @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
*/
void ShowIndicator( IndicatorVisibleMode visibleMode );
/**
* @brief This sets the opacity mode of indicator bar.
+ * @SINCE_1_0.0
* @param[in] opacity - The opacity mode
*/
void SetIndicatorBgOpacity( IndicatorBgOpacity opacity );
*
* It does not implicitly show the indicator if it is currently
* hidden.
+ * @SINCE_1_0.0
* @param[in] orientation The orientation
*/
void RotateIndicator(WindowOrientation orientation);
/**
* @brief Set the window name and class string.
+ * @SINCE_1_0.0
* @param[in] name The name of the window
* @param[in] klass The class of the window
*/
/**
* @brief Raise window to top of window stack.
+ * @SINCE_1_0.0
*/
void Raise();
/**
* @brief Lower window to bottom of window stack.
+ * @SINCE_1_0.0
*/
void Lower();
/**
* @brief Activate window to top of window stack even it is iconified.
+ * @SINCE_1_0.0
*/
void Activate();
/**
* @brief Add an orientation to the list of available orientations.
+ * @SINCE_1_0.0
*/
void AddAvailableOrientation( WindowOrientation orientation );
/**
* @brief Remove an orientation from the list of available orientations.
+ * @SINCE_1_0.0
*/
void RemoveAvailableOrientation( WindowOrientation orientation );
/**
* @brief Set a preferred orientation.
- * @pre orientation is in the list of available orientations
+ * @SINCE_1_0.0
* @param[in] orientation The preferred orientation
+ * @pre orientation is in the list of available orientations
*/
void SetPreferredOrientation( WindowOrientation orientation );
/**
* @brief Get the preferred orientation.
+ * @SINCE_1_0.0
* @return The preferred orientation if previously set, or none.
*/
WindowOrientation GetPreferredOrientation();
/**
* @brief Returns the Drag & drop detector which can be used to receive drag & drop events.
+ * @SINCE_1_0.0
* @return A handle to the DragAndDropDetector.
*/
DragAndDropDetector GetDragAndDropDetector() const;
/**
* @brief Get the native handle of the window.
+ * @SINCE_1_0.0
* @return The native handle of the window or an empty handle.
*/
Any GetNativeHandle() const;
public: // Signals
/**
- * The user should connect to this signal to get a timing when indicator was shown / hidden.
+ * @brief The user should connect to this signal to get a timing when indicator was shown / hidden.
+ * @SINCE_1_0.0
*/
IndicatorSignalType& IndicatorVisibilityChangedSignal();
public: // Not intended for application developers
/**
* @brief This constructor is used by Dali::Application::GetWindow().
+ * @SINCE_1_0.0
* @param[in] window A pointer to the window.
*/
explicit DALI_INTERNAL Window( Internal::Adaptor::Window* window );
projects / platform / core / uifw / dali-adaptor.git / commitdiff