/*
 * Copyright (C) Birb Developers
 *
 * Birb is the legal property of its developers, whose names are too numerous
 * to list here. Please refer to the AUTHORS file distributed with this source
 * distribution
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 *
 * This 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 Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, see <https://www.gnu.org/licenses/>.
 */

#if !defined(BIRB_GLOBAL_HEADER_INSIDE) && !defined(BIRB_COMPILATION)
# error "only <birb.h> may be included directly"
#endif

#ifndef BIRB_MENU_H
#define BIRB_MENU_H

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

#include "birbversion.h"

G_BEGIN_DECLS

/**
 * BIRB_MENU_ATTRIBUTE_DYNAMIC_TARGET:
 *
 * A constant to help when defining actions that have a dynamic-target value.
 *
 * Since: 0.6
 */
#define BIRB_MENU_ATTRIBUTE_DYNAMIC_TARGET "dynamic-target"

/**
 * BirbMenuWalkFunc:
 * @model: The current [class@Gio.MenuModel] being walked.
 * @index: The index of the item.
 * @data: User data.
 *
 * Used as a parameter to [func@Birb.menu_walk]. While walking, @model will
 * be updated to point to the current section or submenu and will only be the
 * model that was passed to [func@Birb.menu_walk] or its immediate
 * children.
 *
 * Since: 0.6
 */
BIRB_AVAILABLE_TYPE_IN_0_6
typedef void (*BirbMenuWalkFunc)(GMenuModel *model, int index, gpointer data);

/**
 * birb_menu_walk:
 * @model: A [class@Gio.MenuModel] to walk.
 * @func: (scope call): The function to call.
 * @data: User data to pass for func.
 *
 * Recursively calls @func for each item in @model and all of its children.
 *
 * Since: 0.6
 */
BIRB_AVAILABLE_IN_0_6
void birb_menu_walk(GMenuModel *model, BirbMenuWalkFunc func, gpointer data);

/**
 * birb_menu_populate_dynamic_targets:
 * @menu: The menu instance to modify.
 * @first_property: The name of the first property of dynamic targets to
 *                  replace.
 * @...: The value of the first property, followed optionally by more
 *       name/value pairs, followed by %NULL.
 *
 * Updates @menu by adding a target property when an item with an attribute
 * named "dynamic-target" is found.
 *
 * The value for the target is set to the matching value from the passed in
 * parameters.
 *
 * For example, if you need to set the target to an identifier, you would set
 * the "dynamic-target" attribute of your menu item to "id" and then call
 * [func@menu_populate_dynamic_targets] with a property pair of "id" and the
 * id to set.
 *
 * Since: 0.6
 */
BIRB_AVAILABLE_IN_0_6
void birb_menu_populate_dynamic_targets(GMenu *menu, const char *first_property, ...) G_GNUC_NULL_TERMINATED;

/**
 * birb_menu_populate_dynamic_targetsv: (rename-to birb_menu_populate_dynamic_targets):
 * @menu: The menu instance to modify.
 * @properties: (element-type utf8 utf8): A hash table where the keys are the
 *              names of the properties of dynamic targets to be replaced, and
 *              the values are the replacements.
 *
 * Updates @menu by adding a target property when an item with an attribute
 * named "dynamic-target" is found.
 *
 * The value for the target is set to the matching value from @properties.
 *
 * For example, if you need to set the target to an identifier, you would set
 * the "dynamic-target" attribute of your menu item to "id" and then call
 * [func@menu_populate_dynamic_targetsv] with a hash table containing the
 * key `"id"` and a value of the specific id.
 *
 * Since: 0.6
 */
BIRB_AVAILABLE_IN_0_6
void birb_menu_populate_dynamic_targetsv(GMenu *menu, GHashTable *properties);

/**
 * birb_menu_copy:
 * @model: The [class@Gio.MenuModel] instance to copy.
 *
 * Creates a full copy of @model as a new [class@Gio.Menu]. If @model was not
 * a [class@Gio.Menu] instance, any additional functionality will be lost.
 *
 * Returns: (transfer full): The new menu.
 *
 * Since: 0.6
 */
BIRB_AVAILABLE_IN_0_6
GMenu *birb_menu_copy(GMenuModel *model);

G_END_DECLS

#endif /* BIRB_MENU_H */
