dnrops
/
gimp
mirror of https://github.com/GNOME/gimp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
gimp/libgimpbase/gimpchoice.h

74 lines
3.0 KiB
C
Raw Normal View History

libgimpbase: new GimpChoice class meant to represent a list of allowed values. This will be used for creating limited lists of strings as argument types for procedures. Ideally enums are the best type for this, but it can only be used for generic libgimp* enum types, not custom enums created only for a given plug-in. For this, we currently just demote the args to ints which lose any semantic. A limited list of string will give back some semantic and some better validation, even though it's a tiny bit more annoying to work with strings than int types (at least in C).
2023-08-03 06:20:10 +08:00
/* LIBGIMP - The GIMP Library
* Copyright (C) 1995-2000 Peter Mattis and Spencer Kimball
*
* gimpchoice.h
* Copyright (C) 2023 Jehan
*
* 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 3 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 (__GIMP_BASE_H_INSIDE__) && !defined (GIMP_BASE_COMPILATION)
#error "Only <libgimpbase/gimpbase.h> can be included directly."
#endif
#ifndef __GIMP_CHOICE_H__
#define __GIMP_CHOICE_H__
G_BEGIN_DECLS
/* For information look into the C source or the html documentation */
#define GIMP_TYPE_CHOICE (gimp_choice_get_type ())
G_DECLARE_FINAL_TYPE (GimpChoice, gimp_choice, GIMP, CHOICE, GObject)
GimpChoice * gimp_choice_new (void);
GimpChoice * gimp_choice_new_with_values (const gchar *nick,
gint id,
const gchar *label,
const gchar *help,
...) G_GNUC_NULL_TERMINATED;
void gimp_choice_add (GimpChoice *choice,
const gchar *nick,
gint id,
const gchar *label,
const gchar *help);
gboolean gimp_choice_is_valid (GimpChoice *choice,
const gchar *nick);
GList * gimp_choice_list_nicks (GimpChoice *choice);
gint gimp_choice_get_id (GimpChoice *choice,
const gchar *nick);
const gchar * gimp_choice_get_label (GimpChoice *choice,
const gchar *nick);
const gchar * gimp_choice_get_help (GimpChoice *choice,
const gchar *nick);
gboolean gimp_choice_get_documentation (GimpChoice *choice,
const gchar *nick,
const gchar **label,
const gchar **help);
libgimpbase, libgimpwidgets: add a concept of insensitive choices in GimpChoice. This is used in the generated GUIs for GimpChoice arguments, but also for validation of property setting. New functions: * gimp_choice_set_sensitive() * gimp_string_combo_box_set_sensitivity()
2023-08-04 07:16:16 +08:00
void gimp_choice_set_sensitive (GimpChoice *choice,
const gchar *nick,
gboolean sensitive);
libgimpbase: new GimpChoice class meant to represent a list of allowed values. This will be used for creating limited lists of strings as argument types for procedures. Ideally enums are the best type for this, but it can only be used for generic libgimp* enum types, not custom enums created only for a given plug-in. For this, we currently just demote the args to ints which lose any semantic. A limited list of string will give back some semantic and some better validation, even though it's a tiny bit more annoying to work with strings than int types (at least in C).
2023-08-03 06:20:10 +08:00
G_END_DECLS
#endif /* __GIMP_CHOICE_H__ */