filetypes.h

Go to the documentation of this file.

#ifndef __FILETYPES_H__
#define __FILETYPES_H__

/**
 * File Name  : filetypes.h
 *
 * Description: Content browser filetype specific utilities
 */

/*
 * This file is part of ctb.
 *
 * ctb 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.
 *
 * ctb 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, see <http://www.gnu.org/licenses/>.
 */

/**
 * Copyright (C) 2008 iRex Technologies B.V.
 * All rights reserved.
 */


//----------------------------------------------------------------------------
// Include Files
//----------------------------------------------------------------------------

#include <gdk/gdk.h>
#include <glib.h>

#include "filemodel.h"

G_BEGIN_DECLS


//----------------------------------------------------------------------------
// Macro Definitions
//---------------------------------------------------------------------------- 

#define FILE_EXT_DRZ             "drz"
#define FILE_EXT_SHORTCUT        "desktop"
#define FILE_EXT_SHORTCUT_TO_DIR "directory"

#define DIR_DRZ                  "System/drz"
#define DIR_SHORTCUTS            "System/Shortcuts"
#define DIR_NOTES                "Notes"
#define DIR_ADE_THUMBS           "Digital Editions/Thumbnails"


void filetypes_init(gboolean watch);

gboolean filetypes_showdir();

/**---------------------------------------------------------------------------
 *
 * Name :  get_icon_from_file_extension
 *
 * @brief  Get icon for specified file extension
 *
 * @param  [in]  file_ext - file extension for which icon is requested
 *                          or empty string
 * @param  [in]  is_directory - whether file_ext is a directory
 * @param  [in]  icon_size - specifies which icon is requested
 *
 * @return Pointer to pixbuf holding the requested icon
 *         or NULL on error.
 *         Lifetime of the pixbuf is guaranteed until the next call to this function,
 *         caller must g_object_ref() / _unref() the pixbuf when it needs the pixbuf longer than that.
 *
 *--------------------------------------------------------------------------*/
GdkPixbuf* get_icon_from_file_extension ( const gchar                 *file_ext,
                                          const gboolean              is_directory,
                                          const filemodel_thumbsize_t icon_size     );

GdkPixbuf* get_icon_from_file(const gchar* icon_name, filemodel_thumbsize_t icon_size);

GdkPixbuf* get_icon_delete_toggle(gboolean toggled, filemodel_thumbsize_t icon_size);

/**---------------------------------------------------------------------------
 *
 * Name :  get_icon_application
 *
 * @brief  Get icon for application (executable file)
 *
 * @param  [in]  icon_size - specifies which icon is requested
 *
 * @return Pointer to pixbuf holding the requested icon
 *         or NULL on error.
 *         Lifetime of the pixbuf is guaranteed until the next call to this function,
 *         caller must g_object_ref() / _unref() the pixbuf when it needs the pixbuf longer than that.
 *
 *--------------------------------------------------------------------------*/
GdkPixbuf* get_icon_application ( const filemodel_thumbsize_t icon_size );


/**---------------------------------------------------------------------------
 *
 * Name :  get_icon_library
 *
 * @brief  Get icon for library (SD card)
 *
 * @param  [in]  icon_size - specifies which icon is requested
 *
 * @return Pointer to pixbuf holding the requested icon
 *         or NULL on error.
 *         Lifetime of the pixbuf is guaranteed until the next call to this function,
 *         caller must g_object_ref() / _unref() the pixbuf when it needs the pixbuf longer than that.
 *
 *--------------------------------------------------------------------------*/
GdkPixbuf* get_icon_library ( const filemodel_thumbsize_t icon_size );


/**---------------------------------------------------------------------------
 *
 * Name :  apply_icon_overlay_shortcut
 *
 * @brief  Apply overlay for shortcuts to the given icon
 *
 * @param  [in]     icon_size - specifies which icon overlay is requested
 * @param  [in,out] icon - a pixbuf holding a bitmap of the icon to be modified
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void apply_icon_overlay_shortcut ( const filemodel_thumbsize_t icon_size,
                                         GdkPixbuf             *icon     );


void apply_icon_overlay_delete ( const filemodel_thumbsize_t icon_size,
                                 GdkPixbuf             *icon,
                                 gboolean toggled);

/**---------------------------------------------------------------------------
 *
 * Name :  get_type_descr_from_file_extension
 *
 * @brief  Get filetype description for specified file extension
 *
 * @param  [in]  file_ext - file extension for which a description is requested
 *                          or empty string
 * @param  [in]  is_directory - whether filename is a directory
 *
 * @return filetype description
 *         or NULL when no description for the specified file extension
 *
 *--------------------------------------------------------------------------*/
const gchar* get_type_descr_from_file_extension ( const gchar    *file_ext,
                                                  const gboolean is_directory);


/**---------------------------------------------------------------------------
 *
 * Name :  get_viewer_from_file_extension
 *
 * @brief  Get executable for viewer application to be used for specified file extension
 *
 * @param  [in]  file_ext - file extension for which viewer is requested
 *                          or empty string
 *
 * @return Command-line command for the requested viewer application
 *         or NULL when no viewer known for the specified filename
 *
 *--------------------------------------------------------------------------*/
const gchar* get_viewer_from_file_extension ( const gchar *file_ext );

/**---------------------------------------------------------------------------
 * Name :  get_generate_thumbnail
 * @brief  Get boolean to determine whether or not to generate thumbnail
 * @param  [in]  file_ext - file extension for which viewer is requested
 * @return Boolean, true to generate thumbnail, false for not
 *--------------------------------------------------------------------------*/
gboolean get_generate_thumbnail ( const gchar *file_ext );

/**---------------------------------------------------------------------------
 *
 * Name :  is_drz_file_extension
 *
 * @brief  Tell whether the specified file extension is a drz file or not
 *
 * @param  [in]  file_ext - file extension to be checked
 *                          or empty string
 *
 * @return TRUE  when file extension is a drz file or
 *         FALSE when file extension not a drz file, or error
 *
 *--------------------------------------------------------------------------*/
gboolean is_drz_file_extension ( const gchar *file_ext );

/**---------------------------------------------------------------------------
 *
 * Name :  is_shortcut_file_extension
 *
 * @brief  Tell whether the specified file extension is a shortcut file or not
 *
 * @param  [in]  file_ext - file extension to be checked
 *                          or empty string
 *
 * @return TRUE  when file extension is a shortcut file or
 *         FALSE when file extension not a shortcut file, or error
 *
 *--------------------------------------------------------------------------*/
gboolean is_shortcut_file_extension ( const gchar *file_ext );

gboolean is_shortcut_file(const char* filename);

// copied from libgnome-2.6.1.1 gnome-util.c:
/**---------------------------------------------------------------------------
 *
 * g_extension_pointer:
 * @param path A filename or file path.
 *
 * Extracts the extension from the end of a filename (the part after the final
 * '.' in the filename).
 *
 * Returns: A pointer to the extension part of the filename, or a
 * pointer to the end of the string if the filename does not
 * have an extension.
 *
 *--------------------------------------------------------------------------*/
const char* g_extension_pointer ( const char *path );


G_END_DECLS

#endif // __FILETYPES_H__