inc/FUiCtrlISplitPanelEventListener.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  * @file                FUiCtrlISplitPanelEventListener.h
  19  * @brief               This is the header file for the %ISplitPanelEventListener interface.
  20  *
  21  * This header file contains the declarations of the %ISplitPanelEventListener interface. @n
  22  * If a change event is generated, a method of this class is called. @n
  23  * So, if the applications perform tasks related to change events, use the methods of this class.
  24  *
  25  */
  26 #ifndef _FUI_CTRL_ISPLIT_PANEL_EVENT_LISTENER_H_
  27 #define _FUI_CTRL_ISPLIT_PANEL_EVENT_LISTENER_H_
  28
  29 #include <FBaseRtIEventListener.h>
  30 #include <FBaseObject.h>
  31 #include <FUiCtrlSplitPanel.h>
  32
  33 namespace Tizen { namespace Ui { namespace Controls
  34 {
  35
  36 /**
  37  * @interface   ISplitPanelEventListener
  38  * @brief               This interface implements the listener for all splitpanel events.
  39  *
  40  * @since 2.0
  41  *
  42  * The %ISplitPanelEventListener interface is the listener interface for receiving splitpanel events.
  43  * The class that processes a splitpanel event implements this interface, and the instance created with that class is registered with
  44  * a UI control, using the control's AddSplitPanelEventListener() method. When the splitpanel event occurs, a method of that instance is invoked.
  45  *
  46  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_splitpanel.htm">SplitPanel</a>.
  47  */
  48 class _OSP_EXPORT_ ISplitPanelEventListener
  49         : virtual public Tizen::Base::Runtime::IEventListener
  50 {
  51 public:
  52         /**
  53          * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called
  54          *
  55          * @since 2.0
  56          */
  57         virtual ~ISplitPanelEventListener(void) {}
  58
  59         /**
  60          *
  61          * Called when the divider moves.
  62          *
  63          * @since 2.0
  64          *
  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.0
  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 protected:
  81         //
  82         // This method is for internal use only.
  83         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  84         //
  85         // This method is reserved and may change its name at any time without prior notice.
  86         //
  87         // @since 2.0
  88         //
  89         virtual void ISplitPanelEventListener_Reserved1(void) {}
  90
  91         //
  92         // This method is for internal use only.
  93         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  94         //
  95         // This method is reserved and may change its name at any time without prior notice.
  96         //
  97         // @since 2.0
  98         //
  99         virtual void ISplitPanelEventListener_Reserved2(void) {}
 100
 101         //
 102         // This method is for internal use only.
 103         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 104         //
 105         // This method is reserved and may change its name at any time without prior notice.
 106         //
 107         // @since 2.0
 108         //
 109         virtual void ISplitPanelEventListener_Reserved3(void) {}
 110
 111 };      // ISplitPanelEventListener
 112
 113 }}} // Tizen::Ui::Controls
 114
 115 #endif // _FUI_CTRL_ISPLIT_PANEL_EVENT_LISTENER_H_