1 #ifndef DALI_TOOLKIT_PAGE_FACTORY_H
2 #define DALI_TOOLKIT_PAGE_FACTORY_H
5 * Copyright (c) 2020 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/rendering/texture.h>
25 #include <dali-toolkit/public-api/dali-toolkit-common.h>
32 * @brief PageFactory is an abstract interface for providing textures to PageTurnView
33 * Each page is identified by a unique ID, and has a linear order from 0 to GetNumberOfPages()-1
37 class DALI_TOOLKIT_API PageFactory
40 class Extension; ///< Forward declare future extension interface
43 * @brief Virtual destructor
45 virtual ~PageFactory(){};
48 * @brief Query the number of pages available from the factory.
50 * The maximum available page has an ID of GetNumberOfPages()-1.
51 * @return The page count.
53 virtual unsigned int GetNumberOfPages() = 0;
56 * @brief Return the texture for the page
58 * For double-sided page( PageTurnLandscapeView ), the left half of texture is used as page front side, and the right half as page back side.
60 * @note Must return a valid texture handle!
62 * @param[in] pageId The ID of the page to create.
63 * @return An actor, or an uninitialized pointer if the ID is out of range.
65 virtual Texture NewPage(unsigned int pageId) = 0;
68 * @brief Retrieve the extension for this factory
70 * @return The extension if available, NULL otherwise.
72 virtual Extension* GetExtension()
78 } // namespace Toolkit
81 #endif /* DALI_TOOLKIT_PAGE_FACTORY_H */