inc/FUiCtrlISplitPanelEventListenerF.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0/
  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                FUiCtrlISplitPanelEventListenerF.h
  20  * @brief               This is the header file for the %ISplitPanelEventListenerF interface.
  21  *
  22  * This header file contains the declarations of the %ISplitPanelEventListenerF interface. @n
  23  * If a change event is generated, a method of this interface is called. @n
  24  * So, if the applications perform tasks related to change events, use the methods of this interface.
  25  *
  26  */
  27 #ifndef _FUI_CTRL_ISPLIT_PANEL_EVENT_LISTENER_F_H_
  28 #define _FUI_CTRL_ISPLIT_PANEL_EVENT_LISTENER_F_H_
  29
  30 #include <FBaseRtIEventListener.h>
  31 #include <FBaseObject.h>
  32 #include <FUiCtrlSplitPanel.h>
  33
  34 namespace Tizen { namespace Ui { namespace Controls
  35 {
  36
  37 /**
  38  * @interface   ISplitPanelEventListenerF
  39  * @brief               This interface implements the listener for all split panel events.
  40  *
  41  * @since 2.1
  42  *
  43  * The %ISplitPanelEventListenerF interface is the listener interface for receiving split panel events.
  44  * The class that processes a split panel event implements this interface, and the instance created with that class is registered with
  45  * a UI control, using the SplitPanel::AddSplitPanelEventListener() method. When the split panel event occurs, a method of that instance is invoked.
  46  *
  47  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_splitpanel.htm">SplitPanel</a>.
  48  */
  49 class _OSP_EXPORT_ ISplitPanelEventListenerF
  50         : virtual public Tizen::Base::Runtime::IEventListener
  51 {
  52 public:
  53         /**
  54          * This polymorphic destructor should be overridden if required.@n
  55          * This way, the destructors of the derived classes are called when the destructor of this interface is called
  56          *
  57          * @since 2.1
  58          */
  59         virtual ~ISplitPanelEventListenerF(void) {}
  60
  61         /**
  62          *
  63          * Called when a divider moves.
  64          *
  65          * @since 2.1
  66          *
  67          * @param[in]   source          The source of the event
  68          * @param[in]   position        The position of the divider
  69          */
  70         virtual void OnDividerPositionChanged(Tizen::Ui::Controls::SplitPanel& source, float position) = 0;
  71
  72         /**
  73          * Called when a divider is double pressed.
  74          *
  75          * @since 2.1
  76          *
  77          * @param[in] source            The source of the event
  78          * @remarks                             This method is invoked when a divider is double pressed.
  79          */
  80         virtual void OnDividerDoublePressed(Tizen::Ui::Controls::SplitPanel& source) = 0;
  81
  82 protected:
  83         //
  84         // This method is for internal use only.
  85         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  86         //
  87         // This method is reserved and may change its name at any time without prior notice.
  88         //
  89         // @since 2.1
  90         //
  91         virtual void ISplitPanelEventListenerF_Reserved1(void) {}
  92
  93         //
  94         // This method is for internal use only.
  95         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  96         //
  97         // This method is reserved and may change its name at any time without prior notice.
  98         //
  99         // @since 2.1
 100         //
 101         virtual void ISplitPanelEventListenerF_Reserved2(void) {}
 102
 103         //
 104         // This method is for internal use only.
 105         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 106         //
 107         // This method is reserved and may change its name at any time without prior notice.
 108         //
 109         // @since 2.1
 110         //
 111         virtual void ISplitPanelEventListenerF_Reserved3(void) {}
 112
 113 };      // ISplitPanelEventListenerF
 114
 115 }}} // Tizen::Ui::Controls
 116
 117 #endif // _FUI_CTRL_ISPLIT_PANEL_EVENT_LISTENER_F_H_