Enlightenment CVS committal

Author  : dj2
Project : e17
Module  : docs

Dir     : e17/docs/cookbook/xml/esmart


Modified Files:
        esmart_container_intro.xml esmart_trans_intro.xml 


Log Message:
- minor xml cleanups
- wrap functions in the <function></function> tag

===================================================================
RCS file: 
/cvsroot/enlightenment/e17/docs/cookbook/xml/esmart/esmart_container_intro.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- esmart_container_intro.xml  2 Jul 2004 22:17:45 -0000       1.1
+++ esmart_container_intro.xml  4 Jul 2004 19:34:31 -0000       1.2
@@ -165,7 +165,7 @@
 </para>
 
 <para>
-Once everything is created we call ecore_main_loop_begin and wait for
+Once everything is created we call <function>ecore_main_loop_begin</function> and 
wait for
 events to occur.
 </para>
 
@@ -273,13 +273,13 @@
 </example>
 <para>
 The GUI consists of the Ecore_Evas containing the canvas itself, and the Edje that
-we will be using to control our layout. The make_gui function sets up the callbacks 
+we will be using to control our layout. The <function>make_gui</function> function 
sets up the callbacks 
 defined above and creates the Ecore_Evas.
 </para>
 
 <para>
 Once we have the Evas and the callbacks are defined, we create the Edje object that
-will define our layout. The edje_object_add call is used to create the object on the 
Evas,
+will define our layout. The <function>edje_object_add</function> call is used to 
create the object on the Evas,
 and once thats done, we take the theme passed in by the user and set our Edje to
 use said theme, the &quot;container_ex&quot; parameter is the name of the group
 inside the EET that we are to use. 
@@ -331,8 +331,8 @@
 </programlisting>
 </example>
 <para>
-The container_build function will create the container and set our data elements in 
said
-container. The creation is easy enough with a call to esmart_container_new giving 
back the
+The <function>container_build</function> function will create the container and set 
our data elements in said
+container. The creation is easy enough with a call to 
<function>esmart_container_new</function> giving back the
 Evas_Object that is the container. Once the container is created we can set a name on 
the
 container to make reference easier.
 </para>
@@ -354,7 +354,7 @@
 
 <para>
 If we wanted to use a different layout scheme then the default, we could place a call 
to
-esmart_container_layout_plugin_set(container, "name") where the name is the name of
+<function>esmart_container_layout_plugin_set(container, "name")</function> where the 
name is the name of
 the plugin to use. The default setting is the container named &quot;default&quot;.
 </para>
 
@@ -422,8 +422,8 @@
 
 <para>
 For each element we create a new Edje object on the Evas. We then need to know the
-name of the theme file used to create our main Edje, so we call edje_object_file_get
-which will set edjefile to said value.
+name of the theme file used to create our main Edje, so we call 
<function>edje_object_file_get</function>
+which will set edje file to said value.
 </para>
 
 <para>
@@ -438,7 +438,7 @@
 </para>
 
 <para>
-A callback is created through edje_object_signal_callback_add and attached to the
+A callback is created through <function>edje_object_signal_callback_add</function> 
and attached to the
 new element. This will be called if the &quot;item_selected&quot; signal is sent from 
the Edje.
 The i_ptr value shows how data can be attached to the element, when the user clicks
 on an element its number will be printed to the console.
@@ -451,7 +451,7 @@
 
 <para>
 To finish, the container is show and we do some extra work to display information 
about
-the container in the header through the call _show_text.
+the container in the header through the call <function>_show_text</function>.
 </para>
 
 <example>
@@ -484,7 +484,7 @@
 </programlisting>
 </example>
 <para>
-The _set_text routine takes the current direction and alignment of the container and 
sets
+The <function>_set_text</function> routine takes the current direction and alignment 
of the container and sets
 some text in the header of the program. This is just a simple communication with the 
user
 of the current container settings.
 </para>
@@ -567,7 +567,7 @@
 </programlisting>
 </example>
 <para>
-Finally the _item_selected callback will be executed when the user middle clicks
+Finally the <function>_item_selected</function> callback will be executed when the 
user middle clicks
 on an item in the container. The data will contain the number set for that element
 in the create routine above.
 </para>
===================================================================
RCS file: /cvsroot/enlightenment/e17/docs/cookbook/xml/esmart/esmart_trans_intro.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- esmart_trans_intro.xml      2 Jul 2004 22:17:45 -0000       1.1
+++ esmart_trans_intro.xml      4 Jul 2004 19:34:31 -0000       1.2
@@ -129,12 +129,12 @@
 </programlisting>
 </example>
 <para>
-The _freshen_trans routine is a helper routine to update the image that the trans
+The <function>_freshen_trans</function> routine is a helper routine to update the 
image that the trans
 is shown. This will be called when we need to update our image to whats currently
 under the window.
 
 The function grabs the current size of the ecore_evas, and then gets the object
-with the name "bg" (this name is the same as the name we give our trans when
+with the name &quot;bg&quot; (this name is the same as the name we give our trans when
 we create it). Then, as long as the trans object exists, we tell esmart to 
 freshen the image being displayed.
 </para>
@@ -166,12 +166,12 @@
 When the window is resized we need to update our evas to the correct size and then
 update the trans object to display that much of the background.
 
-We grab the current size of the window (ecore_evas_geometry_get) and the min/max 
+We grab the current size of the window <function>ecore_evas_geometry_get</function> 
and the min/max 
 size of the window. As long as our currently desired size is within the min/max
-bounds set for our window, we grab the "bg" (same as title again) object and
+bounds set for our window, we grab the &quot;bg&quot; (same as title again) object and
 resize it.
 
-Once the resizing is done, we call the _freshen_trans routine to update the image
+Once the resizing is done, we call the <function>_freshen_trans</function> routine to 
update the image
 displayed on the bg.
 </para>
 
@@ -236,10 +236,10 @@
 </example>
 <para>
 Once everything is setup we can create the trans object. The trans is to be created
-in the evas returned by ecore_evas_get. This initial creation is done by the call
-to esmart_trans_x11_new(evas). Once we have the object, we move it so it starts at 
+in the evas returned by <function>ecore_evas_get</function>. This initial creation is 
done by the call
+to <function>esmart_trans_x11_new</function>. Once we have the object, we move it so 
it starts at 
 position (0, 0) (the upper left corner), set the layer to -5 and name the object
-"bg" (as used above).
+&quot;bg&quot; (as used above).
 
 Then we grab the current size of the ecore_evas and use that to resize the trans
 object to the window size. Once everything is resized we show the trans and 




-------------------------------------------------------
This SF.Net email sponsored by Black Hat Briefings & Training.
Attend Black Hat Briefings & Training, Las Vegas July 24-29 - 
digital self defense, top technical experts, no vendor pitches, 
unmatched networking opportunities. Visit www.blackhat.com
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs

Reply via email to