X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fpage-turn-view%2Fpage-factory.h;h=2b7cd65aa4c96aab5566328fdf2a7b8190ce90ac;hb=42492df08f8a079da70931292aebb56e1252641d;hp=0c6e18df3d7bb7b97eb27f56dd2d3d02a426cdb0;hpb=0f006fbeb3f9dc630e3893887e8c6e5ae44b8e0a;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/public-api/controls/page-turn-view/page-factory.h b/dali-toolkit/public-api/controls/page-turn-view/page-factory.h index 0c6e18d..2b7cd65 100644 --- a/dali-toolkit/public-api/controls/page-turn-view/page-factory.h +++ b/dali-toolkit/public-api/controls/page-turn-view/page-factory.h @@ -28,30 +28,54 @@ namespace Toolkit { /** - * PageFactory is an abstract interface for providing image actors to PageTurnView - * Each image actor is identified by a unique ID, and has a linear order from 0 to GetNumberOfPages()-1 + * @brief PageFactory is an abstract interface for providing images to PageTurnView + * Each page is identified by a unique ID, and has a linear order from 0 to GetNumberOfPages()-1 + * + * @SINCE_1_1.4 */ class DALI_IMPORT_API PageFactory { public: + class Extension; ///< Forward declare future extension interface + /** - * Virtual destructor + * @brief Virtual destructor + * @SINCE_1_1.4 */ virtual ~PageFactory(){}; /** - * Query the number of pages available from the factory. + * @brief Query the number of pages available from the factory. + * * The maximum available page has an ID of GetNumberOfPages()-1. + * @SINCE_1_1.4 + * @return The page count. */ virtual unsigned int GetNumberOfPages() = 0; /** - * Create an actor to represent the page content. + * @brief Create an actor to represent the page content. + * @SINCE_1_1.30 + * + * If no valid image provided, a broken image is displayed. + * For double-sided page( PageTurnLandscapeView ), the left half of image is used as page front side, and the right half as page back side. + * * @param[in] pageId The ID of the page to create. * @return An actor, or an uninitialized pointer if the ID is out of range. */ - virtual Actor NewPage( unsigned int pageId ) = 0; + virtual Image NewPage( unsigned int pageId ) = 0; + + /** + * @brief Retrieve the extension for this factory + * @SINCE_1_1.30 + * + * @return The extension if available, NULL otherwise. + */ + virtual Extension* GetExtension() + { + return NULL; + } }; } // namespace Toolkit