Documentation:
+Use American, rather than British English, spelling. This will facilitate consistent
+text searches. User text may be translated via the en_GB.po file.
+
To document the code use the following rules to allow extraction with doxygen.
Do not save with comments. Not all comments have to be doxygen comments.
comments.
- Use '/**' (note the two asterisks) to start comments to be extracted by
doxygen and start every following line with " *".
-- Use '\' to indicate doxygen keywords/commands (see below).
-- Use the '\deprecated' command to tell if the function is subject to be deleted
+- Use '@' to indicate doxygen keywords/commands (see below).
+- Use the '@deprecated' command to tell if the function is subject to be deleted
or to a complete rewrite.
Example:
To document functions or big structures:
/**
- * \brief This is a short description of the function.
+ * @brief This is a short description of the function.
*
* This function does ...
*
- * \param x1 This is the first parameter named x1
- * \param y1 This is the second parameter named y1
- * \return What the function returns
+ * @param x1 This is the first parameter named x1
+ * @param y1 This is the second parameter named y1
+ * @return What the function returns
* You can extend that return description (or anything else) by indenting the
* following lines until the next empty line or the next keyword/command.
- * \see Cross reference
+ * @see Cross reference
*/
To document members of a structure that have to be documented (use it at least
for big structures) use the '/**<' format:
int counter; /**< This counter counts images */
+Document TODO or FIXME comments as:
+ /**
+ * @todo
+or
+ /**
+ * @FIXME
+
For further documentation about doxygen see
http://www.stack.nl/~dimitri/doxygen/manual.html. For the possible commands you
can use see http://www.stack.nl/~dimitri/doxygen/commands.html.
}
/**
- * \brief Callback for adding selected keyword to all selected images.
+ * @brief Callback for adding selected keyword to all selected images.
*/
static void bar_pane_keywords_add_to_selected_cb(GtkWidget *menu_widget, gpointer data)
{
/**
- * \headerfile collect_manager_moved
+ * @headerfile collect_manager_moved
* these are used to update collections contained in user's collection
* folder when moving or renaming files.
* also handles:
void collect_manager_moved(FileData *fd);
/**
- * \headerfile collect_manager_add
+ * @headerfile collect_manager_add
* add from a specific collection
*/
void collect_manager_add(FileData *fd, const gchar *collection);
/**
- * \headerfile collect_manager_remove
+ * @headerfile collect_manager_remove
* removing from a specific collection
*/
void collect_manager_remove(FileData *fd, const gchar *collection);
/**
- * \headerfile collect_manager_flush
+ * @headerfile collect_manager_flush
* commit pending operations to disk
*/
void collect_manager_flush(void);
CollectionData *collection_from_number(gint n);
/**
- * \headerfile collection_from_dnd_data
+ * @headerfile collection_from_dnd_data
* pass a NULL pointer to whatever you don't need
* use free_selected_list to free list, and
* g_list_free to free info_list, which is a list of
/**
- * \headerfile dnd_set_drag_icon
+ * @headerfile dnd_set_drag_icon
* sets a drag icon to pixbuf, if items is > 1, text is drawn onto icon to indicate value
*/
void dnd_set_drag_icon(GtkWidget *widget, GdkDragContext *context, GdkPixbuf *pixbuf, gint items);
#include "similar.h"
-/** \typedef DupeMatchType
+/** @typedef DupeMatchType
* match methods
*/
typedef enum
/**
- * \enum
+ * @enum
* return values from callback function
*/
enum {
/**
- * \typedef EditorCallback
+ * @typedef EditorCallback
*
* Callback is called even on skipped files, with the #EDITOR_ERROR_SKIPPED flag set.
* It is a good place to call file_data_change_info_free().
*
- * \param ed - pointer that can be used for editor_resume/editor_skip or NULL if all files were already processed \n
- * \param flags - flags above \n
- * \param list - list of processed #FileData structures, typically single file or whole list passed to start_editor_* \n
- * \param data - generic pointer
+ * @param ed - pointer that can be used for editor_resume/editor_skip or NULL if all files were already processed \n
+ * @param flags - flags above \n
+ * @param list - list of processed #FileData structures, typically single file or whole list passed to start_editor_* @n
+ * @param data - generic pointer
*/
typedef gint (*EditorCallback) (gpointer ed, EditorFlags flags, GList *list, gpointer data);
*/
/**
- * \headerfile exif_write_data_list
+ * @headerfile exif_write_data_list
* usually for debugging to stdout
*/
void exif_write_data_list(ExifData *exif, FILE *f, gint human_readable_list);
void exif_free_fd(FileData *fd, ExifData *exif);
/**
- * \headerfile exif_get_original
+ * @headerfile exif_get_original
* exif_read returns processed data (merged from image and sidecar, etc.)
* this function gives access to the original data from the image.
* original data are part of the processed data and should not be freed separately
}
/**
- * \brief Checks if the FileData is referenced
+ * @brief Checks if the FileData is referenced
*
* Checks the refcount and whether the FileData is locked.
*/
}
/**
- * \brief Consider freeing a FileData.
+ * @brief Consider freeing a FileData.
*
* This function will free a FileData and its children provided that neither its parent nor it has
* a positive refcount, and provided that neither is locked.
}
/**
- * \brief Lock the FileData in memory.
+ * @brief Lock the FileData in memory.
*
* This allows the caller to prevent a FileData from being freed, even after its refcount is zero.
* This is intended to be used in cases where a FileData _should_ stay in memory as an optimization,
}
/**
- * \brief Reset the maintain-FileData-in-memory lock
+ * @brief Reset the maintain-FileData-in-memory lock
*
* This again allows the FileData to be freed when its refcount drops to zero. Automatically frees
* the FileData if its refcount is already zero (which will happen if the lock is the only thing
}
/**
- * \brief Lock all of the FileDatas in the provided list
+ * @brief Lock all of the FileDatas in the provided list
*
- * \see file_data_lock(FileData)
+ * @see file_data_lock(#FileData)
*/
void file_data_lock_list(GList *list)
{
}
/**
- * \brief Unlock all of the FileDatas in the provided list
+ * @brief Unlock all of the FileDatas in the provided list
*
- * \see file_data_unlock(FileData)
+ * @see #file_data_unlock(#FileData)
*/
void file_data_unlock_list(GList *list)
{
const gchar *text_from_time(time_t t);
/**
- * \headerfile file_data_new_group
+ * @headerfile file_data_new_group
* scan for sidecar files - expensive
*/
FileData *file_data_new_group(const gchar *path_utf8);
/**
- * \headerfile file_data_new_no_grouping
+ * @headerfile file_data_new_no_grouping
* should be used on helper files which can't have sidecars
*/
FileData *file_data_new_no_grouping(const gchar *path_utf8);
/**
- * \headerfile file_data_new_dir
+ * @headerfile file_data_new_dir
* should be used on dirs
*/
FileData *file_data_new_dir(const gchar *path_utf8);
};
/**
- * \headerfile filter_get_list
+ * @headerfile filter_get_list
* you can change, but not add or remove entries from the returned list
*/
GList *filter_get_list(void);
"Tiff debugger MM", format_debug_tiff_raw }
/**
- * \headerfile format_debug_tiff_raw
+ * @headerfile format_debug_tiff_raw
* used for debugging only
*/
gint format_debug_tiff_raw(guchar *data, const guint len,
/**
- * \struct ScreenData
+ * @struct ScreenData
* screen numbers for fullscreen_prefs are as follows: \n
* 0 use default display size \n
* 101 screen 0, monitor 0 \n
/**
- * \headerfile history_list_get_by_key
+ * @headerfile history_list_get_by_key
* the returned GList is internal, don't free it
*/
GList *history_list_get_by_key(const gchar *key);
void image_loader_free(ImageLoader *il);
/**
- * \headerfile image_loader_delay_area_ready
+ * @headerfile image_loader_delay_area_ready
* delay area_ready signals
*/
void image_loader_delay_area_ready(ImageLoader *il, gboolean enable);
/**
- * \headerfile image_loader_set_requested_size
+ * @headerfile image_loader_set_requested_size
* Speed up loading when you only need at most width x height size image,
* only the jpeg GdkPixbuf loader benefits from it - so there is no
* guarantee that the image will scale down to the requested size..
void image_loader_set_buffer_size(ImageLoader *il, guint size);
/**
- * \headerfile image_loader_set_priority
+ * @headerfile image_loader_set_priority
* this only has effect if used before image_loader_start()
* default is G_PRIORITY_DEFAULT_IDLE
*/
FileData *image_get_fd(ImageWindow *imd);
/**
- * \headerfile image_set_fd
+ * @headerfile image_set_fd
* merely changes path string, does not change the image!
*/
void image_set_fd(ImageWindow *imd, FileData *fd);
void image_stereo_pixbuf_set(ImageWindow *imd, StereoPixbufData stereo_mode);
/**
- * \headerfile image_prebuffer_set
+ * @headerfile image_prebuffer_set
* read ahead, pass NULL to cancel
*/
void image_prebuffer_set(ImageWindow *imd, FileData *fd);
/**
- * \headerfile image_auto_refresh_enable
+ * @headerfile image_auto_refresh_enable
* auto refresh
*/
void image_auto_refresh_enable(ImageWindow *imd, gboolean enable);
/**
- * \headerfile image_top_window_set_sync
+ * @headerfile image_top_window_set_sync
* allow top window to be resized ?
*/
void image_top_window_set_sync(ImageWindow *imd, gboolean allow_sync);
gboolean image_color_profile_get_status(ImageWindow *imd, gchar **image_profile, gchar **screen_profile);
/**
- * \headerfile image_set_delay_flip
+ * @headerfile image_set_delay_flip
* set delayed page flipping
*/
void image_set_delay_flip(ImageWindow *imd, gint delay);
/**
- * \headerfile image_to_root_window
+ * @headerfile image_to_root_window
* wallpaper util
*/
void image_to_root_window(ImageWindow *imd, gboolean scaled);
gdouble zoom);
/**
- * \headerfile image_options_sync
+ * @headerfile image_options_sync
* reset default options
*/
void image_options_sync(void);
}
/**
- * \brief Initialize the lua interpreter.
+ * @brief Initialize the lua interpreter.
*/
void lua_init(void)
{
}
/**
- * \brief Call a lua function to get a single value.
+ * @brief Call a lua function to get a single value.
*/
gchar *lua_callvalue(FileData *fd, const gchar *file, const gchar *function)
{
void md5_final(MD5Context *ctx, guchar digest[16]);
/**
- * \headerfile md5_get_digest
+ * @headerfile md5_get_digest
* generate digest from memory buffer
*/
void md5_get_digest(const guchar *buffer, gint buffer_size, guchar digest[16]);
/**
- * \headerfile md5_get_digest_from_file
+ * @headerfile md5_get_digest_from_file
* generate digest from file
*/
gboolean md5_get_digest_from_file(const gchar *path, guchar digest[16]);
/**
- * \headerfile md5_digest_to_text
+ * @headerfile md5_digest_to_text
* convert digest to a NULL terminated text string, in ascii encoding
*/
gchar *md5_digest_to_text(guchar digest[16]);
/**
- * \headerfile md5_digest_from_text
+ * @headerfile md5_digest_from_text
* convert digest from a NULL terminated text string, in ascii encoding
*/
gboolean md5_digest_from_text(const gchar *text, guchar digest[16]);
}
/**
- * \see find_string_in_list
+ * @see find_string_in_list
*/
gchar *find_string_in_list_utf8nocase(GList *list, const gchar *string)
{
}
/**
- * \see find_string_in_list
+ * @see find_string_in_list
*/
gchar *find_string_in_list_utf8case(GList *list, const gchar *string)
{
} // gchar *find_string_in_list_utf...
/**
- * \brief Find a existent string in a list.
+ * @brief Find a existent string in a list.
*
* This is a switch between find_string_in_list_utf8case and
* find_string_in_list_utf8nocase to search with or without case for the
* existence of a string.
*
- * \param list The list to search in
- * \param string The string to search for
- * \return The string or NULL
+ * @param list The list to search in
+ * @param string The string to search for
+ * @return The string or NULL
*
- * \see find_string_in_list_utf8case
- * \see find_string_in_list_utf8nocase
+ * @see find_string_in_list_utf8case
+ * @see find_string_in_list_utf8nocase
*/
gchar *find_string_in_list(GList *list, const gchar *string)
{
gchar *help_search_engine;
/**
- * \struct info_comment
+ * @struct info_comment
* info sidebar component height
*/
struct {
} info_comment;
/**
- * \struct info_keywords
+ * @struct info_keywords
* info sidebar component height
*/
struct {
} info_keywords;
/**
- * \struct info_title
+ * @struct info_title
* info sidebar component height
*/
struct {
} info_title;
/**
- * \struct info_rating
+ * @struct info_rating
* info sidebar component height
*/
struct {
gint fixed_x1, fixed_y1;
gint fixed_x2, fixed_y2;
/**
- * \struct tmp
+ * @struct tmp
* options in this struct are packed to mode and fsmode entries
*/
struct {
} stereo;
/**
- * \struct cp_mv_rn
+ * @struct cp_mv_rn
* copy move rename
*/
struct {
};
/**
- * \typedef _PanViewFilterUi
+ * @typedef _PanViewFilterUi
* Defined in pan-view-filter.h
*/
typedef struct _PanViewFilterUi PanViewFilterUi;
void pan_filter_toggle_button_cb(GtkWidget *button, gpointer data);
/**
- * \headerfile pan_filter_ui_new
+ * @headerfile pan_filter_ui_new
* Creates a new #PanViewFilterUi instance and returns it.
*/
PanViewFilterUi *pan_filter_ui_new(PanWindow *pw);
/**
- * \headerfile pan_filter_ui_destroy
+ * @headerfile pan_filter_ui_destroy
* Destroys the specified #PanViewFilterUi and sets the pointer to NULL.
*/
void pan_filter_ui_destroy(PanViewFilterUi **ui);
void pan_search_toggle_cb(GtkWidget *button, gpointer data);
/**
- * \headerfile pan_search_ui_new
+ * @headerfile pan_search_ui_new
* Creates a new #PanViewSearchUi instance and returns it.
*/
PanViewSearchUi *pan_search_ui_new(PanWindow *pw);
/**
- * \headerfile pan_search_ui_destroy
+ * @headerfile pan_search_ui_destroy
* Destroys the specified #PanViewSearchUi and sets the pointer to NULL.
*/
void pan_search_ui_destroy(PanViewSearchUi **ui);
#define PIXBUF_RENDERER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), TYPE_PIXBUF_RENDERER, PixbufRendererClass))
/**
- * \def PR_ALPHA_CHECK_SIZE
+ * @def PR_ALPHA_CHECK_SIZE
* alpha channel checkerboard (same as gimp)
*/
#define PR_ALPHA_CHECK_SIZE 16
/**
- * \def PR_MIN_SCALE_SIZE
+ * @def PR_MIN_SCALE_SIZE
* when scaling image to below this size, use nearest pixel for scaling
* (below about 4, the other scale types become slow generating their conversion tables)
*/
#define PR_MIN_SCALE_SIZE 8
/**
- * \def PR_CACHE_SIZE_DEFAULT
+ * @def PR_CACHE_SIZE_DEFAULT
* default size of tile cache (MiB)
*/
#define PR_CACHE_SIZE_DEFAULT 8
/**
- * \def ROUND_UP
+ * @def ROUND_UP
* round A up to integer count of B
*/
#define ROUND_UP(A,B) ((gint)(((A)+(B)-1)/(B))*(B))
/**
- * \def ROUND_DOWN
+ * @def ROUND_DOWN
* round A down to integer count of B
*/
#define ROUND_DOWN(A,B) ((gint)(((A))/(B))*(B))
GtkWindow *pixbuf_renderer_get_parent(PixbufRenderer *pr);
/**
- * \headerfile pixbuf_renderer_set_pixbuf
+ * @headerfile pixbuf_renderer_set_pixbuf
* display a pixbuf
*/
void pixbuf_renderer_set_pixbuf(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom);
/**
- * \headerfile pixbuf_renderer_set_pixbuf_lazy
+ * @headerfile pixbuf_renderer_set_pixbuf_lazy
* same as pixbuf_renderer_set_pixbuf but waits with redrawing for pixbuf_renderer_area_changed */
void pixbuf_renderer_set_pixbuf_lazy(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom, gint orientation, StereoPixbufData stereo_data);
gint pixbuf_renderer_get_orientation(PixbufRenderer *pr);
/**
- * \headerfile pixbuf_renderer_set_stereo_data
+ * @headerfile pixbuf_renderer_set_stereo_data
* sets the format of stereo data in the input pixbuf
*/
void pixbuf_renderer_set_stereo_data(PixbufRenderer *pr, StereoPixbufData stereo_data);
void pixbuf_renderer_set_post_process_func(PixbufRenderer *pr, PixbufRendererPostProcessFunc func, gpointer user_data, gboolean slow);
/**
- * \headerfile pixbuf_renderer_set_tiles
+ * @headerfile pixbuf_renderer_set_tiles
* display an on-request array of pixbuf tiles
*/
void pixbuf_renderer_set_tiles(PixbufRenderer *pr, gint width, gint height,
gint pixbuf_renderer_get_tiles(PixbufRenderer *pr);
/**
- * \headerfile pixbuf_renderer_move
+ * @headerfile pixbuf_renderer_move
* move image data from source to pr, source is then set to NULL image
*/
void pixbuf_renderer_move(PixbufRenderer *pr, PixbufRenderer *source);
void pixbuf_renderer_copy(PixbufRenderer *pr, PixbufRenderer *source);
/**
- * \headerfile pixbuf_renderer_area_changed
+ * @headerfile pixbuf_renderer_area_changed
* update region of existing image
*/
void pixbuf_renderer_area_changed(PixbufRenderer *pr, gint x, gint y, gint width, gint height);
gboolean pixbuf_renderer_get_scaled_size(PixbufRenderer *pr, gint *width, gint *height);
/**
- * \headerfile pixbuf_renderer_get_visible_rect
+ * @headerfile pixbuf_renderer_get_visible_rect
* region of image in pixel coordinates
*/
gboolean pixbuf_renderer_get_visible_rect(PixbufRenderer *pr, GdkRectangle *rect);
/**
- * \headerfile pixbuf_renderer_get_virtual_rect
+ * @headerfile pixbuf_renderer_get_virtual_rect
* actual size of the PixbufRenderer window minus borders,
* x and y are the scroll offset and include zoom factor.
*/
gboolean pixbuf_renderer_get_virtual_rect(PixbufRenderer *pr, GdkRectangle *rect);
/**
- * \headerfile pixbuf_renderer_set_color
+ * @headerfile pixbuf_renderer_set_color
* background color
*/
void pixbuf_renderer_set_color(PixbufRenderer *pr, GdkColor *color);
gboolean pixbuf_renderer_get_mouse_position(PixbufRenderer *pr, gint *x_pixel, gint *y_pixel);
/**
- * \headerfile pixbuf_renderer_get_pixel_colors
+ * @headerfile pixbuf_renderer_get_pixel_colors
* x_pixel and y_pixel are the pixel coordinates see #pixbuf_renderer_get_mouse_position
*/
gboolean pixbuf_renderer_get_pixel_colors(PixbufRenderer *pr, gint x_pixel, gint y_pixel,
void pixbuf_renderer_stereo_fixed_set(PixbufRenderer *pr, gint width, gint height, gint x1, gint y1, gint x2, gint y2);
/**
- * \struct _SourceTile
+ * @struct _SourceTile
* protected - for renderer use only
*/
typedef struct _SourceTile SourceTile;
void show_about_window(LayoutWindow *lw);
/**
- * \headerfile config_entry_to_option
+ * @headerfile config_entry_to_option
* reusable helper functions
*/
void config_entry_to_option(GtkWidget *entry, gchar **option, gchar *(*func)(const gchar *));
/**
- * \headerfile print_window_new
+ * @headerfile print_window_new
* do not free selection or list, the print window takes control of them
*/
void print_window_new(FileData *fd, GList *selection, GList *list, GtkWidget *parent);
}
/**
- * \param arg_exec Binary (argv0)
- * \param remote_list Evaluated and recognized remote commands
- * \param path The current path
- * \param cmd_list List of all non collections in Path (gchar *path)
- * \param collection_list List of all collections in argv
+ * @param arg_exec Binary (argv0)
+ * @param remote_list Evaluated and recognized remote commands
+ * @param path The current path
+ * @param cmd_list List of all non collections in Path (gchar *path)
+ * @param collection_list List of all collections in argv
*/
void remote_control(const gchar *arg_exec, GList *remote_list, const gchar *path,
GList *cmd_list, GList *collection_list)
void thumb_loader_std_calibrate_pixbuf(FileData *fd, GdkPixbuf *pixbuf);
/**
- * \headerfile thumb_loader_std_thumb_file_validate
+ * @headerfile thumb_loader_std_thumb_file_validate
* validates a non local thumbnail file,
* calling func_valid with the information when app is idle
* for thumbnail's without a file: uri, validates against allowed_age in days
} SortType;
/**
- * \typedef DnDAction
+ * @typedef DnDAction
* drag and drop default action
*/
typedef enum {
extern gchar *format_class_list[]; /**< defined in preferences.c */
/**
- * \typedef SecureSaveErrno
+ * @typedef SecureSaveErrno
* see err field in #SecureSaveInfo
*/
typedef enum {
gpointer data_focus_in;
/**
- * \headerfile func_scroll_notify
+ * @headerfile func_scroll_notify
* scroll notification (for scroll bar implementation)
*/
void (*func_scroll_notify)(ImageWindow *, gint x, gint y, gint width, gint height, gpointer);
void bookmark_list_add(GtkWidget *list, const gchar *name, const gchar *path);
/**
- * \headerfile bookmark_add_default
+ * @headerfile bookmark_add_default
* allows apps to set up the defaults
*/
void bookmark_add_default(const gchar *name, const gchar *path);
gchar *get_current_dir(void);
/**
- * \headerfile string_list_free
+ * @headerfile string_list_free
* return True on success, it is up to you to free
* the lists with string_list_free()
*/
gboolean file_extension_match(const gchar *path, const gchar *ext);
/**
- * \headerfile parse_out_relatives
+ * @headerfile parse_out_relatives
* warning note: this modifies path string!
*/
void parse_out_relatives(gchar *path);
/**
- * \headerfile md5_text_from_file_utf8
+ * @headerfile md5_text_from_file_utf8
* generate md5 string from file,
* on failure returns newly allocated copy of error_text, error_text may be NULL
*/
void menu_item_add_divider(GtkWidget *menu);
/**
- * \headerfile menu_item_add_simple
+ * @headerfile menu_item_add_simple
* use to avoid mnemonics, for example filenames
*/
GtkWidget *menu_item_add_simple(GtkWidget *menu, const gchar *label,
GtkWidget *popup_menu_short_lived(void);
/**
- * \headerfile popup_menu_position_clamp
+ * @headerfile popup_menu_position_clamp
* clamp a menu's position to within the screen
* if menu will attempt to stay out of region y to y+height
*/
/* HIG 2.0 chapter 8 defines: */
/**
- * \def PREF_PAD_GAP
+ * @def PREF_PAD_GAP
* space between elements within control (ex: icon and it's text)
*/
#define PREF_PAD_GAP 6
/**
- * \def PREF_PAD_SPACE
+ * @def PREF_PAD_SPACE
* space between label and control(s)
*/
#define PREF_PAD_SPACE 12
/**
- * \def PREF_PAD_BORDER
+ * @def PREF_PAD_BORDER
* space between window border and controls
*/
#define PREF_PAD_BORDER 12
/**
- * \def PREF_PAD_INDENT
+ * @def PREF_PAD_INDENT
* indent for group members
*/
#define PREF_PAD_INDENT 12
/**
- * \def PREF_PAD_GROUP
+ * @def PREF_PAD_GROUP
* vertical space between groups
*/
#define PREF_PAD_GROUP 18
/* HIG 2.0 chapter 3.13 defines: */
/**
- * \def PREF_PAD_BUTTON_GAP
+ * @def PREF_PAD_BUTTON_GAP
* gap between buttons in a dialog
*/
#define PREF_PAD_BUTTON_GAP 6
/**
- * \def PREF_PAD_BUTTON_SPACE
+ * @def PREF_PAD_BUTTON_SPACE
* space between buttons in a dialog and it's contents
*/
#define PREF_PAD_BUTTON_SPACE 24
/* and these are not in the GNOME HIG */
/**
- * \def PREF_PAD_TOOLBAR_GAP
+ * @def PREF_PAD_TOOLBAR_GAP
* gap between similar toolbar items (buttons)
*/
#define PREF_PAD_TOOLBAR_GAP 0
/**
- * \def PREF_PAD_BUTTON_ICON_GAP
+ * @def PREF_PAD_BUTTON_ICON_GAP
* HIG 2.0 states 6 pixels between icons and text,
* but GTK's stock buttons ignore this (hard coded to 2), we do it too for consistency
*/
extern const guint8 icon_tabcomp[];
/**
- * \headerfile spinner_new
+ * @headerfile spinner_new
* if path is NULL, the built in spinner is used,
* otherwise path must be the location of the first image of the
* spinner without the 00.png portion of the pathname, example: \n
/**
- * \headerfile tree_edit_by_path
+ * @headerfile tree_edit_by_path
* edit_func: return TRUE if rename successful, FALSE on failure.
*/
gboolean tree_edit_by_path(GtkTreeView *tree, GtkTreePath *tpath, gint column, const gchar *text,
/**
- * \headerfile tree_view_get_cell_origin
+ * @headerfile tree_view_get_cell_origin
* returns location of cell in screen coordinates
*/
gboolean tree_view_get_cell_origin(GtkTreeView *widget, GtkTreePath *tpath, gint column, gboolean text_cell_only,
gint *x, gint *y, gint *width, gint *height);
/**
- * \headerfile tree_view_get_cell_clamped
+ * @headerfile tree_view_get_cell_clamped
* similar to above, but limits the returned area to that of the tree window
*/
void tree_view_get_cell_clamped(GtkTreeView *widget, GtkTreePath *tpath, gint column, gboolean text_cell_only,
gint *x, gint *y, gint *width, gint *height);
/**
- * \headerfile tree_view_row_get_visibility
+ * @headerfile tree_view_row_get_visibility
* return 0 = row visible, -1 = row is above, 1 = row is below visible region \n
* if fully_visible is TRUE, the behavior changes to return -1/1 if _any_ part of the cell is out of view
*/
gint tree_view_row_get_visibility(GtkTreeView *widget, GtkTreeIter *iter, gboolean fully_visible);
/**
- * \headerfile tree_view_row_make_visible
+ * @headerfile tree_view_row_make_visible
* scrolls to make row visible, if necessary
* return is same as above (before the scroll)
*/
gint tree_view_row_make_visible(GtkTreeView *widget, GtkTreeIter *iter, gboolean center);
/**
- * \headerfile tree_view_move_cursor_away
+ * @headerfile tree_view_move_cursor_away
* if iter is location of cursor, moves cursor to nearest row
*/
gboolean tree_view_move_cursor_away(GtkTreeView *widget, GtkTreeIter *iter, gboolean only_selected);
/**
- * \headerfile tree_path_to_row
+ * @headerfile tree_path_to_row
* utility to return row position of given GtkTreePath
*/
gint tree_path_to_row(GtkTreePath *tpath);
/**
- * \headerfile shift_color
+ * @headerfile shift_color
* shifts a GdkColor values lighter or darker \n
* val is percent from 1 to 100, or -1 for default (usually 10%) \n
* direction is -1 darker, 0 auto, 1 lighter
void shift_color(GdkColor *src, gshort val, gint direction);
/**
- * \headerfile style_shift_color
+ * @headerfile style_shift_color
* Shifts a style's color for given state
* Useful for alternating dark/light rows in lists. \n
*
void style_shift_color(GtkStyle *style, GtkStateType type, gshort shift_value, gint direction);
/**
- * \def STYLE_SHIFT_STANDARD
+ * @def STYLE_SHIFT_STANDARD
* The standard shift percent for alternating list row colors
*/
#define STYLE_SHIFT_STANDARD 10
/**
- * \headerfile widget_auto_scroll_start
+ * @headerfile widget_auto_scroll_start
* auto scroll, set scroll_speed or region_size to -1 to their respective the defaults
* notify_func will be called before a scroll, return FALSE to turn off autoscroll
*/
/**
- * \headerfile generic_dialog_new
+ * @headerfile generic_dialog_new
* When parent is not NULL, the dialog is set as a transient of the window containing parent
*/
GenericDialog *generic_dialog_new(const gchar *title,
void (*func_cb)(FileDialog *, gpointer), gboolean is_default);
/**
- * \headerfile file_dialog_add_path_widgets
+ * @headerfile file_dialog_add_path_widgets
* default_path is default base directory, and is only used if no history
* exists for history_key (HOME is used if default_path is NULL).
* path can be a full path or only a file name. If name only, appended to
projects / geeqie.git / commitdiff