libgnt/libgnt
Clone
Summary
Browse
Changes
Graph
Setup the devenv and bump the meson requirement to 0.58.0
20 months ago, Gary Kramlich
d72061c0dbf3
Setup the devenv and bump the meson requirement to 0.58.0
Testing Done:
changed some colorpairs in `build/config/gnt/gntrc` to verify that it was loading that file.
Reviewed at https://reviews.imfreedom.org/r/1571/
/*
* GNT - The GLib Ncurses Toolkit
*
* GNT is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT 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 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 General Public License along with
* this program; if not, see <https://www.gnu.org/licenses/>.
*/
#if !defined(GNT_GLOBAL_HEADER_INSIDE) && !defined(GNT_COMPILATION)
# error "only <gnt.h> may be included directly"
#endif
#ifndef GNT_ENTRY_H
#define GNT_ENTRY_H
#include
"gntcolors.h"
#include
"gntkeys.h"
#include
"gntwidget.h"
#define GNT_TYPE_ENTRY gnt_entry_get_type()
/**
* GNT_ENTRY_CHAR:
*
* The character to use to fill in the blank places.
*/
#define GNT_ENTRY_CHAR '_'
/**
* GntEntryFlag:
* @GNT_ENTRY_FLAG_ALPHA: Alphabetical characters are allowed.
* @GNT_ENTRY_FLAG_INT: Digit characters are allowed.
* @GNT_ENTRY_FLAG_NO_SPACE: No whitespace is allowed.
* @GNT_ENTRY_FLAG_NO_PUNCT: No punctuation is allowed.
* @GNT_ENTRY_FLAG_MASK: Mask the characters in the input display.
*
* Flags that control the behaviour of a #GntEntry.
*/
typedef
enum
{
GNT_ENTRY_FLAG_ALPHA
=
1
<<
0
,
GNT_ENTRY_FLAG_INT
=
1
<<
1
,
GNT_ENTRY_FLAG_NO_SPACE
=
1
<<
2
,
GNT_ENTRY_FLAG_NO_PUNCT
=
1
<<
3
,
GNT_ENTRY_FLAG_MASK
=
1
<<
4
,
}
GntEntryFlag
;
/**
* GNT_ENTRY_FLAG_ALL:
*
* Allow all characters in a #GntEntry.
*/
#define GNT_ENTRY_FLAG_ALL (GNT_ENTRY_FLAG_ALPHA | GNT_ENTRY_FLAG_INT)
G_BEGIN_DECLS
G_DECLARE_DERIVABLE_TYPE
(
GntEntry
,
gnt_entry
,
GNT
,
ENTRY
,
GntWidget
)
/**
* GntEntryClass:
* @text_changed: The class closure for the #GntEntry::text-changed signal.
*
* The class structure for #GntEntry.
*/
struct
_GntEntryClass
{
/*< private >*/
GntWidgetClass
parent
;
/*< public >*/
void
(
*
text_changed
)(
GntEntry
*
entry
);
/*< private >*/
gpointer
reserved
[
4
];
};
/**
* gnt_entry_new:
* @text: The text in the new entry box.
*
* Create a new GntEntry.
*
* Returns: The newly created entry box.
*/
GntWidget
*
gnt_entry_new
(
const
char
*
text
);
/**
* gnt_entry_set_max:
* @entry: The entry box.
* @max: The maximum length for text. A value of 0 means infinite length.
*
* Set the maximum length of the text in the entry box.
*/
void
gnt_entry_set_max
(
GntEntry
*
entry
,
int
max
);
/**
* gnt_entry_set_text:
* @entry: The entry box.
* @text: The text to set in the box.
*
* Set the text in an entry box.
*/
void
gnt_entry_set_text
(
GntEntry
*
entry
,
const
char
*
text
);
/**
* gnt_entry_set_flag:
* @entry: The entry box.
* @flag: The flags to set for the entry box.
*
* Set flags an entry box.
*/
void
gnt_entry_set_flag
(
GntEntry
*
entry
,
GntEntryFlag
flag
);
/**
* gnt_entry_get_text:
* @entry: The entry box.
*
* Get the text in an entry box.
*
* Returns: The current text in the entry box.
*/
const
char
*
gnt_entry_get_text
(
GntEntry
*
entry
);
/**
* gnt_entry_clear:
* @entry: The entry box.
*
* Clear the text in the entry box.
*/
void
gnt_entry_clear
(
GntEntry
*
entry
);
/**
* gnt_entry_set_masked:
* @entry: The entry box.
* @set: %TRUE if the text should be masked, %FALSE otherwise.
*
* Set whether the text in the entry box should be masked for display.
*/
void
gnt_entry_set_masked
(
GntEntry
*
entry
,
gboolean
set
);
/**
* gnt_entry_add_to_history:
* @entry: The entry box.
* @text: A new entry for the history list.
*
* Add a text to the history list for the text. The history length for the
* entry box needs to be set first by gnt_entry_set_history_length.
*/
void
gnt_entry_add_to_history
(
GntEntry
*
entry
,
const
char
*
text
);
/**
* gnt_entry_set_history_length:
* @entry: The entry box.
* @num: The maximum length of the history, -1 for unlimited.
*
* Set the length of history for the entry box.
*/
void
gnt_entry_set_history_length
(
GntEntry
*
entry
,
int
num
);
/**
* gnt_entry_set_word_suggest:
* @entry: The entry box.
* @word: %TRUE if the suggestions are for individual words, %FALSE otherwise.
*
* Set whether the suggestions are for the entire entry box, or for each
* individual word in the entry box.
*/
void
gnt_entry_set_word_suggest
(
GntEntry
*
entry
,
gboolean
word
);
/**
* gnt_entry_set_always_suggest:
* @entry: The entry box.
* @always: %TRUE if the suggestion list should always be displayed.
*
* Set whether to always display the suggestions list, or only when the
* tab-completion key is pressed (the TAB key, by default).
*/
void
gnt_entry_set_always_suggest
(
GntEntry
*
entry
,
gboolean
always
);
/**
* gnt_entry_add_suggest:
* @entry: The entry box.
* @text: An item to add to the suggestion list.
*
* Add an item to the suggestion list.
*/
void
gnt_entry_add_suggest
(
GntEntry
*
entry
,
const
char
*
text
);
/**
* gnt_entry_remove_suggest:
* @entry: The entry box.
* @text: The item to remove from the suggestion list.
*
* Remove an entry from the suggestion list.
*/
void
gnt_entry_remove_suggest
(
GntEntry
*
entry
,
const
char
*
text
);
G_END_DECLS
#endif
/* GNT_ENTRY_H */