vtorri
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

More documentation patches from Nicholas Curran. 

Added a couple includes to fix builds on minimal systems.


SVN revision: 10841
This commit is contained in:
rbdpngn 2004-07-15 13:43:15 +00:00 committed by rbdpngn
parent d452320abe
commit 7363ea82b1
10 changed files with 264 additions and 210 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
legacy/ecore/src/lib/ecore/ecore_list.c
View File

@ -437,7 +437,7 @@ static int _ecore_list_prepend_0(Ecore_List * list, Ecore_List_Node *start)
} }
/** /**
* Insert data at the current point in the list. * Insert data in front of the current point in the list.
* @param list The list to hold the inserted @p data. * @param list The list to hold the inserted @p data.
* @param data The data to insert into @p list. * @param data The data to insert into @p list.
* @return @c FALSE if there is an error, @c TRUE on success * @return @c FALSE if there is an error, @c TRUE on success

123
legacy/ecore/src/lib/ecore_con/ecore_con.c
View File

@ -47,9 +47,9 @@ static int init_count = 0;
#define LENGTH_OF_SOCKADDR_UN(s) (strlen((s)->sun_path) + (size_t)(((struct sockaddr_un *)NULL)->sun_path)) #define LENGTH_OF_SOCKADDR_UN(s) (strlen((s)->sun_path) + (size_t)(((struct sockaddr_un *)NULL)->sun_path))
/** /**
* To be documented. * Initialises the Ecore_Con library.
* * @return Number of times the library has been initialised without being
* FIXME: To be fixed. * shut down.
*/ */
int int
ecore_con_init(void) ecore_con_init(void)
@ -73,9 +73,9 @@ ecore_con_init(void)
} }
/** /**
* To be documented. * Shuts down the Ecore_Con library.
* * @return Number of times the library has been initialised without being
* FIXME: To be fixed. * shut down.
*/ */
int int
ecore_con_shutdown(void) ecore_con_shutdown(void)
@ -90,9 +90,29 @@ ecore_con_shutdown(void)
} }
/** /**
* To be documented. * Creates a server to listen for connections.
* *
* FIXME: To be fixed. * The socket on which the server listens depends on the connection
* type:
* @li If @a compl_type is @c ECORE_CON_LOCAL_USER, the server will listen on
* the Unix socket "~/.ecore/[name]/[port]".
* @li If @a compl_type is @c ECORE_CON_LOCAL_SYSTEM, the server will listen
* on Unix socket "/tmp/.ecore_service|[name]|[port]".
* @li If @a compl_type is @c ECORE_CON_REMOTE_SYSTEM, the server will listen
* on TCP port @c port.
*
* @param compl_type The connection type.
* @param name Name to associate with the socket. It is used when
* generating the socket name of a Unix socket. Though
* it is not used for the TCP socket, it still needs to
* be a valid character array. @c NULL will not be
* accepted.
* @param port Number to identify socket. When a Unix socket is used,
* it becomes part of the socket name. When a TCP socket
* is used, it is used as the TCP port.
* @param data Data to associate with the created Ecore_Con_Server
* object.
* @return A new Ecore_Con_Server.
*/ */
Ecore_Con_Server * Ecore_Con_Server *
ecore_con_server_add(Ecore_Con_Type compl_type, ecore_con_server_add(Ecore_Con_Type compl_type,
@ -287,9 +307,30 @@ ecore_con_server_add(Ecore_Con_Type compl_type,
} }
/** /**
* To be documented. * Creates a server object to represent the server listening at the
* given port.
* *
* FIXME: To be fixed. * The socket to which the server connects depends on the connection type:
* @li If @a compl_type is @c ECORE_CON_LOCAL_USER, the function will
* connect to the server listening on the Unix socket
* "~/.ecore/[name]/[port]".
* @li If @a compl_type is @c ECORE_CON_LOCAL_SYSTEM, the function will
* connect to the server listening on the Unix socket
* "/tmp/.ecore_service|[name]|[port]".
* @li If @a compl_type is @c ECORE_CON_REMOTE_SYSTEM, the function will
* connect to the server listening on the TCP port "[name]:[port]".
*
* @param compl_type The connection type.
* @param name Name used when determining what socket to connect to.
* It is used to generate the socket name when the socket
* is a Unix socket. It is used as the hostname when
* connecting with a TCP socket.
* @param port Number to identify socket to connect to. Used when
* generating the socket name for a Unix socket, or as the
* TCP port when connecting to a TCP socket.
* @param data Data to associate with the created Ecore_Con_Server
* object.
* @return A new Ecore_Con_Server.
*/ */
Ecore_Con_Server * Ecore_Con_Server *
ecore_con_server_connect(Ecore_Con_Type compl_type, ecore_con_server_connect(Ecore_Con_Type compl_type,
@ -436,9 +477,9 @@ ecore_con_server_connect(Ecore_Con_Type compl_type,
} }
/** /**
* To be documented. * Closes the connection and frees the given server.
* * @param svr The given server.
* FIXME: To be fixed. * @return Data associated with the server when it was created.
*/ */
void * void *
ecore_con_server_del(Ecore_Con_Server *svr) ecore_con_server_del(Ecore_Con_Server *svr)
@ -457,9 +498,9 @@ ecore_con_server_del(Ecore_Con_Server *svr)
} }
/** /**
* To be documented. * Retrieves the data associated with the given server.
* * @param svr The given server.
* FIXME: To be fixed. * @return The associated data.
*/ */
void * void *
ecore_con_server_data_get(Ecore_Con_Server *svr) ecore_con_server_data_get(Ecore_Con_Server *svr)
@ -474,9 +515,10 @@ ecore_con_server_data_get(Ecore_Con_Server *svr)
} }
/** /**
* To be documented. * Retrieves whether the given server is currently connected.
* * @todo Check that this function does what the documenter believes it does.
* FIXME: To be fixed. * @param svr The given server.
* @return @c 1 if the server is connected. @c 0 otherwise.
*/ */
int int
ecore_con_server_connected_get(Ecore_Con_Server *svr) ecore_con_server_connected_get(Ecore_Con_Server *svr)
@ -492,9 +534,12 @@ ecore_con_server_connected_get(Ecore_Con_Server *svr)
} }
/** /**
* To be documented. * Sends the given data to the given server.
* * @param svr The given server.
* FIXME: To be fixed. * @param data The given data.
* @param size Length of the data, in bytes, to send.
* @return The number of bytes sent. @c 0 will be returned if there is an
* error.
*/ */
int int
ecore_con_server_send(Ecore_Con_Server *svr, void *data, int size) ecore_con_server_send(Ecore_Con_Server *svr, void *data, int size)
@ -530,9 +575,12 @@ ecore_con_server_send(Ecore_Con_Server *svr, void *data, int size)
} }
/** /**
* To be documented. * Sends the given data to the given client.
* * @param cl The given client.
* FIXME: To be fixed. * @param data The given data.
* @param size Length of the data, in bytes, to send.
* @return The number of bytes sent. @c 0 will be returned if there is an
* error.
*/ */
int int
ecore_con_client_send(Ecore_Con_Client *cl, void *data, int size) ecore_con_client_send(Ecore_Con_Client *cl, void *data, int size)
@ -568,9 +616,10 @@ ecore_con_client_send(Ecore_Con_Client *cl, void *data, int size)
} }
/** /**
* To be documented. * Retrieves the server representing the socket the client has
* * connected to.
* FIXME: To be fixed. * @param cl The given client.
* @return The server that the client connected to.
*/ */
Ecore_Con_Server * Ecore_Con_Server *
ecore_con_client_server_get(Ecore_Con_Client *cl) ecore_con_client_server_get(Ecore_Con_Client *cl)
@ -585,9 +634,9 @@ ecore_con_client_server_get(Ecore_Con_Client *cl)
} }
/** /**
* To be documented. * Closes the connection and frees memory allocated to the given client.
* * @param cl The given client.
* FIXME: To be fixed. * @return Data associated with the client.
*/ */
void * void *
ecore_con_client_del(Ecore_Con_Client *cl) ecore_con_client_del(Ecore_Con_Client *cl)
@ -606,9 +655,9 @@ ecore_con_client_del(Ecore_Con_Client *cl)
} }
/** /**
* To be documented. * Sets the data associated with the given client to @p data.
* * @param cl The given client.
* FIXME: To be fixed. * @param data What to set the data to.
*/ */
void void
ecore_con_client_data_set(Ecore_Con_Client *cl, const void *data) ecore_con_client_data_set(Ecore_Con_Client *cl, const void *data)
@ -623,9 +672,9 @@ ecore_con_client_data_set(Ecore_Con_Client *cl, const void *data)
} }
/** /**
* To be documented. * Retrieves the data associated with the given client.
* * @param cl The given client.
* FIXME: To be fixed. * @return The data associated with @p cl.
*/ */
void * void *
ecore_con_client_data_get(Ecore_Con_Client *cl) ecore_con_client_data_get(Ecore_Con_Client *cl)

