ctb/include/menu.h

Go to the documentation of this file.

#ifndef __MENU_H__
#define __MENU_H__

/**
 * File Name  : menu.h
 *
 * Description: Control the popup menus of the content browser
 */

/*
 * 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 "filemodel.h"
#include "fileview.h"

G_BEGIN_DECLS

// menus for content browser
#define MENU_CONTENT             "ctb_menu_content"
#define MENU_CONTENT_MEDIA       "ctb_menu_content_media"
#define MENU_CONTENT_DELETE_MODE "ctb_menu_delete_mode"
#define MENU_CONTENT_RECENT_MODE "ctb_menu_recent_mode"

//============================================================================
// Public Functions
//============================================================================

/**---------------------------------------------------------------------------
 *
 * Name :  menu_init
 *
 * @brief  Initialise popup menus for content browser
 *
 * @param  --
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void menu_init();


/**---------------------------------------------------------------------------
 *
 * Name :  menu_set_text
 *
 * @brief  Initialise text items in popup menus for content browser
 *
 * @param  --
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void menu_set_text();


/**---------------------------------------------------------------------------
 *
 * Name :  menu_show
 *
 * @brief  Set the context menu to show in the popup menu
 *
 * @param  --
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void menu_show();

void menu_hide();


/**---------------------------------------------------------------------------
 *
 * Name :  menu_select_view_type
 *
 * @brief  Set the specified option in the "View" group to selected
 *
 * @param  [in] view_type - currently active view type
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void menu_select_view_type (ctb_viewtypes_t view_type);


void menu_update_view_mode(ctb_viewmodes_t view_mode);


/**---------------------------------------------------------------------------
 *
 * Name :  menu_select_sort_order
 *
 * @brief  Set the specified option in the "Sort" group to selected
 *
 * @param  [in] sort_order - currently active sorting order
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void menu_select_sort_order(const ctb_sort_order_t sort_order);


/**---------------------------------------------------------------------------
 *
 * Name :  menu_set_current_is_media
 *
 * @brief  Specifies whether to show "special" menu for media or not.
 *
 * @param  [in] is_desktop - whether or not to show the "media" menu
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void menu_set_current_is_media(const gboolean is_media);


void menu_set_category(const char* name);


//----------------------------------------------------------------------------
// Callbacks from popupmenu
//----------------------------------------------------------------------------

/**---------------------------------------------------------------------------
 *
 * Name :  menu_on_goto_location
 *
 * @brief  Go to the specified location
 *
 * @param  [in] location - location to display
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void menu_on_goto_location(const gchar *location);


/**---------------------------------------------------------------------------
 *
 * Name :  menu_on_item_activated
 *
 * @brief  Handle a menu button that has been pressed by the user
 *
 * @param  [in] item  - item name of the activated item
 * @param  [in] group - name of the parent group of the activated item
 * @param  [in] menu  - name of the current menu
 * @param  [in] state - state of the item when activated
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void menu_on_item_activated(const gchar *item,
                            const gchar *group,
                            const gchar *menu,
                            const gchar *state);

G_END_DECLS

#endif