Enlightenment CVS committal
Author : dj2
Project : e17
Module : docs
Dir : e17/docs/cookbook/xml/ewl
Modified Files:
ewl_intro.xml
Log Message:
- changed the ewl_intro to use the new _object_ api
- added ()'s to the end of functions
===================================================================
RCS file: /cvsroot/enlightenment/e17/docs/cookbook/xml/ewl/ewl_intro.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- ewl_intro.xml 27 Jul 2004 00:03:29 -0000 1.5
+++ ewl_intro.xml 13 Aug 2004 00:32:55 -0000 1.6
@@ -78,13 +78,13 @@
<para>
The main function for our text viewer is very simplistic. We start by initializing
-ewl through the <function>ewl_init</function> call. Ewl takes the argc and argv
entries to do some
+ewl through the <function>ewl_init()</function> call. Ewl takes the argc and argv
entries to do some
command line parsing of its own. This includes such things as setting the Ewl theme
to use (--ewl-theme) or setting the rendering engine (--ewl-software-x11,
--ewl-gl-x11, etc.).
</para>
<para>
-<function>ewl_init</function> takes care of all the dirty work of initializing the
other required libs,
+<function>ewl_init()</function> takes care of all the dirty work of initializing the
other required libs,
abstracting all that away from the programmer into a simple interface.
</para>
@@ -93,7 +93,7 @@
</para>
<para>
-The call to <function>ewl_main</function> sets up the main processing loop, and upon
exit handles
+The call to <function>ewl_main()</function> sets up the main processing loop, and
upon exit handles
all of the applications required shutdown, hence there is no shutdown call from our
main routine.
</para>
@@ -112,8 +112,8 @@
ewl_window_set_name(EWL_WINDOW(main_win), PROG);
ewl_window_set_class(EWL_WINDOW(main_win), PROG);
- ewl_object_request_size(EWL_OBJECT(main_win), 200, 300);
- ewl_object_set_fill_policy(EWL_OBJECT(main_win), EWL_FLAG_FILL_FILL);
+ ewl_object_size_request(EWL_OBJECT(main_win), 200, 300);
+ ewl_object_fill_policy_set(EWL_OBJECT(main_win), EWL_FLAG_FILL_FILL);
ewl_callback_append(main_win, EWL_CALLBACK_DELETE_WINDOW, destroy_cb, NULL);
ewl_widget_show(main_win);
@@ -121,28 +121,28 @@
</example>
<para>
The first thing we need to do to get our app off of the ground is to create the
-main application window. This is done through the call to
<function>ewl_window_new</function>.
+main application window. This is done through the call to
+<function>ewl_window_new()</function>.
Once we have the window we can continue to set the title (as will appear in
the WM bar on top of the app), name and class of the window.
</para>
<para>
Once the default information is set for the window we request a default size for the
-window to be 200x300 through the call to
<function>ewl_object_request_size</function>. Along with the
+window to be 200x300 through the call to
<function>ewl_object_size_request()</function>. Along with the
default size we could have set a minimum and maximum size for the window through the
-calls to <function>ewl_object_set_minimum_size</function> and
-<function>ewl_object_set_maximum</function> size. But as this
+calls to <function>ewl_object_minimum_size_set()</function> and
+<function>ewl_object_maximum_size_set()</function> size. But as this
is not required for this application they are left out.
</para>
<para>
The final setup of the window is done by setting the fill policy with
-<function>ewl_object_set_fill_policy</function>. This sets how Ewl will pack widgets
into the window, with
+<function>ewl_object_fill_policy_set()</function>. This sets how Ewl will pack
widgets into the window, with
a possible values of:
</para>
-<variablelist>
-
+<variablelist termlength="25" spacing="compact">
<varlistentry>
<term>EWL_FLAG_FILL_NONE</term>
<listitem>
@@ -203,16 +203,16 @@
<para>
After all the window properties are defined a callback to catch the
-destruction of the main window is attached with
<function>ewl_callback_append</function>.
-The function <function>destroy_cb</function> will be called if someone requests the
window
+destruction of the main window is attached with
<function>ewl_callback_append()</function>.
+The function <function>destroy_cb()</function> will be called if someone requests the
window
to be destroyed in some fashion.
</para>
<para>
-We show the main with with a call to <function>ewl_widget_show</function>. If
-<function>ewl_widget_show</function>
+We show the main with with a call to <function>ewl_widget_show()</function>. If
+<function>ewl_widget_show()</function>
is not called nothing would appear on the screen. All widgets are hidden until
-they are explicitly shown. The opposite to this is
<function>ewl_widget_hide</function> which
+they are explicitly shown. The opposite to this is
<function>ewl_widget_hide()</function> which
will remove a widget from the screen.
</para>
@@ -222,7 +222,7 @@
/* create the main container */
box = ewl_vbox_new();
ewl_container_append_child(EWL_CONTAINER(main_win), box);
- ewl_object_set_fill_policy(EWL_OBJECT(box), EWL_FLAG_FILL_FILL);
+ ewl_object_fill_policy_set(EWL_OBJECT(box), EWL_FLAG_FILL_FILL);
ewl_widget_show(box);
</programlisting>
</example>
@@ -233,11 +233,12 @@
</para>
<para>
-This is done by creating a vertical box with <function>ewl_vbox_new</function>. The
box is then
-taken and appended to the windows list of children with
<function>ewl_container_append_child</function>.
+This is done by creating a vertical box with <function>ewl_vbox_new()</function>. The
box is then
+taken and appended to the windows list of children with
+<function>ewl_container_append_child()</function>.
After attaching to the window we set the fill policy to fill both horizontal
-and vertical with <function>ewl_object_set_fill_policy</function>,
-and show the widget with <function>ewl_widget_show</function>.
+and vertical with <function>ewl_object_fill_policy_set()</function>,
+and show the widget with <function>ewl_widget_show()</function>.
</para>
<para>
@@ -253,10 +254,10 @@
/* create the menu bar */
menu_bar = ewl_hbox_new();
ewl_container_append_child(EWL_CONTAINER(box), menu_bar);
- ewl_object_set_fill_policy(EWL_OBJECT(menu_bar), EWL_FLAG_FILL_HSHRINK);
- ewl_object_set_alignment(EWL_OBJECT(menu_bar), EWL_FLAG_ALIGN_LEFT);
+ ewl_object_fill_policy_set(EWL_OBJECT(menu_bar), EWL_FLAG_FILL_HSHRINK);
+ ewl_object_alignment_set(EWL_OBJECT(menu_bar), EWL_FLAG_ALIGN_LEFT);
ewl_box_set_spacing(EWL_BOX(menu_bar), 4);
- ewl_object_set_padding(EWL_OBJECT(menu_bar), 5, 5, 5, 5);
+ ewl_object_padding_set(EWL_OBJECT(menu_bar), 5, 5, 5, 5);
ewl_widget_show(menu_bar);
</programlisting>
</example>
@@ -269,7 +270,8 @@
<para>
The calls are the same as many you have seen before, appending ourselves to our
parent,
setting our fill policy, showing the widget. The ones not seen before include
-<function>ewl_object_set_alignment</function>, this will set how the widget is
aligned within its container.
+<function>ewl_object_alignment_set()</function>, this will set how the widget is
aligned
+within its container.
In this case we are using EWL_FLAG_ALIGN_LEFT, but could have used on of the other
available
alignments including:
<itemizedlist mark="bullet" spacing="compact">
@@ -284,9 +286,10 @@
<para>
We then specify the spacing of items inside the menu box. This will give
-a little more space between our menu items and is done with
<function>ewl_box_set_spacing</function>.
+a little more space between our menu items and is done with
+<function>ewl_box_set_spacing()</function>.
After changing the space we change the padding around the box as a whole
-with the call to <function>ewl_object_set_padding</function>, this will increase the
amount of
+with the call to <function>ewl_object_padding_set()</function>, this will increase
the amount of
space left around the object as a whole.
</para>
@@ -296,7 +299,7 @@
/* create the scrollpane */
scroll = ewl_scrollpane_new();
ewl_container_append_child(EWL_CONTAINER(box), scroll);
- ewl_object_set_fill_policy(EWL_OBJECT(scroll), EWL_FLAG_FILL_FILL);
+ ewl_object_fill_policy_set(EWL_OBJECT(scroll), EWL_FLAG_FILL_FILL);
ewl_scrollpane_set_hscrollbar_flag(EWL_SCROLLPANE(scroll),
EWL_SCROLLBAR_FLAG_AUTO_VISIBLE);
ewl_scrollpane_set_vscrollbar_flag(EWL_SCROLLPANE(scroll),
@@ -310,7 +313,7 @@
</para>
<para>
-The scrollpane is created with a call to <function>ewl_scrollpane_new</function>, and
we then
+The scrollpane is created with a call to <function>ewl_scrollpane_new()</function>,
and we then
proceed to attach the scrollpane to the main box, and set its fill policy.
</para>
@@ -331,13 +334,13 @@
/* create the text area */
text_area = ewl_text_new("");
ewl_container_append_child(EWL_CONTAINER(scroll), text_area);
- ewl_object_set_padding(EWL_OBJECT(text_area), 1, 1, 1, 1);
+ ewl_object_padding_set(EWL_OBJECT(text_area), 1, 1, 1, 1);
ewl_widget_show(text_area);
</programlisting>
</example>
<para>
The text area will be responsible for holding the text we display in our viewer.
-The widget is created with a simple call to <function>ewl_text_new</function>. This
will cause the
+The widget is created with a simple call to <function>ewl_text_new()</function>. This
will cause the
text area to be created, but with the actual text blank. As with the menu bar
we increase the padding around the text area to provide a bit of space from the edge
of the text to any other elements.
@@ -377,20 +380,20 @@
</para>
<para>
-The menu is created with a call to <function>ewl_imenu_new</function>. This takes two
parameters,
+The menu is created with a call to <function>ewl_imenu_new()</function>. This takes
two parameters,
the first is the image to display with this menu, in this case NULL, being no image.
The second parameter is the name of the menu as will appear in the menu bar.
</para>
<para>
Once the menu is created we can then proceed to add entries to the menu through
-a call to <function>ewl_menu_item_new</function>. This again takes two parameters,
the icon to
+a call to <function>ewl_menu_item_new()</function>. This again takes two parameters,
the icon to
display beside this entry in the menu, and the name as it will appear in the
menu.
</para>
<para>
-As the items are added to the menu we make a call to
<function>ewl_callback_append</function> to attach
+As the items are added to the menu we make a call to
<function>ewl_callback_append()</function> to attach
to the EWL_CALLBACK_SELECT call. The given function will be executed when the
use clicks on the menu entry. In the "open" case we have passed the
text_area
to the open callback to allow us to easily modify its contents.
@@ -427,9 +430,9 @@
</example>
<para>
When the main window is closed we destroy the widget that is the main window
-through a call to <function>ewl_widget_destroy</function>. After the window is
destroyed we
-tell Ewl that we wish to exit by calling <function>ewl_main_quit</function>. This
will cause
-Ewl to halt the main processing loop and the previous call to
<function>ewl_main</function> will
+through a call to <function>ewl_widget_destroy()</function>. After the window is
destroyed we
+tell Ewl that we wish to exit by calling <function>ewl_main_quit()</function>. This
will cause
+Ewl to halt the main processing loop and the previous call to
<function>ewl_main()</function> will
return.
</para>
@@ -447,8 +450,8 @@
ewl_window_set_title(EWL_WINDOW(fd_win), PROG " -- file dialog");
ewl_window_set_name(EWL_WINDOW(fd_win), PROG " -- file dialog");
ewl_window_set_class(EWL_WINDOW(fd_win), PROG " -- file dialog");
- ewl_object_request_size(EWL_OBJECT(fd_win), 500, 400);
- ewl_object_set_fill_policy(EWL_OBJECT(fd_win),
+ ewl_object_size_request(EWL_OBJECT(fd_win), 500, 400);
+ ewl_object_fill_policy_set(EWL_OBJECT(fd_win),
EWL_FLAG_FILL_FILL | EWL_FLAG_FILL_SHRINK);
ewl_callback_append(fd_win, EWL_CALLBACK_DELETE_WINDOW,
destroy_filedialog_cb, NULL);
@@ -457,7 +460,7 @@
/* fd win container */
box = ewl_vbox_new();
ewl_container_append_child(EWL_CONTAINER(fd_win), box);
- ewl_object_set_fill_policy(EWL_OBJECT(box),
+ ewl_object_fill_policy_set(EWL_OBJECT(box),
EWL_FLAG_FILL_FILL | EWL_FLAG_FILL_SHRINK);
ewl_widget_show(box);
@@ -469,7 +472,7 @@
/* add a home button */
home = ewl_button_new("Home");
ewl_callback_append(home, EWL_CALLBACK_CLICKED, home_cb, fd);
- ewl_object_set_fill_policy(EWL_OBJECT(home), EWL_FLAG_FILL_HFILL);
+ ewl_object_fill_policy_set(EWL_OBJECT(home), EWL_FLAG_FILL_HFILL);
ewl_container_append_child(EWL_CONTAINER(fd), home);
ewl_widget_show(home);
@@ -478,7 +481,8 @@
</programlisting>
</example>
<para>
-If a use clicks on the open entry in the file menu, the
<function>file_menu_open_cb</function> will
+If a use clicks on the open entry in the file menu, the
+<function>file_menu_open_cb()</function> will
be executed. When that happens we need to create the file dialog for the
use to select the file to view.
</para>
@@ -492,7 +496,7 @@
<para>
Once the window is setup, we make the call to create the file dialog. This is
-done with a call to <function>ewl_filedialog_new</function>, specifying the type of
file dialog we
+done with a call to <function>ewl_filedialog_new()</function>, specifying the type of
file dialog we
wish to create. In this case we want a dialog to allow us to open a file, so we
specify EWL_FILEDIALOG_TYPE_OPEN. We could have specified EWL_FILEDIALOG_TYPE_SAVE if
we wished to use the dialog to save a file instead of open.
@@ -500,7 +504,8 @@
<para>
We then proceed to create an extra button to allow the user to navigate to their
-home directory with a single click. This is done by calling
<function>ewl_button_new</function>
+home directory with a single click. This is done by calling
+<function>ewl_button_new()</function>
and packing the subsequent button into the file dialog itself.
</para>
@@ -516,8 +521,8 @@
</example>
<para>
When we need to get rid of the file dialog we remove the widget from the
-screen with a call to <function>ewl_widget_hide</function>, and once it is no longer
displayed
-we destroy the widget with a call to <function>ewl_widget_destroy</function>.
+screen with a call to <function>ewl_widget_hide()</function>, and once it is no
longer displayed
+we destroy the widget with a call to <function>ewl_widget_destroy()</function>.
</para>
<example>
@@ -548,7 +553,7 @@
<para>
In our case, we take that file and pass it to the function to read in
the file and return the text of the file. Then using that text, as long
-as it is defined, we call <function>ewl_text_text_set</function> which will set the
text
+as it is defined, we call <function>ewl_text_text_set()</function> which will set the
text
of the given text object.
</para>
@@ -576,7 +581,7 @@
display the contents of their home directory to them. We set the
file dialog as the user data to the callback, so we cast that back to the
Ewl_Filedialog and grabbing the home directory from the environment. The
-call to <function>ewl_filedialog_set_directory</function> changes the current
directory
+call to <function>ewl_filedialog_set_directory()</function> changes the current
directory
the file dialog is displaying to be the users home directory.
</para>
@@ -660,7 +665,7 @@
</programlisting>
</example>
<para>
-The <function>key_up_cb</function> will be called whenever the user releases a key on
the keyboard. The
+The <function>key_up_cb()</function> will be called whenever the user releases a key
on the keyboard. The
callback will receive an Ewl_Event_Key_Down structure containing the information on
the key press itself. In our case we just need the keyname entry which is the name
of the key that was pressed.
-------------------------------------------------------
SF.Net email is sponsored by Shop4tech.com-Lowest price on Blank Media
100pk Sonic DVD-R 4x for only $29 -100pk Sonic DVD+R for only $33
Save 50% off Retail on Ink & Toner - Free Shipping and Free Gift.
http://www.shop4tech.com/z/Inkjet_Cartridges/9_108_r285
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
