diff options
| author | Gary Kramlich <grim@reaperworld.com> | 2023-03-03 01:23:31 -0600 |
|---|---|---|
| committer | Gary Kramlich <grim@reaperworld.com> | 2023-03-03 01:23:31 -0600 |
| commit | 60320e741924bc697d663ae39e8be0b2a6e1ea91 (patch) | |
| tree | 9d95b96c04556122ebde77b549ed3296bc915a9f /libpurple/purpletyping.h | |
| parent | 3a1a92a38514e40c647169b71748c1f9bedc22a7 (diff) | |
| download | pidgin-60320e741924bc697d663ae39e8be0b2a6e1ea91.tar.gz | |
Add PurpleTypingState and add it as a property to PurpleConversationMember
This is a simple API to allow use to track typing state for contacts for any
conversation type. It also has built-in timeout support to reset a state back
to the PURPLE_TYPING_STATE_NONE if not other state changes have happened.
Testing Done:
Ran the unit tests and verified the docs.
Bugs closed: PIDGIN-17763
Reviewed at https://reviews.imfreedom.org/r/2288/
Diffstat (limited to 'libpurple/purpletyping.h')
| -rw-r--r-- | libpurple/purpletyping.h | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/libpurple/purpletyping.h b/libpurple/purpletyping.h new file mode 100644 index 0000000000..6a0cd8be19 --- /dev/null +++ b/libpurple/purpletyping.h @@ -0,0 +1,44 @@ +/* + * Purple - Internet Messaging Library + * Copyright (C) Pidgin Developers <devel@pidgin.im> + * + * This program 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(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION) +# error "only <pidgin.h> may be included directly" +#endif + +#ifndef PURPLE_TYPING_H +#define PURPLE_TYPING_H + +/** + * PurpleTypingState: + * @PURPLE_TYPING_STATE_NONE: The user is not currently typing and has nothing + * in their buffer. + * @PURPLE_TYPING_STATE_TYPING: The user is currently typing. + * @PURPLE_TYPING_STATE_PAUSED: The user has typed some text, but stopped + * without deleting it. + * + * Defines the state of a user composing a message. + * + * Since: 3.0.0 + */ +typedef enum { + PURPLE_TYPING_STATE_NONE, + PURPLE_TYPING_STATE_TYPING, + PURPLE_TYPING_STATE_PAUSED, +} PurpleTypingState; + +#endif /* PURPLE_TYPING_H */ |