nautilus/libnautilus-private/nautilus-icon-container.h
Alexander Larsson c05eef2e30 Merge the new-icon-factory-branch branch to HEAD.
2002-09-18  Alexander Larsson  <alexl@redhat.com>

	Merge the new-icon-factory-branch branch to HEAD.
2002-09-18 18:26:12 +00:00

241 lines
12 KiB
C

/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
/* gnome-icon-container.h - Icon container widget.
Copyright (C) 1999, 2000 Free Software Foundation
Copyright (C) 2000 Eazel, Inc.
The Gnome Library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.
The Gnome Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with the Gnome Library; see the file COPYING.LIB. If not,
write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
Authors: Ettore Perazzoli <ettore@gnu.org>, Darin Adler <darin@bentspoon.com>
*/
#ifndef NAUTILUS_ICON_CONTAINER_H
#define NAUTILUS_ICON_CONTAINER_H
#include <libgnomecanvas/gnome-canvas.h>
#include <libnautilus-private/nautilus-icon-factory.h>
#define NAUTILUS_ICON_CONTAINER(obj) \
GTK_CHECK_CAST (obj, nautilus_icon_container_get_type (), NautilusIconContainer)
#define NAUTILUS_ICON_CONTAINER_CLASS(k) \
GTK_CHECK_CLASS_CAST (k, nautilus_icon_container_get_type (), NautilusIconContainerClass)
#define NAUTILUS_IS_ICON_CONTAINER(obj) \
GTK_CHECK_TYPE (obj, nautilus_icon_container_get_type ())
#define NAUTILUS_ICON_CONTAINER_ICON_DATA(pointer) \
((NautilusIconData *) (pointer))
#define NAUTILUS_ICON_CONTAINER_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS ((object), \
nautilus_icon_container_get_type (), \
NautilusIconContainerClass))
typedef struct NautilusIconData NautilusIconData;
typedef void (* NautilusIconCallback) (NautilusIconData *icon_data,
gpointer callback_data);
typedef struct {
int x;
int y;
double scale_x;
double scale_y;
} NautilusIconPosition;
typedef enum {
NAUTILUS_ICON_LAYOUT_L_R_T_B,
NAUTILUS_ICON_LAYOUT_T_B_L_R,
NAUTILUS_ICON_LAYOUT_T_B_R_L
} NautilusIconLayoutMode;
typedef struct NautilusIconContainerDetails NautilusIconContainerDetails;
typedef struct {
GnomeCanvas canvas;
NautilusIconContainerDetails *details;
} NautilusIconContainer;
typedef struct {
GnomeCanvasClass parent_slot;
/* Operations on the container. */
int (* button_press) (NautilusIconContainer *container,
GdkEventButton *event);
void (* context_click_background) (NautilusIconContainer *container,
GdkEventButton *event);
void (* middle_click) (NautilusIconContainer *container,
GdkEventButton *event);
/* Operations on icons. */
void (* activate) (NautilusIconContainer *container,
NautilusIconData *data);
void (* context_click_selection) (NautilusIconContainer *container,
GdkEventButton *event);
void (* move_copy_items) (NautilusIconContainer *container,
GList *item_uris,
GdkPoint *relative_item_points,
const char *target_uri,
int copy_action,
int x,
int y);
void (* handle_uri_list) (NautilusIconContainer *container,
GList *item_uris,
int x,
int y);
/* Queries on the container for subclass/client.
* These must be implemented. The default "do nothing" is not good enough.
*/
char * (* get_container_uri) (NautilusIconContainer *container);
/* Queries on icons for subclass/client.
* These must be implemented. The default "do nothing" is not
* good enough, these are _not_ signals.
*/
char * (* get_icon_images) (NautilusIconContainer *container,
NautilusIconData *data,
GList **emblem_icons,
char **embedded_text);
void (* get_icon_text) (NautilusIconContainer *container,
NautilusIconData *data,
char **editable_text,
char **additional_text);
int (* compare_icons) (NautilusIconContainer *container,
NautilusIconData *icon_a,
NautilusIconData *icon_b);
int (* compare_icons_by_name) (NautilusIconContainer *container,
NautilusIconData *icon_a,
NautilusIconData *icon_b);
/* Queries on icons for subclass/client.
* These must be implemented => These are signals !
* The default "do nothing" is not good enough.
*/
gboolean (* can_accept_item) (NautilusIconContainer *container,
NautilusIconData *target,
const char *item_uri);
gboolean (* get_stored_icon_position) (NautilusIconContainer *container,
NautilusIconData *data,
NautilusIconPosition *position);
char * (* get_icon_uri) (NautilusIconContainer *container,
NautilusIconData *data);
char * (* get_icon_drop_target_uri) (NautilusIconContainer *container,
NautilusIconData *data);
/* Notifications for the whole container. */
void (* band_select_started) (NautilusIconContainer *container);
void (* band_select_ended) (NautilusIconContainer *container);
void (* selection_changed) (NautilusIconContainer *container);
void (* layout_changed) (NautilusIconContainer *container);
/* Notifications for icons. */
void (* icon_position_changed) (NautilusIconContainer *container,
NautilusIconData *data,
const NautilusIconPosition *position);
void (* icon_text_changed) (NautilusIconContainer *container,
NautilusIconData *data,
const char *text);
void (* renaming_icon) (NautilusIconContainer *container,
GtkWidget *renaming_widget);
void (* icon_stretch_started) (NautilusIconContainer *container,
NautilusIconData *data);
void (* icon_stretch_ended) (NautilusIconContainer *container,
NautilusIconData *data);
int (* preview) (NautilusIconContainer *container,
NautilusIconData *data,
gboolean start_flag);
void (* icon_added) (NautilusIconContainer *container,
NautilusIconData *data);
void (* icon_removed) (NautilusIconContainer *container,
NautilusIconData *data);
void (* cleared) (NautilusIconContainer *container);
} NautilusIconContainerClass;
/* GtkObject */
GType nautilus_icon_container_get_type (void);
GtkWidget * nautilus_icon_container_new (void);
/* adding, removing, and managing icons */
void nautilus_icon_container_clear (NautilusIconContainer *view);
gboolean nautilus_icon_container_add (NautilusIconContainer *view,
NautilusIconData *data);
gboolean nautilus_icon_container_remove (NautilusIconContainer *view,
NautilusIconData *data);
void nautilus_icon_container_for_each (NautilusIconContainer *view,
NautilusIconCallback callback,
gpointer callback_data);
void nautilus_icon_container_request_update (NautilusIconContainer *view,
NautilusIconData *data);
void nautilus_icon_container_request_update_all (NautilusIconContainer *container);
void nautilus_icon_container_reveal (NautilusIconContainer *container,
NautilusIconData *data);
gboolean nautilus_icon_container_is_empty (NautilusIconContainer *container);
/* control the layout */
gboolean nautilus_icon_container_is_auto_layout (NautilusIconContainer *container);
void nautilus_icon_container_set_auto_layout (NautilusIconContainer *container,
gboolean auto_layout);
gboolean nautilus_icon_container_is_tighter_layout (NautilusIconContainer *container);
void nautilus_icon_container_set_tighter_layout (NautilusIconContainer *container,
gboolean tighter_layout);
void nautilus_icon_container_set_layout_mode (NautilusIconContainer *container,
NautilusIconLayoutMode mode);
void nautilus_icon_container_sort (NautilusIconContainer *container);
void nautilus_icon_container_freeze_icon_positions (NautilusIconContainer *container);
/* operations on all icons */
void nautilus_icon_container_unselect_all (NautilusIconContainer *view);
void nautilus_icon_container_select_all (NautilusIconContainer *view);
/* operations on the selection */
GList * nautilus_icon_container_get_selection (NautilusIconContainer *view);
void nautilus_icon_container_set_selection (NautilusIconContainer *view,
GList *selection);
GArray * nautilus_icon_container_get_selected_icon_locations (NautilusIconContainer *view);
gboolean nautilus_icon_container_has_stretch_handles (NautilusIconContainer *container);
gboolean nautilus_icon_container_is_stretched (NautilusIconContainer *container);
void nautilus_icon_container_show_stretch_handles (NautilusIconContainer *container);
void nautilus_icon_container_unstretch (NautilusIconContainer *container);
void nautilus_icon_container_start_renaming_selected_item (NautilusIconContainer *container);
/* options */
NautilusZoomLevel nautilus_icon_container_get_zoom_level (NautilusIconContainer *view);
void nautilus_icon_container_set_zoom_level (NautilusIconContainer *view,
int new_zoom_level);
void nautilus_icon_container_set_single_click_mode (NautilusIconContainer *container,
gboolean single_click_mode);
void nautilus_icon_container_enable_linger_selection (NautilusIconContainer *view,
gboolean enable);
gboolean nautilus_icon_container_get_is_fixed_size (NautilusIconContainer *container);
void nautilus_icon_container_set_is_fixed_size (NautilusIconContainer *container,
gboolean is_fixed_size);
void nautilus_icon_container_reset_scroll_region (NautilusIconContainer *container);
void nautilus_icon_container_set_font (NautilusIconContainer *container,
const char *font);
void nautilus_icon_container_set_font_size_table (NautilusIconContainer *container,
const int font_size_table[NAUTILUS_ZOOM_LEVEL_LARGEST + 1]);
void nautilus_icon_container_set_margins (NautilusIconContainer *container,
int left_margin,
int right_margin,
int top_margin,
int bottom_margin);
void nautilus_icon_container_set_use_drop_shadows (NautilusIconContainer *container,
gboolean use_drop_shadows);
#endif /* NAUTILUS_ICON_CONTAINER_H */