2
legacy/ecore/src/lib/ecore_config/convenience.c
View File

@ -445,7 +445,7 @@ ecore_config_theme_with_path_from_name_get(char *name)
/** /**
* Get a theme files full path, as it is found according to the search path. * Get a theme files full path, as it is found according to the search path.
* The theme searched for is stored in the property @key. * The theme searched for is stored in the property @p key.
* The search path is defined by ecore_config_theme_search_path_get(). * The search path is defined by ecore_config_theme_search_path_get().
* @param key The property containing the theme name to search for. * @param key The property containing the theme name to search for.
* @return A full path to the theme on sucess, or NULL on failure (no key specified or * @return A full path to the theme on sucess, or NULL on failure (no key specified or

1
legacy/ecore/src/lib/ecore_config/ecore_config.c
View File

@ -7,6 +7,7 @@
#include <stdio.h> #include <stdio.h>
#include <stdlib.h> #include <stdlib.h>
#include <sys/param.h>
#include <sys/types.h> #include <sys/types.h>
#include <sys/stat.h> #include <sys/stat.h>
#include <fcntl.h> #include <fcntl.h>

1
legacy/ecore/src/lib/ecore_config/edb.c
View File

@ -8,6 +8,7 @@
#include <string.h> #include <string.h>
#include <limits.h> #include <limits.h>
#include <sys/param.h>
#include <sys/types.h> #include <sys/types.h>
#include <sys/stat.h> #include <sys/stat.h>
#include <unistd.h> #include <unistd.h>

1
legacy/ecore/src/lib/ecore_config/ipc_main.c
View File

@ -12,6 +12,7 @@
#include <dlfcn.h> #include <dlfcn.h>
#include <stdio.h> #include <stdio.h>
#include <glob.h> #include <glob.h>
#include <sys/param.h>
#include <limits.h> #include <limits.h>
#include <string.h> #include <string.h>
#include <stdlib.h> /* malloc(), free() */ #include <stdlib.h> /* malloc(), free() */

