src/ui/inc/FUiCtrl_ISplitPanelEventListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Flora License, Version 1.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://floralicense.org/license/
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an AS IS BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19  * @file                FUiCtrl_ISplitPanelEventListener.h
  20  * @brief               This is the header file for the _ISplitPanelEventListener interface.
  21  *
  22  * This header file contains the declarations of the _ISplitPanelEventListener
  23  * interface.
  24  */
  25 #ifndef _FUI_CTRL_INTERNAL_ISPLIT_PANEL_EVENT_LISTENER_H_
  26 #define _FUI_CTRL_INTERNAL_ISPLIT_PANEL_EVENT_LISTENER_H_
  27
  28 #include <FBaseRtIEventListener.h>
  29 #include <FBaseObject.h>
  30 #include <FUiCtrlSplitPanelTypes.h>
  31
  32 namespace Tizen { namespace Ui { namespace Controls
  33 {
  34 class _SplitPanel;
  35
  36 /**
  37  * @interface   _ISplitPanelEventListener
  38  * @brief               This interface implements the listener for all splitpanel events.
  39  * @since 2.1
  40  *
  41  * The %_ISplitPanelEventListener interface is the listener interface for receiving SplitPanel events, which are fired when the divider moves or is double pressed.
  42  * The class that processes a SplitPanel event implements this interface, and the instance created with that class is registered with
  43  *  a UI control, using the control's AddSplitPanelEventListener() method. When the splitpanle divider is moved, the OnDividerPositionChanged()
  44  *  method of that instance is invoked.
  45  *
  46  * For more information on the class features, see <a href="../com.osp.cppappprogramming.help/html/dev_guide/ui/implementing_splitpanel.htm">SplitPanel</a>.
  47  */
  48 class _ISplitPanelEventListener
  49         : public Tizen::Base::Runtime::IEventListener
  50 {
  51 public:
  52         /**
  53          * This is the destructor for this class.
  54          *
  55          * @since 2.1
  56          */
  57         virtual ~_ISplitPanelEventListener(void) {}
  58
  59 public:
  60         /**
  61          *
  62          * Called when the divider moves.
  63          *
  64          * @since 2.1
  65          * @param[in]   source         The source of the event
  66          * @param[in]   position                The position of the divider
  67          */
  68         virtual void OnDividerPositionChanged(Tizen::Ui::Controls::_SplitPanel& source, int position) = 0;
  69
  70         /**
  71          * Called when the divider is double pressed.
  72          *
  73          * @since 2.1
  74          *
  75          * @param[in] source            The source of the event
  76          * @remark                              This method is invoked when an divider is double pressed.
  77          */
  78         virtual void OnDividerDoublePressed(Tizen::Ui::Controls::_SplitPanel& source) = 0;
  79
  80 };      // _ISplitPanelEventListener
  81
  82 }}} // Tizen::Ui::Controls
  83
  84 #endif // _FUI_CTRL_INTERNAL_ISPLIT_PANEL_EVENT_LISTENER_H_