Enlightenment CVS committal
Author : rbdpngn
Project : e17
Module : libs/ewl
Dir : e17/libs/ewl/src
Modified Files:
ewl_imenu.c ewl_imenu.h ewl_menu_base.c ewl_radiobutton.c
ewl_scrollpane.c ewl_scrollpane.h
Log Message:
Docs for the imenu and scrollpane widgets. Small adjustment in the box test.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_imenu.c,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -3 -r1.9 -r1.10
--- ewl_imenu.c 13 Jul 2003 05:52:49 -0000 1.9
+++ ewl_imenu.c 5 Sep 2003 03:07:04 -0000 1.10
@@ -4,12 +4,10 @@
void __ewl_imenu_expand(Ewl_Widget * w, void *ev_data, void *user_data);
/**
- * ewl_imenu_new - create a new internal menu
- * @image: the image icon to use for this menu
- * @title: the text to place in the menu
- *
- * Returns a pointer to a newly allocated menu on success, NULL on
- * failure.
+ * @param image: the image icon to use for this menu
+ * @param title: the text to place in the menu
+ * @return Returns a pointer to a new menu on success, NULL on failure.
+ * @brief Create a new internal menu
*/
Ewl_Widget *ewl_imenu_new(char *image, char *title)
{
@@ -30,12 +28,11 @@
/**
- * ewl_imenu_init - initialize an internal menu to starting values
- * @menu: the menu to initialize
- * @follows: the widget the menu will follow
- * @type: the menu type
- *
- * Returns nothing.
+ * @param menu: the menu to initialize
+ * @param image: the path to the icon image
+ * @param title: the string displayed in the title
+ * @return Returns no value.
+ * @brief Initialize an internal menu to starting values
*/
void ewl_imenu_init(Ewl_IMenu * menu, char *image, char *title)
{
@@ -69,27 +66,28 @@
* initializing the rest of the fields to avoid the add callback being
* called.
*/
- menu->popup = ewl_floater_new(EWL_WIDGET(menu));
- ewl_widget_set_appearance(EWL_WIDGET(menu->popup), "imenu");
- ewl_box_set_orientation(EWL_BOX(menu->popup), EWL_ORIENTATION_VERTICAL);
- ewl_object_set_fill_policy(EWL_OBJECT(menu->popup),
+ menu->base.popup = ewl_floater_new(EWL_WIDGET(menu));
+ ewl_widget_set_appearance(EWL_WIDGET(menu->base.popup), "imenu");
+ ewl_box_set_orientation(EWL_BOX(menu->base.popup),
+ EWL_ORIENTATION_VERTICAL);
+ ewl_object_set_fill_policy(EWL_OBJECT(menu->base.popup),
EWL_FILL_POLICY_NONE);
- ewl_object_set_alignment(EWL_OBJECT(menu->popup),
+ ewl_object_set_alignment(EWL_OBJECT(menu->base.popup),
EWL_ALIGNMENT_LEFT | EWL_ALIGNMENT_TOP);
emb = ewl_embed_find_by_widget(w);
- ewl_container_append_child(EWL_CONTAINER(emb), menu->popup);
+ ewl_container_append_child(EWL_CONTAINER(emb), menu->base.popup);
/*
* Position the popup menu relative to the menu.
*/
if (EWL_MENU_ITEM(w)->submenu)
- ewl_floater_set_position(EWL_FLOATER(menu->popup),
+ ewl_floater_set_position(EWL_FLOATER(menu->base.popup),
CURRENT_W(w), 0);
else {
- ewl_floater_set_position(EWL_FLOATER(menu->popup), 0,
+ ewl_floater_set_position(EWL_FLOATER(menu->base.popup), 0,
CURRENT_H(w));
- ewl_object_set_minimum_w(EWL_OBJECT(menu->popup),
+ ewl_object_set_minimum_w(EWL_OBJECT(menu->base.popup),
CURRENT_W(menu));
}
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_imenu.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- ewl_imenu.h 30 Jun 2003 05:58:59 -0000 1.3
+++ ewl_imenu.h 5 Sep 2003 03:07:04 -0000 1.4
@@ -1,10 +1,40 @@
#ifndef __EWL_IMENU_H__
#define __EWL_IMENU_H__
-#define Ewl_IMenu Ewl_Menu_Base
+/**
+ * @defgroup Ewl_Imenu A Simple Internal Menu
+ * Defines a menu used internally. The contents on the menu are not drawn
+ * outside of the Evas.
+ *
+ * @{
+ */
+
+/**
+ * A simple internal menu, it is limited to drawing within the current evas.
+ */
+typedef struct Ewl_IMenu Ewl_IMenu;
+
+/**
+ * @def EWL_IMENU(menu)
+ * Typecasts a pointer to an Ewl_IMenu pointer.
+ */
#define EWL_IMENU(menu) ((Ewl_IMenu *) menu)
+/**
+ * @struct Ewl_IMenu
+ * Inherits from the Ewl_Menu_Base and does not extend the structure, but
+ * provides policy for drawing on the current evas.
+ */
+struct Ewl_IMenu
+{
+ Ewl_Menu_Base base;
+};
+
Ewl_Widget *ewl_imenu_new(char *image, char *title);
void ewl_imenu_init(Ewl_IMenu * menu, char *image, char *title);
+
+/**
+ * @}
+ */
#endif /* __EWL_IMENU_H__ */
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_menu_base.c,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -3 -r1.14 -r1.15
--- ewl_menu_base.c 31 Aug 2003 05:47:09 -0000 1.14
+++ ewl_menu_base.c 5 Sep 2003 03:07:04 -0000 1.15
@@ -207,7 +207,7 @@
* Place the newly added child in the popup menu.
*/
menu = EWL_IMENU(parent);
- ewl_container_append_child(EWL_CONTAINER(menu->popbox), child);
+ ewl_container_append_child(EWL_CONTAINER(menu->base.popbox), child);
EWL_MENU_ITEM(child)->submenu = TRUE;
DLEAVE_FUNCTION(DLEVEL_STABLE);
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_radiobutton.c,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -3 -r1.25 -r1.26
--- ewl_radiobutton.c 4 Sep 2003 01:48:35 -0000 1.25
+++ ewl_radiobutton.c 5 Sep 2003 03:07:04 -0000 1.26
@@ -1,4 +1,3 @@
-
#include <Ewl.h>
@@ -155,7 +154,7 @@
ewd_list_remove(rb->chain);
if (ewd_list_is_empty(rb->chain))
- ewd_list_free(rb->chain);
+ ewd_list_destroy(rb->chain);
DLEAVE_FUNCTION(DLEVEL_STABLE);
}
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_scrollpane.c,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -3 -r1.21 -r1.22
--- ewl_scrollpane.c 2 Sep 2003 21:57:13 -0000 1.21
+++ ewl_scrollpane.c 5 Sep 2003 03:07:04 -0000 1.22
@@ -18,10 +18,8 @@
void *user_data);
/**
- * ewl_scrollpane_new - create a new scrollpane
- *
- * Returns a pointer to a newly allocated scrollpane on success, NULL on
- * failure.
+ * @return Returns a new scrollpane on success, NULL on failure.
+ * @brief Create a new scrollpane
*/
Ewl_Widget *ewl_scrollpane_new(void)
{
@@ -39,11 +37,11 @@
}
/**
- * ewl_scrollpane_init - initialize the fields of a scrollpane
- * @s: the scrollpane to initialize
+ * @param s: the scrollpane to initialize
+ * @return Returns no value.
+ * @brief Initialize the fields of a scrollpane
*
- * Returns no value. Sets up default callbacks and field values for the
- * scrollpane @s.
+ * Sets up default callbacks and field values for the scrollpane @a s.
*/
void ewl_scrollpane_init(Ewl_ScrollPane * s)
{
@@ -103,12 +101,12 @@
}
/**
- * ewl_scrollpane_set_hscrollbar_flag - set flags for horizontal scrollbar
- * @s: the scrollpane that contains the scrollbar to change
- * @f: the flags to set on the horizontal scrollbar in @s
+ * @param s: the scrollpane that contains the scrollbar to change
+ * @param f: the flags to set on the horizontal scrollbar in @a s
+ * @return Returns no value.
+ * @brief Set flags for horizontal scrollbar
*
- * Returns no value. The scrollbar flags for the horizontal scrollbar are set
- * to @f.
+ * The scrollbar flags for the horizontal scrollbar are set to @a f.
*/
void
ewl_scrollpane_set_hscrollbar_flag(Ewl_ScrollPane * s, Ewl_ScrollBar_Flags f)
@@ -122,12 +120,12 @@
}
/**
- * ewl_scrollpane_set_vscrollbar_flag - set flags for vertical scrollbar
- * @s: the scrollpane that contains the scrollbar to change
- * @f: the flags to set on the vertical scrollbar in @s
+ * @param s: the scrollpane that contains the scrollbar to change
+ * @param f: the flags to set on the vertical scrollbar in @a s
+ * @return Returns no value.
+ * @brief Set flags for vertical scrollbar
*
- * Returns no value. The scrollbar flags for the vertical scrollbar are set
- * to @f.
+ * The scrollbar flags for the vertical scrollbar are set to @a f.
*/
void
ewl_scrollpane_set_vscrollbar_flag(Ewl_ScrollPane * s, Ewl_ScrollBar_Flags f)
@@ -141,10 +139,9 @@
}
/**
- * ewl_scrollpane_get_hscrollbar_flag - get flags for horizontal scrollbar
- * @s: the scrollpane that contains the scrollbar to retrieve
- *
- * Returns the flags of the horizontal scrollbar on success, NULL on failure.
+ * @param s: the scrollpane that contains the scrollbar to retrieve
+ * @return Returns the flags of the horizontal scrollbar, 0 on failure.
+ * @brief Get flags for horizontal scrollbar
*/
Ewl_ScrollBar_Flags ewl_scrollpane_get_hscrollbar_flag(Ewl_ScrollPane * s)
{
@@ -159,10 +156,9 @@
}
/**
- * ewl_scrollpane_get_vscrollbar_flag - get flags for vertical scrollbar
- * @s: the scrollpane that contains the scrollbar to retrieve
- *
- * Returns the flags of the vertical scrollbar on success, NULL on failure.
+ * @param s: the scrollpane that contains the scrollbar to retrieve
+ * @return Returns the flags of the vertical scrollbar on success, 0 on failure.
+ * @brief Get flags for vertical scrollbar
*/
Ewl_ScrollBar_Flags ewl_scrollpane_get_vscrollbar_flag(Ewl_ScrollPane * s)
{
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_scrollpane.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -3 -r1.4 -r1.5
--- ewl_scrollpane.h 25 May 2002 05:46:42 -0000 1.4
+++ ewl_scrollpane.h 5 Sep 2003 03:07:04 -0000 1.5
@@ -1,17 +1,38 @@
-
#ifndef __EWL_SCROLLPANE_H__
#define __EWL_SCROLLPANE_H__
-typedef struct _ewl_scrollpane Ewl_ScrollPane;
-
+/**
+ * @defgroup Ewl_ScrollPane A Scrollable Viewing Area
+ * Provides a scrollable area for viewing large sets of widgets in a smaller
+ * viewable region.
+ *
+ * @{
+ */
+
+/**
+ * The scrollpane provides a way to pan around large collections of images.
+ */
+typedef struct Ewl_ScrollPane Ewl_ScrollPane;
+
+/**
+ * @def EWL_SCROLLPANE(scrollpane)
+ * Typecasts a pointer to an Ewl_ScrollPane pointer.
+ */
#define EWL_SCROLLPANE(scrollpane) ((Ewl_ScrollPane *) scrollpane)
-struct _ewl_scrollpane {
- Ewl_Container container;
-
- Ewl_Widget *box;
- Ewl_Widget *hscrollbar;
- Ewl_Widget *vscrollbar;
+/**
+ * @struct Ewl_ScrollPane
+ * Inherits from Ewl_Container and extends it to enclose a single widget in
+ * vertical and horizontal scrollbars for panning around displaying different
+ * regions of the enclosed widget.
+ */
+struct Ewl_ScrollPane
+{
+ Ewl_Container container; /**< Inherit from Ewl_Container */
+
+ Ewl_Widget *box; /**< The area displaying the enclosed widget */
+ Ewl_Widget *hscrollbar; /**< Horizontal scrollbar */
+ Ewl_Widget *vscrollbar; /**< Vertical scrollbar */
};
Ewl_Widget *ewl_scrollpane_new(void);
@@ -24,5 +45,9 @@
Ewl_ScrollBar_Flags ewl_scrollpane_get_hscrollbar_flag(Ewl_ScrollPane * s);
Ewl_ScrollBar_Flags ewl_scrollpane_get_vscrollbar_flag(Ewl_ScrollPane * s);
+
+/**
+ * @}
+ */
#endif /* __EWL_SCROLLPANE_H__ */
-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
