nautilus/libnautilus-extensions/nautilus-icon-factory.h
Darin Adler d9195bab4c reviewed by: John Sullivan <sullivan@eazel.com>
Some enhancements to icon lookup.

	* libnautilus-extensions/nautilus-icon-factory.h:
	* libnautilus-extensions/nautilus-icon-factory.c:
	(get_mime_type_icon_without_suffix): Function used to strip suffixes
	out so we can have file suffixes in the gnome-vfs icon database, but
	can ignore them and look at all suffixes for the named icon.
	(make_icon_name_from_mime_type): Construct an icon name for types
	that don't specify a particular icon. This allows theme designers
	to make icons for any MIME type.
	(get_icon_name_for_regular_file): Use the new "without suffix" call.
	This requires changing this function to return a strdup'd name.
	(get_icon_name_for_directory), (get_icon_name_for_file): Change to
	return a strdup'd name.
	(make_full_icon_path): Do the file exists check in here (was
	already doing it in some cases) and also call
	gnome_vfs_icon_path_from_filename.
	(get_themed_icon_file_path): Get rid of redundant g_file_exists
	checks and gnome_vfs_icon_path_from_filename call, since both are
	now handled inside make_full_icon_path.
	(nautilus_scalable_icon_get_text_pieces),
	(nautilus_scalable_icon_new_from_text_pieces),
	(nautilus_scalable_icon_unref), (nautilus_scalable_icon_hash),
	(nautilus_scalable_icon_equal): Add MIME type to the scalable
	icons.
	(nautilus_icon_factory_get_icon_for_file): Pass in the MIME type.
	(nautilus_icon_factory_get_emblem_icon_by_name): Pass NULL for
	MIME type.
	(load_pixbuf_svg): Change to pass in boolean for emblem hack since
	we don't always have an icon name.
	(load_icon_from_path): New function, share common code.
	(load_named_icon): New function, share common code.
	(load_specific_icon): Try icon based on MIME type first, then fall
	back on the name specified.
	(nautilus_icon_factory_get_pixbuf_from_name): Pass NULL for MIME
	type.
	(load_icon_with_embedded_text): Pass in the MIME type.

	* src/nautilus-bookmark-list.c: (append_bookmark_node):
	* src/nautilus-bookmark-parsing.c:
	(nautilus_bookmark_new_from_node):
	* libnautilus-extensions/nautilus-bookmark.c:
	(nautilus_bookmark_icon_is_different),
	(nautilus_bookmark_set_icon_to_default):
	Update to deal with MIME types in scalable icons.

	* components/help/hyperbola-filefmt.c:
	(fmt_scrollkeeper_parse_toc_section),
	(fmt_scrollkeeper_parse_doc_toc),
	(fmt_scrollkeeper_parse_document),
	(fmt_scrollkeeper_parse_section), (fmt_scrollkeeper_parse_xml),
	(fmt_scrollkeeper_trim_empty_branches),
	(fmt_scrollkeeper_tree_empty), (fmt_scrollkeeper_populate_tree),
	(remove_leading_and_trailing_white_spaces), (fmt_toplevel_add_doc),
	(get_path_from_node), (has_content), (fmt_toplevel_parse_xml_tree):
	Made more compatible with libxml by not using the content field
	directly and using xmlChildrenNode and xmlRootNode.

	* libnautilus-extensions/nautilus-trash-monitor.c:
	(nautilus_trash_monitor_get): Fixed NautilusDirectory leak.

	* THANKS: Added some more translator credits.
	* check-THANKS.pl: Fixed some email addresses and such.

	* icons/ardmore/.cvsignore:
	* icons/arlo/.cvsignore,
	* icons/arlo/backgrounds/.cvsignore:
	* icons/arlo/sidebar_tab_pieces/.cvsignore:
	* icons/villanova/.cvsignore:
	Removed these again.
2001-05-01 21:21:09 +00:00

184 lines
8 KiB
C