98
legacy/ecore/src/lib/ecore_fb/ecore_fb.c
View File

@ -375,11 +375,9 @@ static char *_ecore_fb_btn_syms[128] =
}; };
/** /**
* Set up the ecore fb system. * Sets up the Ecore_Fb library.
* @param name device target name * @param name device target name
* @return 0 on failure, or greter than 0 on success. * @return @c 0 on failure, greater than @c 0 on success.
*
* This starts up the ecore fb system
*/ */
int int
ecore_fb_init(const char *name) ecore_fb_init(const char *name)
@ -510,10 +508,9 @@ ecore_fb_init(const char *name)
} }
/** /**
* Shut down the ecore fb system. * Shuts down the Ecore_Fb library.
* @return 0 if the system was shut down, or 1 if it still needs to be shut down * @return @c 0 if the system was shut * down, or 1 if it still needs to
* * be shut down
* This shuts down the ecore fb system.
*/ */
int int
ecore_fb_shutdown(void) ecore_fb_shutdown(void)
@ -558,12 +555,13 @@ ecore_fb_shutdown(void)
} }
/** /**
* Set the timeout for double/triple click to be flagged. * Sets the timeout for a double and triple clicks 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, the triple_click flag is also set.
* *
* This sets the time between clicks before the double_click flag is set in a * @param t The time in seconds
* button down event. If 3 clicks occur within double this time then the
* triple_click flag is also set.
*/ */
void void
ecore_fb_double_click_time_set(double t) ecore_fb_double_click_time_set(double t)
@ -573,10 +571,11 @@ ecore_fb_double_click_time_set(double t)
} }
/** /**
* Get the double/triple click timeout. * Retrieves the double and triple click flag timeout.
* @return The timeout for double clicks in seconds
* *
* This returns the tiemout that can be set by ecore_fb_double_click_time_set() * See @ref ecore_x_double_click_time_set for more information.
*
* @return The timeout for double clicks in seconds.
*/ */
double double
ecore_fb_double_click_time_get(void) ecore_fb_double_click_time_get(void)
@ -585,11 +584,9 @@ ecore_fb_double_click_time_get(void)
} }
/** /**
* Get the current fb width and height in pixels. * Retrieves the width and height of the current frame buffer in pixels.
* @param w Width in pixels * @param w Pointer to an integer in which to store the width.
* @param h Height in pixels * @param h Pointer to an interge in which to store the height.
*
* Get the current fb width and height in pixels
*/ */
void void
ecore_fb_size_get(int *w, int *h) ecore_fb_size_get(int *w, int *h)
@ -599,14 +596,12 @@ ecore_fb_size_get(int *w, int *h)
} }
/** /**
* Calibrate the touschreen. * Calibrates the touschreen using the given parameters.
* @param xscale X scaling (256 = 1.0) * @param xscale X scaling, where 256 = 1.0
* @param xtrans X translation * @param xtrans X translation.
* @param yscale Y scaling * @param yscale Y scaling.
* @param ytrans Y translation * @param ytrans Y translation.
* @param xyswap Swap X & Y flag * @param xyswap Swap X & Y flag.
*
* Calibrate the touchscreen using the above params
*/ */
void void
ecore_fb_touch_screen_calibrate_set(int xscale, int xtrans, int yscale, int ytrans, int xyswap) ecore_fb_touch_screen_calibrate_set(int xscale, int xtrans, int yscale, int ytrans, int xyswap)
@ -623,14 +618,13 @@ ecore_fb_touch_screen_calibrate_set(int xscale, int xtrans, int yscale, int ytra
} }
/** /**
* Get calibratio og the touschreen. * Retrieves the calibration parameters of the touchscreen.
* @param xscale X scaling (256 = 1.0) * @param xscale Pointer to an integer in which to store the X scaling.
* @param xtrans X translation * Note that 256 = 1.0.
* @param yscale Y scaling * @param xtrans Pointer to an integer in which to store the X translation.
* @param ytrans Y translation * @param yscale Pointer to an integer in which to store the Y scaling.
* @param xyswap Swap X & Y flag * @param ytrans Pointer to an integer in which to store the Y translation.
* * @param xyswap Pointer to an integer in which to store the Swap X & Y flag.
* Get calibration of the touchscreen
*/ */
void void
ecore_fb_touch_screen_calibrate_get(int *xscale, int *xtrans, int *yscale, int *ytrans, int *xyswap) ecore_fb_touch_screen_calibrate_get(int *xscale, int *xtrans, int *yscale, int *ytrans, int *xyswap)
@ -647,10 +641,8 @@ ecore_fb_touch_screen_calibrate_get(int *xscale, int *xtrans, int *yscale, int *
} }
/** /**
* Set the backlight. * Turns on or off the backlight.
* @param on 1 or 0 corresponding to on or off * @param on @c 1 to turn the backlight on. @c 0 to turn it off.
*
* Set the backlight to the @p on state
*/ */
void void
ecore_fb_backlight_set(int on) ecore_fb_backlight_set(int on)
@ -664,10 +656,8 @@ ecore_fb_backlight_set(int on)
} }
/** /**
* Get the backlight state. * Retrieves the backlight state.
* @return The current backlight state * @return Whether the backlight is on.
*
* Get the current backlight state
*/ */
int int
ecore_fb_backlight_get(void) ecore_fb_backlight_get(void)
@ -680,11 +670,9 @@ ecore_fb_backlight_get(void)
} }
/** /**
* Set the backlight brightness. * Sets the backlight brightness.
* @param br Brightness 0.0 to 1.0 * @param br Brightness between 0.0 to 1.0, where 0.0 is darkest and 1.0
* * is brightest.
* Set the backglith brightness to @p br, where 0 is darkest and 1.0 is
* the brightest.
*/ */
void void
ecore_fb_backlight_brightness_set(double br) ecore_fb_backlight_brightness_set(double br)
@ -701,11 +689,9 @@ ecore_fb_backlight_brightness_set(double br)
} }
/** /**
* Get the backlight brightness. * Retrieves the backlight brightness.
* @return The current backlight brigntess * @return The current backlight brigntess, where 0.0 is the darkest and
* * 1.0 is the brightest.
* Get the current backlight brightness as per
* ecore_fb_backlight_brightness_set().
*/ */
double double
ecore_fb_backlight_brightness_get(void) ecore_fb_backlight_brightness_get(void)

