1 #ifndef __DALI_TOOLKIT_VIEW_H__
2 #define __DALI_TOOLKIT_VIEW_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/actors/image-actor.h>
23 #include <dali/public-api/adaptor-framework/orientation.h>
26 #include <dali-toolkit/public-api/controls/control.h>
34 namespace Internal DALI_INTERNAL
36 // Forward declarations
41 * View provides a container where different Dali::Layer instances and a background could be added. It
42 * also provides a View::OrientationChanged() method which could be connected to the Dali::Orientation::SignalChange() signal.
43 * This method rotates all layers accordingly with the given orientation, it emits an OrientationAnimationStartsSignal signal just before the rotation animation starts.
45 * By default view anchor point and parent origin are centered, the size is full screen and is got directly from the Dali::Stage. However, by passing \e false to the
46 * Toolkit::View::New() method a custom size could be specified, and after initialization, anchor point and parent origin could be updated.
48 * If a background is set, a background layer will be created and dropped to the bottom.
50 * Use example (application is a Dali::Application object):
52 * Stage stage = Stage::GetCurrent();
54 * // Create default View. By default it gets the stage size.
55 * Toolkit::View view = Toolkit::View::New();
57 * // Add the view to the stage before setting the background.
60 * // Set background image. BACKGROUND_IMAGE is a string with the background image file path.
61 * Image backgroundImage = Image::New( BACKGROUND_IMAGE );
62 * ImageActor backgroundImageActor = ImageActor::New( backgroundImage );
63 * mView.SetBackground( backgroundImageActor );
65 * // Connects the orientation signal with the View::OrientationChanged method.
66 * application.GetOrientation().ChangedSignal().Connect( &view, &Toolkit::View::OrientationChanged );
68 * // Create a content layer.
69 * Layer contentLayer = Layer::New();
70 * contentLayer.SetAnchorPoint( AnchorPoint::CENTER );
71 * contentLayer.SetParentOrigin( ParentOrigin::CENTER );
72 * view.AddContentLayer( contentLayer );
76 * | %Signal Name | Method |
77 * |-----------------------------|------------------------------------------|
78 * | orientation-animation-start | @ref OrientationAnimationStartedSignal() |
81 class DALI_IMPORT_API View : public Control
87 * Create a View handle; this can be initialised with View::New()
88 * Calling member functions with an uninitialised handle is not allowed.
93 * Copy constructor. Creates another handle that points to the same real object
94 * @param handle to copy from
96 View( const View& handle );
99 * Assignment operator. Changes this handle to point to another real object
101 View& operator=( const View& handle );
106 * This is non-virtual since derived Handle types must not contain data or virtual methods.
111 * Create an initialized View.
112 * @param fullscreen If true, the view's size is going to be set with the Dali::Stage size. Otherwise a size must be provided. By default fullscreen is set to true.
113 * @return A handle to a newly allocated Dali resource.
115 static View New( bool fullscreen = true );
118 * Downcast an Object handle to View. If handle points to a View the
119 * downcast produces valid handle. If not the returned handle is left uninitialized.
120 * @param[in] handle Handle to an object
121 * @return handle to a View or an uninitialized handle
123 static View DownCast( BaseHandle handle );
126 * Returns a content layer.
127 * @param index to the layer container.
128 * @return A Layer handle if it exists, otherwise it returns an uninitialized handle.
130 Layer GetContentLayer( unsigned int index ) const;
133 * Adds a new layer in the view.
134 * @pre layer must be initialized.
135 * @param layer A Layer handle.
136 * @return the an index that can be used to access the layer stores in the view.
138 unsigned int AddContentLayer( Layer layer );
141 * Removes a layer from the view.
142 * @param layer The layer to be removed.
144 void RemoveContentLayer( Layer layer );
147 * Returns the background layer.
148 * @return the background layer or an empty handle if any background has been set before.
150 Layer GetBackgroundLayer() const;
153 * Sets a background image.
155 * It creates a background layer the first time this method is called and it is dropped to the bottom.
156 * Any previous set background will be replaced by the new one.
158 * @pre View must be on stage before calling SetBackground.
159 * @param image An image actor.
161 void SetBackground( ImageActor image );
164 * Sets the angle values for portrait, landscape, portrait inverse and landscape inverse.
166 * These angles are used to rotate the views.
167 * By default, orientation angles are initialized as follows: portrait 0, landscape 90, portrait inverse 180, landscape inverse 270.
169 * @param portrait angle in degrees.
170 * @param landscale angle in degrees.
171 * @param portraitInverse angle in degrees.
172 * @param landscapeInverse angle in degrees.
174 void SetOrientationFunction( Degree portrait, Degree landscale, Degree portraitInverse, Degree landscapeInverse );
177 * It rotates all layers to the new given orientation.
179 * @param orientation The new orientation.
181 void OrientationChanged( Orientation orientation );
184 * Enables or disables the view's rotation when device orientation changes.
185 * @param enabled Whether auto-rotate should be enabled or disabled. By default is enabled.
187 void SetAutoRotate( bool enabled );
191 // Orientation change animation starts.
192 typedef Signal< void ( View, Animation&, const Orientation& ) > OrientationAnimationStartedSignalType;
195 * Signal emitted just before the rotate animation starts when the device orientation changes.
197 OrientationAnimationStartedSignalType& OrientationAnimationStartedSignal();
199 public: // Not intended for application developers
202 * Creates a handle using the Toolkit::Internal implementation.
203 * @param[in] implementation The Control implementation.
205 DALI_INTERNAL View( Internal::View& implementation );
208 * Allows the creation of this Control from an Internal::CustomActor pointer.
209 * @param[in] internal A pointer to the internal CustomActor.
211 explicit DALI_INTERNAL View( Dali::Internal::CustomActor* internal );
214 } // namespace Toolkit
218 #endif // __DALI_TOOLKIT_VIEW_H__