lib/prompt.h - master - githubmirror/libuser

lib/prompt.h
76 строк3 KB
Miloslav Trmač
Fix build with current gtk-doc, adding some documentation
25 июн 2015, 06:36
25 июн 2015, 06:367b26cef
/*
 * Copyright (C) 2000-2002 Red Hat, Inc.
 *
 * This is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Library 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 Library General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#ifndef libuser_prompt_h
#define libuser_prompt_h

#include <sys/types.h>
#include <glib.h>

G_BEGIN_DECLS

/**
 * lu_prompt:
 * @key: An invariant string of the form "module/name", which describes the
 *  information being prompted for.  The calling application may use this value
 *  as an index into a hash table used to cache answers to particular queries.
 * @prompt: The text of a prompt to display.  This *may* be translated for the
 *  current locale by a module.
 * @domain: The text domain which contains this prompt's translations.  This may
 *  be the default libuser domain, or a module-specific text domain which the
 *  module which provided this prompt bound for gettext when it was loaded.
 * @visible: Whether or not the user's response should be echoed to the screen
 *  (in a console app) or visible in an entry field (in a GUI app).
 * @default_value: A default value, given as a string.  This will only contain a
 *  value if the string is visible, but the reverse won't necessarily be true
 *  (default_value -> visible).
 * @value: The user's response.  This is set by the prompter function.
 * @free_value: A function which can free the user's response.  This is set by
 *  the prompter function.  If NULL, the response will not be freed, ever.
 *
 * The type of data passed to a prompter function.  The library uses these
 * when it needs to prompt the user for information.
 */
struct lu_prompt {
	const char *key;
	const char *prompt;
	const char *domain;
	gboolean visible;
	const char *default_value;
	char *value;
	void (*free_value) (void *);
};

/* A prompter function. */
typedef gboolean (lu_prompt_fn)(struct lu_prompt * prompts,
				int count,
				gpointer callback_data,
				struct lu_error ** error);

gboolean lu_prompt_console(struct lu_prompt *prompts,
			   int count,
			   gpointer callback_data,
			   struct lu_error **error);
gboolean lu_prompt_console_quiet(struct lu_prompt *prompts,
				 int count,
				 gpointer callback_data,
				 struct lu_error **error);

G_END_DECLS

#endif