diff options
author | Matt Watson <mattdangerw@gmail.com> | 2013-05-31 00:32:58 -0700 |
---|---|---|
committer | Matt Watson <mattdangerw@gmail.com> | 2013-05-31 00:32:58 -0700 |
commit | 0128f7ea2adf4f94456ccbcaf33e5515fcfbf8e2 (patch) | |
tree | 6918010b51544f77aad902d9c4c5f88400e39a59 | |
parent | 3ea04fe6d3253f1ca698a313e24eb3d5aeac3948 (diff) |
Added documentation for page manager transition type and duration.
[endlessm/eos-sdk#61]
-rw-r--r-- | docs/reference/endless/endless-sections.txt | 7 | ||||
-rw-r--r-- | endless/eospagemanager.c | 24 | ||||
-rw-r--r-- | endless/eospagemanager.h | 12 |
3 files changed, 25 insertions, 18 deletions
diff --git a/docs/reference/endless/endless-sections.txt b/docs/reference/endless/endless-sections.txt index b3227a2..fdb4b04 100644 --- a/docs/reference/endless/endless-sections.txt +++ b/docs/reference/endless/endless-sections.txt @@ -57,7 +57,12 @@ eos_page_manager_get_page_custom_toolbox_widget eos_page_manager_set_page_custom_toolbox_widget eos_page_manager_get_page_background_uri eos_page_manager_set_page_background_uri +eos_page_manager_get_transition_duration +eos_page_manager_set_transition_duration +eos_page_manager_get_transition_type +eos_page_manager_set_transition_type eos_page_manager_remove_page_by_name +EosPageManagerTransitionType <SUBSECTION Standard> EOS_IS_PAGE_MANAGER EOS_IS_PAGE_MANAGER_CLASS @@ -65,8 +70,10 @@ EOS_PAGE_MANAGER EOS_PAGE_MANAGER_CLASS EOS_PAGE_MANAGER_GET_CLASS EOS_TYPE_PAGE_MANAGER +EOS_TYPE_PAGE_MANAGER_TRANSITION_TYPE EosPageManagerClass eos_page_manager_get_type +eos_page_manager_transition_type_get_type <SUBSECTION Private> EosPageManagerPrivate </SECTION> diff --git a/endless/eospagemanager.c b/endless/eospagemanager.c index d44dbb8..7e21603 100644 --- a/endless/eospagemanager.c +++ b/endless/eospagemanager.c @@ -123,7 +123,7 @@ eos_page_manager_transition_type_get_type (void) { EOS_PAGE_MANAGER_TRANSITION_TYPE_SLIDE_DOWN, "EOS_PAGE_MANAGER_TRANSITION_TYPE_SLIDE_DOWN", "slide_down" }, { 0, NULL, NULL } }; - etype = g_enum_register_static (g_intern_static_string ("EosPageManagerTransition"), values); + etype = g_enum_register_static (g_intern_static_string ("EosPageManagerTransitionType"), values); } return etype; } @@ -1184,8 +1184,8 @@ eos_page_manager_set_transition_duration (EosPageManager *self, * eos_page_manager_get_transition_type: * @self: the page manager * - * Gets the animation type of page transitions. See #EosPageManager - * :transition-type for more information. + * Gets the animation type of page transitions. See + * #EosPageManager:transition-type for more information. * * Returns: the current transition type of the page manager. */ @@ -1203,8 +1203,8 @@ eos_page_manager_get_transition_type (EosPageManager *self) * @self: the page manager * @transition: the type of page transitions * - * Sets the animation type of page transitions. See #EosPageManager - * :transition-type for more information. + * Sets the animation type of page transitions. See + * #EosPageManager:transition-type for more information. */ void eos_page_manager_set_transition_type (EosPageManager *self, @@ -1212,28 +1212,16 @@ eos_page_manager_set_transition_type (EosPageManager *self, { g_return_if_fail (EOS_IS_PAGE_MANAGER (self)); - // WOO useless switch statement! Should I just cast, cause I know they're the - // same? This seems more futureproof. PStackTransitionType type; switch (transition) { case EOS_PAGE_MANAGER_TRANSITION_TYPE_NONE: - type = P_STACK_TRANSITION_TYPE_NONE; - break; case EOS_PAGE_MANAGER_TRANSITION_TYPE_CROSSFADE: - type = P_STACK_TRANSITION_TYPE_CROSSFADE; - break; case EOS_PAGE_MANAGER_TRANSITION_TYPE_SLIDE_RIGHT: - type = P_STACK_TRANSITION_TYPE_SLIDE_RIGHT; - break; case EOS_PAGE_MANAGER_TRANSITION_TYPE_SLIDE_LEFT: - type = P_STACK_TRANSITION_TYPE_SLIDE_LEFT; - break; case EOS_PAGE_MANAGER_TRANSITION_TYPE_SLIDE_UP: - type = P_STACK_TRANSITION_TYPE_SLIDE_UP; - break; case EOS_PAGE_MANAGER_TRANSITION_TYPE_SLIDE_DOWN: - type = P_STACK_TRANSITION_TYPE_SLIDE_DOWN; + type = (PStackTransitionType)transition; break; default: type = P_STACK_TRANSITION_TYPE_NONE; diff --git a/endless/eospagemanager.h b/endless/eospagemanager.h index 4512988..b1ffbe1 100644 --- a/endless/eospagemanager.h +++ b/endless/eospagemanager.h @@ -41,6 +41,18 @@ typedef struct _EosPageManagerPrivate EosPageManagerPrivate; #define EOS_TYPE_PAGE_MANAGER_TRANSITION_TYPE (eos_page_manager_transition_type_get_type ()) +/** + * EosPageManagerTransitionType: + * @EOS_PAGE_MANAGER_TRANSITION_TYPE_NONE: No animation, regardless of duration. + * @EOS_PAGE_MANAGER_TRANSITION_TYPE_CROSSFADE: Pages will not move, but fade into one another. + * @EOS_PAGE_MANAGER_TRANSITION_TYPE_SLIDE_RIGHT: The old page will slide off to the right. + * @EOS_PAGE_MANAGER_TRANSITION_TYPE_SLIDE_LEFT: The old page will slide off to the left. + * @EOS_PAGE_MANAGER_TRANSITION_TYPE_SLIDE_UP: The old page will slide up the screen. + * @EOS_PAGE_MANAGER_TRANSITION_TYPE_SLIDE_DOWN: The old page will slide down the screen. + * + * Enum values to specify the type of animation to use when transitioning + * between pages. + **/ typedef enum { EOS_PAGE_MANAGER_TRANSITION_TYPE_NONE, EOS_PAGE_MANAGER_TRANSITION_TYPE_CROSSFADE, |