27
legacy/ecore/src/lib/ecore_x/ecore_x.c
View File

@ -541,7 +541,7 @@ ecore_x_fd_get(void)
} }
/** /**
* Set the timeout for a double and triple clicks to be flagged. * Sets the timeout for a double and triple clicks to be flagged.
* *
* This sets the time between clicks before the double_click flag is * 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 * set in a button down event. If 3 clicks occur within double this
@ -558,7 +558,7 @@ ecore_x_double_click_time_set(double t)
} }
/** /**
* Get the double and triple click flag timeout. * Retrieves the double and triple click flag timeout.
* *
* See @ref ecore_x_double_click_time_set for more information. * See @ref ecore_x_double_click_time_set for more information.
* *
@ -780,6 +780,14 @@ _ecore_x_event_filter_end(void *data, void *loop_data)
/* FIXME: these funcs need categorising */ /* FIXME: these funcs need categorising */
/*****************************************************************************/ /*****************************************************************************/
/**
* Retrieves the geometry of the given drawable.
* @param d The given drawable.
* @param x Pointer to an integer into which the X position is to be stored.
* @param y Pointer to an integer into which the Y position is to be stored.
* @param w Pointer to an integer into which the width is to be stored.
* @param h Pointer to an integer into which the height is to be stored.
*/
void void
ecore_x_drawable_geometry_get(Ecore_X_Drawable d, int *x, int *y, int *w, int *h) ecore_x_drawable_geometry_get(Ecore_X_Drawable d, int *x, int *y, int *w, int *h)
{ {
@ -802,6 +810,11 @@ ecore_x_drawable_geometry_get(Ecore_X_Drawable d, int *x, int *y, int *w, int *h
if (h) *h = (int) ret_h; if (h) *h = (int) ret_h;
} }
/**
* Retrieves the width of the border of the given drawable.
* @param d The given drawable.
* @return The border width of the given drawable.
*/
int int
ecore_x_drawable_border_width_get(Ecore_X_Drawable d) ecore_x_drawable_border_width_get(Ecore_X_Drawable d)
{ {
@ -816,6 +829,11 @@ ecore_x_drawable_border_width_get(Ecore_X_Drawable d)
return (int) border_ret; return (int) border_ret;
} }
/**
* Retrieves the depth of the given drawable.
* @param d The given drawable.
* @return The depth of the given drawable.
*/
int int
ecore_x_drawable_depth_get(Ecore_X_Drawable d) ecore_x_drawable_depth_get(Ecore_X_Drawable d)
{ {
@ -936,6 +954,11 @@ ecore_x_window_client_sniff(Ecore_X_Window win)
StructureNotifyMask); StructureNotifyMask);
} }
/**
* Retrieves the atom value associated with the given name.
* @param name The given name.
* @return Associated atom value.
*/
Ecore_X_Atom Ecore_X_Atom
ecore_x_atom_get(char *name) ecore_x_atom_get(char *name)
{ {

13
legacy/ecore/src/lib/ecore_x/ecore_x_gc.c
View File

@ -3,9 +3,11 @@
#include "Ecore_X.h" #include "Ecore_X.h"
/** /**
* To be documented. * Creates a new default graphics context associated with the given
* * drawable.
* FIXME: To be fixed. * @param draw Drawable to create graphics context with. If @c 0 is
* given instead, the default root window is used.
* @return The new default graphics context.
*/ */
Ecore_X_GC Ecore_X_GC
ecore_x_gc_new(Ecore_X_Drawable draw) ecore_x_gc_new(Ecore_X_Drawable draw)
@ -17,9 +19,8 @@ ecore_x_gc_new(Ecore_X_Drawable draw)
} }
/** /**
* To be documented. * Deletes and frees the given graphics context.
* * @param gc The given graphics context.
* FIXME: To be fixed.
*/ */
void void
ecore_x_gc_del(Ecore_X_GC gc) ecore_x_gc_del(Ecore_X_GC gc)

