From 2165089e210ca6e9c5ab51757462d3989c186730 Mon Sep 17 00:00:00 2001 From: Carsten Haitzler Date: Tue, 12 Jun 2012 10:21:41 +0000 Subject: [PATCH] add docs for new win funcs. SVN revision: 72012 --- legacy/elementary/src/lib/elm_win.h | 54 +++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/legacy/elementary/src/lib/elm_win.h b/legacy/elementary/src/lib/elm_win.h index dedc72e6fc..166546b7f5 100644 --- a/legacy/elementary/src/lib/elm_win.h +++ b/legacy/elementary/src/lib/elm_win.h @@ -777,10 +777,64 @@ EAPI void elm_win_aspect_set(Evas_Object *obj, double aspect); */ EAPI double elm_win_aspect_get(const Evas_Object *obj); +/** + * Set the base window size used with stepping calculation + * + * Base size + stepping is what is calculated for window sizing restrictions. + * + * @param obj The window object + * @param w The base width + * @param h The base height + * + * @ingroup Win + * @see elm_win_size_step_set + * @see elm_win_size_base_get + * @since 1.1 + */ EAPI void elm_win_size_base_set(Evas_Object *obj, int w, int h); + +/** + * Get the base size of a window. + * + * @param obj The window object + * @param w Pointer in which to store returned base width + * @param h Pointer in which to store returned base height + * + * @ingroup Win + * @see elm_win_size_base_set + * @see elm_win_size_step_set + * @since 1.1 + */ EAPI void elm_win_size_base_get(Evas_Object *obj, int *w, int *h); +/** + * Set the window stepping used with sizing calculation + * + * Base size + stepping is what is calculated for window sizing restrictions. + * + * @param obj The window object + * @param w The stepping width (0 disables) + * @param h The stepping height (0 disables) + * + * @ingroup Win + * @see elm_win_size_step_get + * @see elm_win_size_base_set + * @since 1.1 + */ EAPI void elm_win_size_step_set(Evas_Object *obj, int w, int h); + +/** + * Get the stepping of a window. + * + * @param obj The window object + * @param w Pointer in which to store returned stepping width + * @param h Pointer in which to store returned stepping height + * + * @ingroup Win + * @see elm_win_size_base_set + * @see elm_win_size_step_set + * @since 1.1 + */ EAPI void elm_win_size_step_get(Evas_Object *obj, int *w, int *h); /**