dali/devel-api/adaptor-framework/application-devel.h

   1 #ifndef DALI_APPLICATION_DEVEL_H
   2 #define DALI_APPLICATION_DEVEL_H
   3
   4 /*
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/adaptor-framework/application.h>
  23
  24 namespace Dali
  25 {
  26 namespace DevelApplication
  27 {
  28 /**
  29  * @brief Ensures that the function passed in is called from the main loop when it is idle.
  30  * @param[in] application A handle to the Application
  31  * @param[in] callback The function to call
  32  * @return @c true if added successfully, @c false otherwise
  33  *
  34  * @note Function must be called from main event thread only
  35  *
  36  * A callback of the following type should be used:
  37  * @code
  38  *   bool MyFunction();
  39  * @endcode
  40  * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
  41  *
  42  * @note Ownership of the callback is passed onto this class.
  43  */
  44 DALI_ADAPTOR_API bool AddIdleWithReturnValue(Application application, CallbackBase* callback);
  45
  46 /**
  47 * @brief Gets the absolute path to the application's data directory which is used to store private data of the application.
  48 * @return The absolute path to the application's data directory
  49 */
  50 DALI_ADAPTOR_API std::string GetDataPath();
  51
  52 /**
  53  * @brief Downcasts a ref object to Application handle
  54  *
  55  * If handle points to an Application object, the downcast produces valid base handle
  56  * If not, the returned base handle is left uninitialized
  57  *
  58  * @param[in] refObject to an Application
  59  * @return handle to an Application object or an uninitialized base handle
  60  */
  61 DALI_ADAPTOR_API Application DownCast(Dali::RefObject* refObject);
  62
  63 } // namespace DevelApplication
  64
  65 } // namespace Dali
  66
  67 /**
  68  * @brief This is used to improve application launch performance.
  69  * Initializes some functions in advance and makes a window in advance.
  70  * @param[in,out]  argc A pointer to the number of arguments
  71  * @param[in,out]  argv A pointer to the argument list
  72  *
  73  * @note Declared in C style for calling from app-launcher.
  74  *
  75  */
  76 extern "C" DALI_ADAPTOR_API void ApplicationPreInitialize(int* argc, char** argv[]);
  77
  78 #endif // DALI_APPLICATION_DEVEL_H