New layouting classes
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / layouting / measured-size.h
1 #ifndef DALI_TOOLKIT_LAYOUTING_MEASURED_SIZE_H
2 #define DALI_TOOLKIT_LAYOUTING_MEASURED_SIZE_H
3
4 /*
5  * Copyright (c) 2018 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  */
19
20 #include <dali/public-api/common/dali-common.h>
21 #include <dali-toolkit/devel-api/layouting/layout-length.h>
22
23 namespace Dali
24 {
25 namespace Toolkit
26 {
27
28 /**
29  * Class that encodes a measurement and a measure state, which is set if the measured size is too small.
30  */
31 class DALI_IMPORT_API MeasuredSize
32 {
33 public:
34
35   enum State
36   {
37     MEASURED_SIZE_OK, ///< The measured size is good
38     MEASURED_SIZE_TOO_SMALL ///< The measured size is too small
39   };
40
41   MeasuredSize()
42   : mMeasuredSize( 0u )
43   {
44   }
45
46   MeasuredSize( LayoutLength measuredSize )
47   : mMeasuredSize( measuredSize ),
48     mState ( MeasuredSize::State::MEASURED_SIZE_OK )
49   {
50   }
51
52   MeasuredSize( LayoutLength measuredSize, MeasuredSize::State state )
53   : mMeasuredSize( measuredSize ),
54     mState( state )
55   {
56   }
57
58   ~MeasuredSize() = default;
59
60   MeasuredSize& operator=( const MeasuredSize& rhs )
61   {
62     this->mMeasuredSize = rhs.mMeasuredSize;
63     this->mState = rhs.mState;
64     return *this;
65   }
66
67   MeasuredSize& operator=( LayoutLength::IntType rhs )
68   {
69     this->mMeasuredSize = rhs;
70     this->mState = State::MEASURED_SIZE_OK;
71     return *this;
72   }
73
74   inline bool operator==( MeasuredSize value )
75   {
76     return mMeasuredSize == value.mMeasuredSize;
77   }
78
79   inline bool operator!=( MeasuredSize value )
80   {
81     return mMeasuredSize != value.mMeasuredSize;
82   }
83
84   inline operator LayoutLength::IntType()
85   {
86     return mMeasuredSize.mValue;
87   }
88
89   inline void SetState( MeasuredSize::State state )
90   {
91     mState = state;
92   }
93
94   inline MeasuredSize::State GetState()
95   {
96     return mState;
97   }
98
99   inline void SetSize( LayoutLength size )
100   {
101     mMeasuredSize = size;
102   }
103   inline LayoutLength GetSize()
104   {
105     return mMeasuredSize;
106   }
107
108 private:
109   LayoutLength mMeasuredSize; ///< The measured size
110   State mState; ///< The measured state
111 };
112
113 } //namespace Toolkit
114 } //namespace Dali
115
116
117 #endif // DALI_TOOLKIT_LAYOUTING_MEASURED_SIZE_H