1 #ifndef __DALI_TOOLKIT_PAGE_FACTORY_H__
2 #define __DALI_TOOLKIT_PAGE_FACTORY_H__
5 * Copyright (c) 2015 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/actor.h>
31 * @brief PageFactory is an abstract interface for providing images to PageTurnView
32 * Each page is identified by a unique ID, and has a linear order from 0 to GetNumberOfPages()-1
36 class DALI_IMPORT_API PageFactory
40 class Extension; ///< Forward declare future extension interface
43 * @brief Virtual destructor
46 virtual ~PageFactory(){};
49 * @brief Query the number of pages available from the factory.
51 * The maximum available page has an ID of GetNumberOfPages()-1.
53 * @return The page count.
55 virtual unsigned int GetNumberOfPages() = 0;
58 * @brief Create an actor to represent the page content.
61 * If no valid image provided, a broken image is displayed.
62 * For double-sided page( PageTurnLandscapeView ), the left half of image is used as page front side, and the right half as page back side.
64 * @param[in] pageId The ID of the page to create.
65 * @return An actor, or an uninitialized pointer if the ID is out of range.
67 virtual Image NewPage( unsigned int pageId ) = 0;
70 * @brief Retrieve the extension for this factory
73 * @return The extension if available, NULL otherwise.
75 virtual Extension* GetExtension()
81 } // namespace Toolkit
84 #endif /* __DALI_TOOLKIT_PAGE_FACTORY_H__ */