More documentation, simplification, mode-ification, grouping.
SVN revision: 11202
This commit is contained in:
ncn
ncn
parent
9906390024
commit
cc94f7acc7
|
|
@ -6,9 +6,18 @@ Ecore_Path_Group *__ecore_path_group_find(char *name);
|
|||
Ecore_Path_Group *__ecore_path_group_find_id(int id);
|
||||
|
||||
/**
|
||||
* Create a new path group
|
||||
* @param group_name The name of the new group
|
||||
* @return 0 on error, the integer id of the new group on success.
|
||||
* @defgroup Ecore_Path_Group Path Group Functions
|
||||
*
|
||||
* Functions that make it easier to find a file in a set of search paths.
|
||||
*
|
||||
* @todo Give this a better description.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Creates a new path group.
|
||||
* @param group_name The name of the new group.
|
||||
* @return @c 0 on error, the integer id of the new group on success.
|
||||
* @ingroup Ecore_Path_Group
|
||||
*/
|
||||
int
|
||||
ecore_path_group_new(char *group_name)
|
||||
|
|
@ -40,9 +49,9 @@ ecore_path_group_new(char *group_name)
|
|||
}
|
||||
|
||||
/**
|
||||
* Destroy a previously created path group
|
||||
* @param group_id The unique identifier for the group
|
||||
* @return No value.
|
||||
* Destroys a previously created path group
|
||||
* @param group_id The unique identifier for the group.
|
||||
* @ingroup Ecore_Path_Group
|
||||
*/
|
||||
void
|
||||
ecore_path_group_del(int group_id)
|
||||
|
|
@ -65,10 +74,10 @@ ecore_path_group_del(int group_id)
|
|||
}
|
||||
|
||||
/**
|
||||
* Add a directory to be searched for files
|
||||
* @param group_id The unique identifier for the group to add the path
|
||||
* @param path The new path to be added to the group
|
||||
* @return No value.
|
||||
* Adds a directory to be searched for files.
|
||||
* @param group_id The unique identifier for the group to add the path.
|
||||
* @param path The new path to be added to the group.
|
||||
* @ingroup Ecore_Path_Group
|
||||
*/
|
||||
void
|
||||
ecore_path_group_add(int group_id, char *path)
|
||||
|
|
@ -89,12 +98,10 @@ ecore_path_group_add(int group_id, char *path)
|
|||
}
|
||||
|
||||
/**
|
||||
* Remove a directory to be searched for files
|
||||
* @param group_id The identifier for the group to remove @a path
|
||||
* @param path The path to be removed from @a group_id
|
||||
* @return No value.
|
||||
*
|
||||
* Removes @a path from the list of directories to search for files.
|
||||
* Removes the given directory from the given group.
|
||||
* @param group_id The identifier for the given group.
|
||||
* @param path The path of the directory to be removed.
|
||||
* @ingroup Ecore_Path_Group
|
||||
*/
|
||||
void
|
||||
ecore_path_group_remove(int group_id, char *path)
|
||||
|
|
@ -128,11 +135,12 @@ ecore_path_group_remove(int group_id, char *path)
|
|||
}
|
||||
|
||||
/**
|
||||
* Find a file in a group of paths
|
||||
* @param group_id The path group id to search for @a name
|
||||
* @param name The name of the file to find in the path group @a group_id
|
||||
* @return A pointer to a newly allocated path location of the found file
|
||||
* on success, NULL on failure.
|
||||
* Finds a file in a group of paths.
|
||||
* @param group_id The path group id to search.
|
||||
* @param name The name of the file to find.
|
||||
* @return A pointer to a newly allocated path location of the found file
|
||||
* on success. @c NULL on failure.
|
||||
* @ingroup Ecore_Path_Group
|
||||
*/
|
||||
char *
|
||||
ecore_path_group_find(int group_id, char *name)
|
||||
|
|
@ -165,10 +173,11 @@ ecore_path_group_find(int group_id, char *name)
|
|||
}
|
||||
|
||||
/**
|
||||
* Get a list of all available files in the path
|
||||
* @param group_id The identifier for the path to get all available files
|
||||
* @return A pointer to a newly allocated list of all files found in the paths
|
||||
* identified by @a group_id, NULL on failure.
|
||||
* Retrieves a list of all available files in the given path.
|
||||
* @param group_id The identifier for the given path.
|
||||
* @return A pointer to a newly allocated list of all files found in the paths
|
||||
* identified by @p group_id. @c NULL otherwise.
|
||||
* @ingroup Ecore_Path_Group
|
||||
*/
|
||||
Ecore_List *
|
||||
ecore_path_group_available(int group_id)
|
||||
|
|
|
|||
|
|
@ -3,10 +3,18 @@
|
|||
static Ecore_List *loaded_plugins = NULL;
|
||||
|
||||
/**
|
||||
* Load the specified plugin from the specified path group
|
||||
* @param group_id The path group to search for the plugin to load
|
||||
* @param plugin_name The name of the plugin to load
|
||||
* @return A pointer to the newly loaded plugin on success, NULL on failure.
|
||||
* @defgroup Ecore_Plugin Plugin Functions
|
||||
*
|
||||
* Functions that load modules of compiled code into memory.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Loads the specified plugin from the specified path group.
|
||||
* @param group_id The path group to search for the plugin to load
|
||||
* @param plugin_name The name of the plugin to load.
|
||||
* @return A pointer to the newly loaded plugin on success, @c NULL on
|
||||
* failure.
|
||||
* @ingroup Ecore_Plugin
|
||||
*/
|
||||
Ecore_Plugin *
|
||||
ecore_plugin_load(int group_id, char *plugin_name)
|
||||
|
|
@ -52,9 +60,9 @@ ecore_plugin_load(int group_id, char *plugin_name)
|
|||
}
|
||||
|
||||
/**
|
||||
* Unload the specified plugin
|
||||
* @param plugin The plugin to unload from memory
|
||||
* @return Returns no value.
|
||||
* Unloads the given plugin from memory.
|
||||
* @param plugin The given plugin.
|
||||
* @ingroup Ecore_Plugin
|
||||
*/
|
||||
void
|
||||
ecore_plugin_unload(Ecore_Plugin * plugin)
|
||||
|
|
@ -74,7 +82,11 @@ ecore_plugin_unload(Ecore_Plugin * plugin)
|
|||
}
|
||||
|
||||
/*
|
||||
* Lookup the specified symbol for the plugin
|
||||
* Searches for the specified symbol in the given plugin.
|
||||
* @param plugin The given plugin.
|
||||
* @param symbol_name The symbol to search for.
|
||||
* @return Address of the given symbol if successful. Otherwise, @c NULL.
|
||||
* @ingroup Ecore_Plugin
|
||||
*/
|
||||
void *
|
||||
ecore_plugin_call(Ecore_Plugin * plugin, char *symbol_name)
|
||||
|
|
|
|||
|
|
@ -3,9 +3,18 @@
|
|||
static Ecore_Hash *ecore_strings = NULL;
|
||||
|
||||
/**
|
||||
* Retrieve an instance of a string for use in an ecore
|
||||
* @param string The string to retrieve an instance
|
||||
* @return A pointer to a the string on success, NULL on failure.
|
||||
* @defgroup Ecore_String_Group String Instance Functions
|
||||
*
|
||||
* These functions allow you to store one copy of a string, and use it
|
||||
* throughout your program.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Retrieves an instance of a string for use in an ecore program.
|
||||
* @param string The string to retrieve an instance of.
|
||||
* @return A pointer to an instance of the string on success.
|
||||
* @c NULL on failure.
|
||||
* @ingroup Ecore_String_Group
|
||||
*/
|
||||
char *ecore_string_instance(char *string)
|
||||
{
|
||||
|
|
@ -44,12 +53,12 @@ char *ecore_string_instance(char *string)
|
|||
}
|
||||
|
||||
/**
|
||||
* Release an instance of a string
|
||||
* @param string The string to release an instance
|
||||
* @return No value.
|
||||
* Notes that the given string has lost an instance.
|
||||
*
|
||||
* It will free the string if no other instances are left.
|
||||
*
|
||||
* Marks the string as losing an instance, will free the string if no other
|
||||
* instances are present.
|
||||
* @param string The given string.
|
||||
* @ingroup Ecore_String_Group
|
||||
*/
|
||||
void ecore_string_release(char *string)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -3,9 +3,22 @@
|
|||
#include "Ecore_X.h"
|
||||
|
||||
/**
|
||||
* To be documented.
|
||||
* @defgroup Ecore_X_Pixmap_Group X Pixmap Functions
|
||||
*
|
||||
* FIXME: To be fixed.
|
||||
* Functions that operate on pixmaps.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Creates a new pixmap.
|
||||
* @param win Window used to determine which screen of the display the
|
||||
* pixmap should be created on. If 0, the default root window
|
||||
* is used.
|
||||
* @param w Width of the new pixmap.
|
||||
* @param h Height of the new pixmap.
|
||||
* @param dep Depth of the pixmap. If 0, the default depth of the default
|
||||
* screen is used.
|
||||
* @return New pixmap.
|
||||
* @ingroup Ecore_X_Pixmap_Group
|
||||
*/
|
||||
Ecore_X_Pixmap
|
||||
ecore_x_pixmap_new(Ecore_X_Window win, int w, int h, int dep)
|
||||
|
|
@ -16,9 +29,13 @@ ecore_x_pixmap_new(Ecore_X_Window win, int w, int h, int dep)
|
|||
}
|
||||
|
||||
/**
|
||||
* To be documented.
|
||||
* Deletes the reference to the given pixmap.
|
||||
*
|
||||
* FIXME: To be fixed.
|
||||
* If no other clients have a reference to the given pixmap, the server
|
||||
* will destroy it.
|
||||
*
|
||||
* @param pmap The given pixmap.
|
||||
* @ingroup Ecore_X_Pixmap_Group
|
||||
*/
|
||||
void
|
||||
ecore_x_pixmap_del(Ecore_X_Pixmap pmap)
|
||||
|
|
@ -27,9 +44,18 @@ ecore_x_pixmap_del(Ecore_X_Pixmap pmap)
|
|||
}
|
||||
|
||||
/**
|
||||
* To be documented.
|
||||
*
|
||||
* FIXME: To be fixed.
|
||||
* Pastes a rectangular area of the given pixmap onto the given drawable.
|
||||
* @param pmap The given pixmap.
|
||||
* @param dest The given drawable.
|
||||
* @param gc The graphics context which governs which operation will
|
||||
* be used to paste the area onto the drawable.
|
||||
* @param sx The X position of the area on the pixmap.
|
||||
* @param sy The Y position of the area on the pixmap.
|
||||
* @param w The width of the area.
|
||||
* @param h The height of the area.
|
||||
* @param dx The X position at which to paste the area on @p dest.
|
||||
* @param dy The Y position at which to paste the area on @p dest.
|
||||
* @ingroup Ecore_X_Pixmap_Group
|
||||
*/
|
||||
void
|
||||
ecore_x_pixmap_paste(Ecore_X_Pixmap pmap, Ecore_X_Drawable dest,
|
||||
|
|
@ -40,9 +66,13 @@ ecore_x_pixmap_paste(Ecore_X_Pixmap pmap, Ecore_X_Drawable dest,
|
|||
}
|
||||
|
||||
/**
|
||||
* To be documented.
|
||||
*
|
||||
* FIXME: To be fixed.
|
||||
* Retrieves the size of the given pixmap.
|
||||
* @param pmap The given pixmap.
|
||||
* @param x Pointer to an integer in which to store the X position.
|
||||
* @param y Pointer to an integer in which to store the Y position.
|
||||
* @param w Pointer to an integer in which to store the width.
|
||||
* @param h Pointer to an integer in which to store the height.
|
||||
* @ingroup Ecore_X_Pixmap_Group
|
||||
*/
|
||||
void
|
||||
ecore_x_pixmap_geometry_get(Ecore_X_Pixmap pmap, int *x, int *y, int *w, int *h)
|
||||
|
|
@ -52,9 +82,10 @@ ecore_x_pixmap_geometry_get(Ecore_X_Pixmap pmap, int *x, int *y, int *w, int *h)
|
|||
}
|
||||
|
||||
/**
|
||||
* To be documented.
|
||||
*
|
||||
* FIXME: To be fixed.
|
||||
* Retrieves the depth of the given pixmap.
|
||||
* @param pmap The given pixmap.
|
||||
* @return The depth of the pixmap.
|
||||
* @ingroup Ecore_X_Pixmap_Group
|
||||
*/
|
||||
int
|
||||
ecore_x_pixmap_depth_get(Ecore_X_Pixmap pmap)
|
||||
|
|
|
|||
|
|
@ -390,12 +390,19 @@ ecore_x_window_lower(Ecore_X_Window win)
|
|||
XLowerWindow(_ecore_x_disp, win);
|
||||
}
|
||||
|
||||
/**
|
||||
* @defgroup Ecore_X_Window_Parent_Group X Window Parent Functions
|
||||
*
|
||||
* Functions that retrieve or changes the parent window of a window.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Moves a window to within another window at a given position.
|
||||
* @param win The window to reparent.
|
||||
* @param new_parent The new parent window.
|
||||
* @param x X position within new parent window.
|
||||
* @param y Y position within new parent window.
|
||||
* @param win The window to reparent.
|
||||
* @param new_parent The new parent window.
|
||||
* @param x X position within new parent window.
|
||||
* @param y Y position within new parent window.
|
||||
* @ingroup Ecore_X_Window_Parent_Group
|
||||
*/
|
||||
void
|
||||
ecore_x_window_reparent(Ecore_X_Window win, Ecore_X_Window new_parent, int x, int y)
|
||||
|
|
@ -406,9 +413,10 @@ ecore_x_window_reparent(Ecore_X_Window win, Ecore_X_Window new_parent, int x, in
|
|||
|
||||
/**
|
||||
* Retrieves the size of the given window.
|
||||
* @param win The given window.
|
||||
* @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.
|
||||
* @param win The given window.
|
||||
* @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.
|
||||
* @ingroup Ecore_X_Window_Geometry_Group
|
||||
*/
|
||||
void
|
||||
ecore_x_window_size_get(Ecore_X_Window win, int *w, int *h)
|
||||
|
|
@ -423,11 +431,12 @@ ecore_x_window_size_get(Ecore_X_Window win, int *w, int *h)
|
|||
|
||||
/**
|
||||
* Retrieves the geometry of the given window.
|
||||
* @param win The given window.
|
||||
* @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.
|
||||
* @param win The given window.
|
||||
* @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.
|
||||
* @ingroup Ecore_X_Window_Geometry_Group
|
||||
*/
|
||||
void
|
||||
ecore_x_window_geometry_get(Ecore_X_Window win, int *x, int *y, int *w, int *h)
|
||||
|
|
@ -440,8 +449,9 @@ ecore_x_window_geometry_get(Ecore_X_Window win, int *x, int *y, int *w, int *h)
|
|||
|
||||
/**
|
||||
* Retrieves the width of the border of the given window.
|
||||
* @param win The given window.
|
||||
* @return Width of the border of @p win.
|
||||
* @param win The given window.
|
||||
* @return Width of the border of @p win.
|
||||
* @ingroup Ecore_X_Window_Geometry_Group
|
||||
*/
|
||||
int
|
||||
ecore_x_window_border_width_get(Ecore_X_Window win)
|
||||
|
|
@ -551,9 +561,10 @@ _ecore_x_window_at_xy_get(Window base, int bx, int by, int x, int y)
|
|||
|
||||
/**
|
||||
* Retrieves the top, visible window at the given location.
|
||||
* @param x The given X position.
|
||||
* @param y The given Y position.
|
||||
* @return The window at that position.
|
||||
* @param x The given X position.
|
||||
* @param y The given Y position.
|
||||
* @return The window at that position.
|
||||
* @ingroup Ecore_X_Window_Geometry_Group
|
||||
*/
|
||||
Ecore_X_Window
|
||||
ecore_x_window_at_xy_get(int x, int y)
|
||||
|
|
@ -573,8 +584,9 @@ ecore_x_window_at_xy_get(int x, int y)
|
|||
|
||||
/**
|
||||
* Retrieves the parent window of the given window.
|
||||
* @param win The given window.
|
||||
* @return The parent window of @p win.
|
||||
* @param win The given window.
|
||||
* @return The parent window of @p win.
|
||||
* @ingroup Ecore_X_Window_Parent_Group
|
||||
*/
|
||||
Ecore_X_Window
|
||||
ecore_x_window_parent_get(Ecore_X_Window win)
|
||||
|
|
|
|||
|
|
@ -3,9 +3,18 @@
|
|||
#include "Ecore_X.h"
|
||||
|
||||
/**
|
||||
* To be documented.
|
||||
* @defgroup Ecore_X_Window_Shape X Window Shape Functions
|
||||
*
|
||||
* FIXME: To be fixed.
|
||||
* These functions use the shape extension of the X server to change
|
||||
* shape of given windows.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Sets the shape of the given window to that given by the pixmap @p mask.
|
||||
* @param win The given window.
|
||||
* @param mask A 2-bit depth pixmap that provides the new shape of the
|
||||
* window.
|
||||
* @ingroup Ecore_X_Window_Shape
|
||||
*/
|
||||
void
|
||||
ecore_x_window_shape_mask_set(Ecore_X_Window win, Ecore_X_Pixmap mask)
|
||||
|
|
|
|||
Loading…
Reference in New Issue