src/sclcoreui.h

   1 /*
   2  * Copyright (c) 2014 - 2015 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 #ifndef __SCL_CORE_UI_H__
  19 #define __SCL_CORE_UI_H__
  20
  21 //SCL_BEGIN_DECLS
  22 #include <string>
  23
  24 #include "scltypes.h"
  25 #include "sclcorecallback.h"
  26
  27 namespace scl
  28 {
  29
  30 /**
  31  * @brief The base class that provides features for a soft-keyboard
  32  *
  33  * This class implements all functions for working as a soft-based keyboard
  34  */
  35 class CSCLCoreUI
  36 {
  37 public:
  38     CSCLCoreUI();
  39     virtual ~CSCLCoreUI();
  40
  41     std::string get_backend_indentifier();
  42
  43     virtual sclboolean init();
  44     virtual void fini();
  45
  46     virtual void run(const sclchar *display);
  47
  48     /**
  49      * @brief This API returns the pointer to main keyboard window
  50      */
  51     virtual sclwindow get_main_window();
  52
  53     /**
  54      * @brief This API returns the rotation angle of the current screen
  55      */
  56     virtual int get_screen_rotation_degree();
  57
  58     /**
  59      * @brief This API updates the keyboard window's geometry information
  60      */
  61     virtual void set_keyboard_size_hints(SclSize portrait, SclSize landscape);
  62
  63     /**
  64      * @brief Requests to create an option window
  65      */
  66     virtual sclwindow create_option_window(SCLOptionWindowType type);
  67
  68     /**
  69      * @brief Requests to destroy an option window
  70      */
  71     virtual void destroy_option_window(sclwindow window);
  72
  73 protected:
  74     std::string m_backend_identifier;
  75
  76 private:
  77     CSCLCoreUI *m_impl;
  78 };
  79
  80 }
  81
  82 //SCL_END_DECLS
  83
  84 #endif //__SCL_CORE_UI_H__