Enlightenment CVS committal
Author : raster
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore/src/lib/ecore_x
Modified Files:
Tag: SPLIT
ecore_x.c ecore_x_error.c ecore_x_window.c
ecore_x_window_prop.c
Log Message:
spacing between api calls... in docs
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore_x/Attic/ecore_x.c,v
retrieving revision 1.1.2.15
retrieving revision 1.1.2.16
diff -u -3 -r1.1.2.15 -r1.1.2.16
--- ecore_x.c 8 Feb 2003 07:03:41 -0000 1.1.2.15
+++ ecore_x.c 27 Feb 2003 01:58:14 -0000 1.1.2.16
@@ -78,11 +78,12 @@
int ECORE_X_LOCK_CAPS = 0;
/**
- * Init the X display connection
- * @param name
+ * Init the X display connection.
+ * @param name Display target name
* @return greater than 1 on success, 0 on failure
*
* Set up an X display connection and event handlers for event processing
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_x_init(const char *name)
@@ -222,10 +223,11 @@
}
/**
- * Shut down the X syystem
+ * Shut down the X syystem.
* @return The number of times ecore X has left to be shut down
*
* This closes the X display connection and removes the handlers for it.
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_x_shutdown(void)
@@ -246,10 +248,11 @@
}
/**
- * Get the X display pointer handle
+ * Get the X display pointer handle.
* @return The X Display handle
*
* This returns the X Display handle used for the X connection.
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Display *
ecore_x_display_get(void)
@@ -258,12 +261,13 @@
}
/**
- * Set the timeout for double/triple click to be flagged
+ * Set the timeout for double/triple click to be flagged.
* @param t The time in seconds
*
* This sets the time between clicks before the double_click flag is set in a
* button down event. If 3 clicks occur within double this time then the
* triple_click flag is also set.
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_double_click_time_set(double t)
@@ -273,10 +277,11 @@
}
/**
- * Get the double/triple click timeout
+ * Get the double/triple click timeout.
* @return The timeout for double clicks in seconds
*
* This returns the tiemout that can be set by ecore_x_double_click_time_set()
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
double
ecore_x_double_click_time_get(void)
@@ -285,9 +290,10 @@
}
/**
- * Flush the command buffer
+ * Flush the command buffer.
*
* This flushes the x command buffer
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_flush(void)
@@ -296,9 +302,10 @@
}
/**
- * Sync with the server
+ * Sync with the server.
*
* This flushes the command buffer and waits for a round trip from the server
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_sync(void)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore_x/Attic/ecore_x_error.c,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -3 -r1.1.2.1 -r1.1.2.2
--- ecore_x_error.c 23 Jan 2003 01:08:35 -0000 1.1.2.1
+++ ecore_x_error.c 27 Feb 2003 01:58:14 -0000 1.1.2.2
@@ -11,11 +11,12 @@
static int _error_code = 0;
/**
- * Set the error handler
- * @param func
- * @param data
+ * Set the error handler.
+ * @param func The error handler function
+ * @param data The data to be passed to the handler function
*
* Set the X error handler function
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_error_handler_set(void (*func) (void *data), const void *data)
@@ -25,10 +26,11 @@
}
/**
- * Get the request code that caused the error
+ * Get the request code that caused the error.
* @return The request code causing the X error
*
* Return the X request code that caused the last X error
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_x_error_request_get(void)
@@ -37,10 +39,11 @@
}
/**
- * Get the error code from the error
+ * Get the error code from the error.
* @return The error code from the X error
*
* Return the error code from the last X error
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_x_error_code_get(void)
===================================================================
RCS file:
/cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore_x/Attic/ecore_x_window.c,v
retrieving revision 1.1.2.6
retrieving revision 1.1.2.7
diff -u -3 -r1.1.2.6 -r1.1.2.7
--- ecore_x_window.c 25 Feb 2003 04:32:27 -0000 1.1.2.6
+++ ecore_x_window.c 27 Feb 2003 01:58:14 -0000 1.1.2.7
@@ -3,15 +3,16 @@
#include "Ecore_X.h"
/**
- * Create a window
- * @param parent
- * @param x
- * @param y
- * @param w
- * @param h
+ * Create a new window.
+ * @param parent The parent window
+ * @param x X
+ * @param y Y
+ * @param w Width
+ * @param h Height
* @return The new window handle
*
* Create a new window
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Window
ecore_x_window_new(Window parent, int x, int y, int w, int h)
@@ -58,15 +59,16 @@
}
/**
- * Create a window
- * @param parent
- * @param x
- * @param y
- * @param w
- * @param h
+ * Create a window.
+ * @param parent The parent window
+ * @param x X
+ * @param y Y
+ * @param w Width
+ * @param h Height
* @return The new window handle
*
* Create a new window
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Window
ecore_x_window_override_new(Window parent, int x, int y, int w, int h)
@@ -113,10 +115,11 @@
}
/**
- * Delete a window
- * @param win
+ * Delete a window.
+ * @param win The window to delete
*
* Delete a window
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_window_del(Window win)
@@ -125,10 +128,11 @@
}
/**
- * Show a window
- * @param win
+ * Show a window.
+ * @param win The window to show
*
* Show a window
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_window_show(Window win)
@@ -138,9 +142,10 @@
/**
* Hide a window
- * @param win
+ * @param win The window to hide
*
* Hide a window
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_window_hide(Window win)
@@ -149,12 +154,13 @@
}
/**
- * Move a window
- * @param win
- * @param x
- * @param y
+ * Move a window.
+ * @param win The window to move
+ * @param x X
+ * @param y Y
*
* Move a window to @p x, @p y
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_window_move(Window win, int x, int y)
@@ -163,12 +169,13 @@
}
/**
- * Resize a window
- * @param win
- * @param w
- * @param h
+ * Resize a window.
+ * @param win The window to resize
+ * @param w Width
+ * @param h Height
*
* Resize a window to @p w x @p h
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_window_resize(Window win, int w, int h)
@@ -179,14 +186,15 @@
}
/**
- * Move and resize a window
- * @param win
- * @param x
- * @param y
- * @param w
- * @param h
+ * Move and resize a window.
+ * @param win The window to move and resize
+ * @param x X
+ * @param y Y
+ * @param w Width
+ * @param h Height
*
* Move a window to @p x, @p y and resize it to @p w x @p h
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_window_move_resize(Window win, int x, int y, int w, int h)
@@ -197,10 +205,11 @@
}
/**
- * Set the focus to the window
- * @param win
+ * Set the focus to the window.
+ * @param win The window to focus
*
* Set the focus to the window @p win
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_window_focus(Window win)
@@ -210,11 +219,12 @@
}
/**
- * Set the focus to the window at a specific time
- * @param win
- * @param t
+ * Set the focus to the window at a specific time.
+ * @param win The window to focus
+ * @param t When
*
* Set the focus to the window @p win at time @p t
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_window_focus_at_time(Window win, Time t)
@@ -224,10 +234,11 @@
}
/**
- * Raise window
- * @param win
+ * Raise window.
+ * @param win The window to raise
*
* Raise window @p win
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_window_raise(Window win)
@@ -236,10 +247,11 @@
}
/**
- * Lower window
- * @param win
+ * Lower window.
+ * @param win The window to lower
*
* Lower window @p win
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_window_lower(Window win)
@@ -248,13 +260,14 @@
}
/**
- * Reparent a window
- * @param win
- * @param new_parent
- * @param x
- * @param y
+ * Reparent a window.
+ * @param win The window to reparent
+ * @param new_parent The new parent window
+ * @param x X
+ * @param y Y
*
* Reparent @p win to the parent @p new_parent at @p x, @p y
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_window_reparent(Window win, Window new_parent, int x, int y)
===================================================================
RCS file:
/cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore_x/Attic/ecore_x_window_prop.c,v
retrieving revision 1.1.2.5
retrieving revision 1.1.2.6
diff -u -3 -r1.1.2.5 -r1.1.2.6
--- ecore_x_window_prop.c 12 Feb 2003 23:29:44 -0000 1.1.2.5
+++ ecore_x_window_prop.c 27 Feb 2003 01:58:14 -0000 1.1.2.6
@@ -26,11 +26,12 @@
}
/**
- * Set a window title
- * @param win
- * @param t
+ * Set a window title.
+ * @param win The window
+ * @param t The title string
*
* Set a window title
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_window_prop_title_set(Window win, const char *t)
@@ -39,11 +40,12 @@
}
/**
- * Get a window title
- * @param win
- * @return The windows title
+ * Get a window title.
+ * @param win The window
+ * @return The windows title string
*
* Return the title of a window. String must be free'd when done with.
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
char *
ecore_x_window_prop_title_get(Window win)
@@ -77,12 +79,13 @@
}
/**
- * Set a window name & class
- * @param win
- * @param n
- * @param c
+ * Set a window name & class.
+ * @param win The window
+ * @param n The name string
+ * @param c The class string
*
* Set a window name * class
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_window_prop_name_class_set(Window win, const char *n, const char *c)
@@ -98,13 +101,14 @@
}
/**
- * Get a window name & class
- * @param win
- * @param n
- * @param c
+ * Get a window name & class.
+ * @param win The window
+ * @param n Name string
+ * @param c Class string
*
* Get a windows name and class property. strings must be free'd when done
* with.
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_window_prop_name_class_get(Window win, char **n, char **c)
@@ -129,12 +133,13 @@
}
/**
- * Set a window property to get message for close
- * @param win
- * @param on
+ * Set a window property to get message for close.
+ * @param win The window
+ * @param on On/Off
*
* Set a window porperty to let a window manager send a delete message instead
* of just closing (destroying) the window.
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_x_window_prop_delete_request_set(Window win, int on)
-------------------------------------------------------
This SF.net email is sponsored by: Scholarships for Techies!
Can't afford IT training? All 2003 ictp students receive scholarships.
Get hands-on training in Microsoft, Cisco, Sun, Linux/UNIX, and more.
www.ictp.com/training/sourceforge.asp
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