206
legacy/ecore/src/lib/ecore_x/ecore_x_window.c
View File

@ -3,15 +3,14 @@
#include "Ecore_X.h" #include "Ecore_X.h"
/** /**
* Create a new window. * Creates a new window.
* @param parent The parent window * @param parent The parent window to use. If @p parent is @c 0, the root
* @param x X * window of the default display is used.
* @param y Y * @param x X position.
* @param w Width * @param y Y position.
* @param h Height * @param w Width.
* @return The new window handle * @param h Height.
* * @return The new window handle.
* Create a new window
*/ */
Ecore_X_Window Ecore_X_Window
ecore_x_window_new(Ecore_X_Window parent, int x, int y, int w, int h) ecore_x_window_new(Ecore_X_Window parent, int x, int y, int w, int h)
@ -60,15 +59,14 @@ ecore_x_window_new(Ecore_X_Window parent, int x, int y, int w, int h)
} }
/** /**
* Create a window. * Create a window with the override redirect attribute set to @c True.
* @param parent The parent window * @param parent The parent window to use. If @p parent is @c 0, the root
* @param x X * window of the default display is used.
* @param y Y * @param x X position.
* @param w Width * @param y Y position.
* @param h Height * @param w Width.
* @return The new window handle * @param h Height.
* * @return The new window handle.
* Create a new window
*/ */
Ecore_X_Window Ecore_X_Window
ecore_x_window_override_new(Ecore_X_Window parent, int x, int y, int w, int h) ecore_x_window_override_new(Ecore_X_Window parent, int x, int y, int w, int h)
@ -117,15 +115,14 @@ ecore_x_window_override_new(Ecore_X_Window parent, int x, int y, int w, int h)
} }
/** /**
* Create a window. * Create a new input window.
* @param parent The parent window * @param parent The parent window to use. If @p parent is @c 0, the root
* @param x X * window of the default display is used.
* @param y Y * @param x X position.
* @param w Width * @param y Y position.
* @param h Height * @param w Width.
* @return The new window handle * @param h Height.
* * @return The new window.
* Create a new window
*/ */
Ecore_X_Window Ecore_X_Window
ecore_x_window_input_new(Ecore_X_Window parent, int x, int y, int w, int h) ecore_x_window_input_new(Ecore_X_Window parent, int x, int y, int w, int h)
@ -166,10 +163,12 @@ ecore_x_window_input_new(Ecore_X_Window parent, int x, int y, int w, int h)
} }
/** /**
* Set defaults for a window * Sets the default properties for the given window.
* @param win The window to set defaults
* *
* Set defaults for a window * The default properties set for the window are @c WM_CLIENT_MACHINE and
* @c _NET_WM_PID.
*
* @param win The given window.
*/ */
void void
ecore_x_window_defaults_set(Ecore_X_Window win) ecore_x_window_defaults_set(Ecore_X_Window win)
@ -211,10 +210,8 @@ ecore_x_window_defaults_set(Ecore_X_Window win)
} }
/** /**
* Delete a window. * Deletes a window.
* @param win The window to delete * @param win The window to delete.
*
* Delete a window
*/ */
void void
ecore_x_window_del(Ecore_X_Window win) ecore_x_window_del(Ecore_X_Window win)
@ -223,10 +220,11 @@ ecore_x_window_del(Ecore_X_Window win)
} }
/** /**
* Show a window. * Shows a window.
* @param win The window to show *
* * Synonymous to "mapping" a window in X Window System terminology.
* Show a window *
* @param win The window to show.
*/ */
void void
ecore_x_window_show(Ecore_X_Window win) ecore_x_window_show(Ecore_X_Window win)
@ -235,10 +233,11 @@ ecore_x_window_show(Ecore_X_Window win)
} }
/** /**
* Hide a window * Hides a window.
* @param win The window to hide *
* * Synonymous to "unmapping" a window in X Window System terminology.
* Hide a window *
* @param win The window to hide.
*/ */
void void
ecore_x_window_hide(Ecore_X_Window win) ecore_x_window_hide(Ecore_X_Window win)
@ -247,12 +246,14 @@ ecore_x_window_hide(Ecore_X_Window win)
} }
/** /**
* Move a window. * Moves a window to the position @p x, @p y.
* @param win The window to move *
* @param x X * The position is relative to the upper left hand corner of the
* @param y Y * parent window.
* *
* Move a window to @p x, @p y * @param win The window to move.
* @param x X position.
* @param y Y position.
*/ */
void void
ecore_x_window_move(Ecore_X_Window win, int x, int y) ecore_x_window_move(Ecore_X_Window win, int x, int y)
@ -261,12 +262,10 @@ ecore_x_window_move(Ecore_X_Window win, int x, int y)
} }
/** /**
* Resize a window. * Resizes a window.
* @param win The window to resize * @param win The window to resize.
* @param w Width * @param w New width of the window.
* @param h Height * @param h New height of the window.
*
* Resize a window to @p w x @p h
*/ */
void void
ecore_x_window_resize(Ecore_X_Window win, int w, int h) ecore_x_window_resize(Ecore_X_Window win, int w, int h)
@ -277,14 +276,12 @@ ecore_x_window_resize(Ecore_X_Window win, int w, int h)
} }
/** /**
* Move and resize a window. * Moves and resizes a window.
* @param win The window to move and resize * @param win The window to move and resize.
* @param x X * @param x New X position of the window.
* @param y Y * @param y New Y position of the window.
* @param w Width * @param w New width of the window.
* @param h Height * @param h New height of the window.
*
* Move a window to @p x, @p y and resize it to @p w x @p h
*/ */
void void
ecore_x_window_move_resize(Ecore_X_Window win, int x, int y, int w, int h) ecore_x_window_move_resize(Ecore_X_Window win, int x, int y, int w, int h)
@ -295,10 +292,8 @@ ecore_x_window_move_resize(Ecore_X_Window win, int x, int y, int w, int h)
} }
/** /**
* Set the focus to the window. * Sets the focus to the window @p win.
* @param win The window to focus * @param win The window to focus.
*
* Set the focus to the window @p win
*/ */
void void
ecore_x_window_focus(Ecore_X_Window win) ecore_x_window_focus(Ecore_X_Window win)
@ -308,11 +303,9 @@ ecore_x_window_focus(Ecore_X_Window win)
} }
/** /**
* Set the focus to the window at a specific time. * Sets the focus to the given window at a specific time.
* @param win The window to focus * @param win The window to focus.
* @param t When * @param t When to set the focus to the window.
*
* Set the focus to the window @p win at time @p t
*/ */
void void
ecore_x_window_focus_at_time(Ecore_X_Window win, Ecore_X_Time t) ecore_x_window_focus_at_time(Ecore_X_Window win, Ecore_X_Time t)
@ -322,10 +315,8 @@ ecore_x_window_focus_at_time(Ecore_X_Window win, Ecore_X_Time t)
} }
/** /**
* Raise window. * Raises the given window.
* @param win The window to raise * @param win The window to raise.
*
* Raise window @p win
*/ */
void void
ecore_x_window_raise(Ecore_X_Window win) ecore_x_window_raise(Ecore_X_Window win)
@ -334,10 +325,8 @@ ecore_x_window_raise(Ecore_X_Window win)
} }
/** /**
* Lower window. * Lowers the given window.
* @param win The window to lower * @param win The window to lower.
*
* Lower window @p win
*/ */
void void
ecore_x_window_lower(Ecore_X_Window win) ecore_x_window_lower(Ecore_X_Window win)
@ -346,13 +335,11 @@ ecore_x_window_lower(Ecore_X_Window win)
} }
/** /**
* Reparent a window. * Moves a window to within another window at a given position.
* @param win The window to reparent * @param win The window to reparent.
* @param new_parent The new parent window * @param new_parent The new parent window.
* @param x X * @param x X position within new parent window.
* @param y Y * @param y Y position within new parent window.
*
* Reparent @p win to the parent @p new_parent at @p x, @p y
*/ */
void void
ecore_x_window_reparent(Ecore_X_Window win, Ecore_X_Window new_parent, int x, int y) ecore_x_window_reparent(Ecore_X_Window win, Ecore_X_Window new_parent, int x, int y)
@ -362,9 +349,10 @@ ecore_x_window_reparent(Ecore_X_Window win, Ecore_X_Window new_parent, int x, in
} }
/** /**
* To be documented. * Retrieves the size of the given window.
* * @param win The given window.
* FIXME: To be fixed. * @param w Pointer to an integer into which the width is to be stored.
* @param h Pointer to an integer into which the height is to be stored.
*/ */
void void
ecore_x_window_size_get(Ecore_X_Window win, int *w, int *h) ecore_x_window_size_get(Ecore_X_Window win, int *w, int *h)
@ -378,9 +366,12 @@ ecore_x_window_size_get(Ecore_X_Window win, int *w, int *h)
} }
/** /**
* To be documented. * Retrieves the geometry of the given window.
* * @param win The given window.
* FIXME: To be fixed. * @param x Pointer to an integer in which the X position is to be stored.
* @param y Pointer to an integer in which the Y position is to be stored.
* @param w Pointer to an integer in which the width is to be stored.
* @param h Pointer to an integer in which the height is to be stored.
*/ */
void void
ecore_x_window_geometry_get(Ecore_X_Window win, int *x, int *y, int *w, int *h) ecore_x_window_geometry_get(Ecore_X_Window win, int *x, int *y, int *w, int *h)
@ -392,9 +383,9 @@ ecore_x_window_geometry_get(Ecore_X_Window win, int *x, int *y, int *w, int *h)
} }
/** /**
* To be documented. * Retrieves the width of the border of the given window.
* * @param win The given window.
* FIXME: To be fixed. * @return Width of the border of @p win.
*/ */
int int
ecore_x_window_border_width_get(Ecore_X_Window win) ecore_x_window_border_width_get(Ecore_X_Window win)
@ -403,9 +394,9 @@ ecore_x_window_border_width_get(Ecore_X_Window win)
} }
/** /**
* To be documented. * Retrieves the depth of the given window.
* * @param win The given window.
* FIXME: To be fixed. * @return Depth of the window.
*/ */
int int
ecore_x_window_depth_get(Ecore_X_Window win) ecore_x_window_depth_get(Ecore_X_Window win)
@ -449,9 +440,9 @@ ecore_x_window_cursor_show(Ecore_X_Window win, int show)
} }
/** /**
* To be documented. * Finds out whether the given window is currently visible.
* * @param win The given window.
* FIXME: To be fixed. * @return 1 if the window is visible, otherwise 0.
*/ */
int int
ecore_x_window_visible_get(Ecore_X_Window win) ecore_x_window_visible_get(Ecore_X_Window win)
@ -502,9 +493,10 @@ _ecore_x_window_at_xy_get(Window base, int bx, int by, int x, int y)
} }
/** /**
* To be documented. * Retrieves the top, visible window at the given location.
* * @param x The given X position.
* FIXME: To be fixed. * @param y The given Y position.
* @return The window at that position.
*/ */
Ecore_X_Window Ecore_X_Window
ecore_x_window_at_xy_get(int x, int y) ecore_x_window_at_xy_get(int x, int y)
@ -523,9 +515,9 @@ ecore_x_window_at_xy_get(int x, int y)
} }
/** /**
* To be documented. * Retrieves the parent window of the given window.
* * @param win The given window.
* FIXME: To be fixed. * @return The parent window of @p win.
*/ */
Ecore_X_Window Ecore_X_Window
ecore_x_window_parent_get(Ecore_X_Window win) ecore_x_window_parent_get(Ecore_X_Window win)