inc/FUiCtrlISplitPanelEventListener.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                FUiCtrlISplitPanelEventListener.h
  20  * @brief               This is the header file for the %ISplitPanelEventListener interface.
  21  *
  22  * This header file contains the declarations of the %ISplitPanelEventListener interface. @n
  23  * If a change event is generated, a method of this class is called. @n
  24  * So, if the applications perform tasks related to change events, use the methods of this class.
  25  *
  26  */
  27 #ifndef _FUI_CTRL_ISPLIT_PANEL_EVENT_LISTENER_H_
  28 #define _FUI_CTRL_ISPLIT_PANEL_EVENT_LISTENER_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   ISplitPanelEventListener
  39  * @brief               This interface implements the listener for all splitpanel events.
  40  *
  41  * @since 2.0
  42  *
  43  * The %ISplitPanelEventListener interface is the listener interface for receiving splitpanel events.
  44  * The class that processes a splitpanel event implements this interface, and the instance created with that class is registered with
  45  * a UI control, using the control's AddSplitPanelEventListener() method. When the splitpanel 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_ ISplitPanelEventListener
  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.0
  58          */
  59         virtual ~ISplitPanelEventListener(void) {}
  60
  61         /**
  62          * Called when the divider moves.
  63          *
  64          * @since 2.0
  65          *
  66          * @param[in]   source          The source of the event
  67          * @param[in]   position        The position of the divider
  68          */
  69         virtual void OnDividerPositionChanged(Tizen::Ui::Controls::SplitPanel& source, int position) = 0;
  70
  71         /**
  72          * Called when the divider is double pressed.
  73          *
  74          * @since 2.0
  75          *
  76          * @param[in] source            The source of the event
  77          * @remarks                             This method is invoked when an divider is double pressed.
  78          */
  79         virtual void OnDividerDoublePressed(Tizen::Ui::Controls::SplitPanel& source) = 0;
  80
  81 protected:
  82         //
  83         // This method is for internal use only.
  84         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  85         //
  86         // This method is reserved and may change its name at any time without prior notice.
  87         //
  88         // @since 2.0
  89         //
  90         virtual void ISplitPanelEventListener_Reserved1(void) {}
  91
  92         //
  93         // This method is for internal use only.
  94         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  95         //
  96         // This method is reserved and may change its name at any time without prior notice.
  97         //
  98         // @since 2.0
  99         //
 100         virtual void ISplitPanelEventListener_Reserved2(void) {}
 101
 102         //
 103         // This method is for internal use only.
 104         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 105         //
 106         // This method is reserved and may change its name at any time without prior notice.
 107         //
 108         // @since 2.0
 109         //
 110         virtual void ISplitPanelEventListener_Reserved3(void) {}
 111
 112 };      // ISplitPanelEventListener
 113
 114 }}} // Tizen::Ui::Controls
 115
 116 #endif // _FUI_CTRL_ISPLIT_PANEL_EVENT_LISTENER_H_