inc/FUiLayout.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                FUiLayout.h
  20  * @brief               This is the header file for the %Layout class.
  21  *
  22  * This header file contains the declarations of the %Layout class.
  23  */
  24
  25 #ifndef _FUI_LAYOUT_H_
  26 #define _FUI_LAYOUT_H_
  27
  28 #include <FBaseObject.h>
  29 #include <FUiLayoutTypes.h>
  30
  31 namespace Tizen { namespace Ui
  32 {
  33
  34 /**
  35  * @class       Layout
  36  * @brief       This class is the abstract base class of all the %Layout classes.
  37  *
  38  * @since       2.0
  39  *
  40  * The %Layout class is the abstract base class of all the %Layout classes.
  41  * @n
  42  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/layout.htm">Layout</a>.
  43  */
  44 class _OSP_EXPORT_ Layout
  45         : public Tizen::Base::Object
  46 {
  47 public:
  48         /**
  49          * This destructor overrides Tizen::Base::Object::~Object().
  50          *
  51          * @since       2.0
  52          */
  53         virtual ~Layout(void);
  54
  55         /**
  56          * Gets the type of the layout.
  57          *
  58          * @since       2.0
  59          *
  60          * @return      The layout type
  61          */
  62         virtual LayoutType GetLayoutType(void) const = 0;
  63
  64         /**
  65          * Updates the layout.
  66          *
  67          * @since 2.0
  68          *
  69          * @return        An error code
  70          *
  71          * @exception     E_SUCCESS                           The method is successful.
  72          */
  73         result Update(void);
  74
  75 protected:
  76         /**
  77          * This is the default constructor for this class.
  78          *
  79          * @since       2.0
  80          */
  81         Layout(void);
  82
  83 private:
  84         //
  85         // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
  86         //
  87         Layout(const Layout& rhs);
  88
  89         //
  90         // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
  91         //
  92         Layout& operator =(const Layout& rhs);
  93
  94 protected:
  95         void* _pImpl;
  96         friend class _LayoutImpl;
  97 }; // Layout
  98
  99 }} // Tizen::Ui
 100
 101 #endif // _FUI_LAYOUT_H_