/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*-
nautilus-icon-factory.h: Class for obtaining icons for files and other objects.
Copyright (C) 1999, 2000 Red Hat Inc.
Copyright (C) 1999, 2000 Eazel, Inc.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.
This program 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
General Public License for more details.
You should have received a copy of the GNU General Public
License along with this program; if not, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
Author: John Sullivan <sullivan@eazel.com>
*/
#ifndef NAUTILUS_ICON_FACTORY_H
#define NAUTILUS_ICON_FACTORY_H
#include <gdk-pixbuf/gdk-pixbuf.h>
#include <libnautilus-extensions/nautilus-file.h>
#include <eel/eel-string-list.h>
#include <gtk/gtkobject.h>
/* NautilusIconFactory is a class that knows how to hand out icons to be
* used for representing files and some other objects. It was designed
* specifically to be useful for the Nautilus file browser, but could be
* used by any program that wants to display the standard icon for a
* file.
*
* The most common usage is to get a NautilusIconFactory object with
* nautilus_get_current_icon_factory, then ask for an icon for a specific
* file with nautilus_icon_factory_get_icon_for_file. The caller can ask
* for any size icon, but normally will use one of the defined
* NAUTILUS_ICON_SIZE macros.
*/
/* Names for Nautilus's different zoom levels, from tiniest items to largest items */
typedef enum {
NAUTILUS_ZOOM_LEVEL_SMALLEST,
NAUTILUS_ZOOM_LEVEL_SMALLER,
NAUTILUS_ZOOM_LEVEL_SMALL,
NAUTILUS_ZOOM_LEVEL_STANDARD,
NAUTILUS_ZOOM_LEVEL_LARGE,
NAUTILUS_ZOOM_LEVEL_LARGER,
NAUTILUS_ZOOM_LEVEL_LARGEST
} NautilusZoomLevel;
/* Nominal icon sizes for each Nautilus zoom level.
* This scheme assumes that icons are designed to
* fit in a square space, though each image needn't
* be square. Since individual icons can be stretched,
* each icon is not constrained to this nominal size.
*/
#define NAUTILUS_ICON_SIZE_SMALLEST 12
#define NAUTILUS_ICON_SIZE_SMALLER 24
#define NAUTILUS_ICON_SIZE_SMALL 36
#define NAUTILUS_ICON_SIZE_STANDARD 48
#define NAUTILUS_ICON_SIZE_LARGE 72
#define NAUTILUS_ICON_SIZE_LARGER 96
#define NAUTILUS_ICON_SIZE_LARGEST 192
/* Icon size to use for menus. NAUTILUS_ICON_SIZE_SMALLEST
* is a little too small and NAUTILUS_ICON_SIZE_SMALLER is
* a little too big.
*/
#define NAUTILUS_ICON_SIZE_FOR_MENUS 20
typedef struct NautilusScalableIcon NautilusScalableIcon;
/* here's a structure to hold the emblem attach points */
#define MAX_ATTACH_POINTS 8
typedef struct {
int num_points;
GdkPoint points[MAX_ATTACH_POINTS];
} NautilusEmblemAttachPoints;
/* Instead of a class declaration here, I will just document
* the signals.
*
* "icons_changed", no parameters
*/
/* There's a single NautilusIconFactory object.
* The only thing you need it for is to connect to its signals.
*/
GtkObject * nautilus_icon_factory_get (void);
/* Relationship between zoom levels and icons sizes. */
guint nautilus_get_icon_size_for_zoom_level (NautilusZoomLevel zoom_level);
/* Choose the appropriate icon, but don't render it yet. */
NautilusScalableIcon *nautilus_icon_factory_get_icon_for_file (NautilusFile *file,
const char *modifier);
gboolean nautilus_icon_factory_is_icon_ready_for_file (NautilusFile *file);
GList * nautilus_icon_factory_get_required_file_attributes (void);
GList * nautilus_icon_factory_get_emblem_icons_for_file (NautilusFile *file,
EelStringList *exclude);
NautilusScalableIcon *nautilus_icon_factory_get_emblem_icon_by_name (const char *emblem_name);
/* Render an icon to a particular size.
* Ownership of a ref. count in this pixbuf comes with the deal.
* This allows scaling in both dimensions. All other calls assume
* that X and Y scaling are the same. Optionally, we also pass
* back an array of emblem attach points, if the pointer is non-null
* If the wants_default boolean is set, return a default icon instead
* of NULL if we can't find anything
*/
GdkPixbuf * nautilus_icon_factory_get_pixbuf_for_icon (NautilusScalableIcon *scalable_icon,
guint nominal_size_in_pixels_x,
guint nominal_size_in_pixels_y,
guint maximum_size_in_pixels_x,
guint maximum_size_in_pixels_y,
gboolean optimized_for_anti_aliasing,
NautilusEmblemAttachPoints *attach_points,
gboolean wants_default);
/* Convenience functions for the common case where you want to choose
* and render the icon into a pixbuf all at once.
*/
GdkPixbuf * nautilus_icon_factory_get_pixbuf_for_file (NautilusFile *file,
const char *modifer,
guint size_in_pixels,
gboolean optimized_for_anti_aliasing);
/* Convenience functions for legacy interfaces that require a pixmap and
* bitmap. Maybe we can get rid of these one day.
*/
void nautilus_icon_factory_get_pixmap_and_mask_for_file (NautilusFile *file,
const char *modifer,
guint size_in_pixels,
GdkPixmap **pixmap,
GdkBitmap **mask);
/* Convenience routine for getting a pixbuf from an icon name
*/
GdkPixbuf * nautilus_icon_factory_get_pixbuf_from_name (const char *icon_name,
const char *modifer,
guint size_in_pixels,
gboolean optimized_for_anti_aliasing);
/* Manage a scalable icon.
* Since the factory always passes out references to the same scalable
* icon, you can compare two scalable icons to see if they are the same
* with ==.
*/
void nautilus_scalable_icon_ref (NautilusScalableIcon *scalable_icon);
void nautilus_scalable_icon_unref (NautilusScalableIcon *scalable_icon);
/* A scalable icon can be decomposed into text and reconstituted later
* using nautilus_scalable_icon_new_from_text_pieces. This is the way
* to store scalable icons in metadata or other files.
*/
void nautilus_scalable_icon_get_text_pieces (NautilusScalableIcon *scalable_icon,
char **uri_return,
char **mime_type_return,
char **name_return,
char **modifier_return,
char **embedded_text_return);
/* Get a scalable icon using the earlier results of
* nautilus_scalable_icon_get_text_pieces.
*/
NautilusScalableIcon *nautilus_scalable_icon_new_from_text_pieces (const char *uri,
const char *mime_type,
const char *name,
const char *modifier,
const char *embedded_text);
/* Convenience function for freeing a list of scalable icons.
* Unrefs all the icons before freeing the list.
*/
void nautilus_scalable_icon_list_free (GList *scalable_icon_list);
#endif /* NAUTILUS_ICON_FACTORY_H */