Mercurial > pidgin3 / file comparison

comparison: libpurple/protocols/ircv3/purpleircv3parser.h

libpurple/protocols/ircv3/purpleircv3parser.h

changeset 42619
3dd7cd0eabf1
parent 42568
31e8c7c92e2f
equal deleted inserted replaced
42618:8546a023aa0a 42619:3dd7cd0eabf1
47 /** 47 /**
48 * purple_ircv3_parser_new: 48 * purple_ircv3_parser_new:
49 * 49 *
50 * Creates a new instance. 50 * Creates a new instance.
51 * 51 *
52 * Since: 3.0.0 52 * Since: 3.0
53 */ 53 */
54 PURPLE_IRCV3_AVAILABLE_IN_ALL 54 PURPLE_IRCV3_AVAILABLE_IN_ALL
55 PurpleIRCv3Parser *purple_ircv3_parser_new(void); 55 PurpleIRCv3Parser *purple_ircv3_parser_new(void);
56 56
57 /** 57 /**
60 * @handler: A [func@PurpleIRCv3.MessageHandler]. 60 * @handler: A [func@PurpleIRCv3.MessageHandler].
61 * 61 *
62 * Sets @handler to be called for any messages that @parser doesn't know how to 62 * Sets @handler to be called for any messages that @parser doesn't know how to
63 * handle. 63 * handle.
64 * 64 *
65 * Since: 3.0.0 65 * Since: 3.0
66 */ 66 */
67 PURPLE_IRCV3_AVAILABLE_IN_ALL 67 PURPLE_IRCV3_AVAILABLE_IN_ALL
68 void purple_ircv3_parser_set_fallback_handler(PurpleIRCv3Parser *parser, PurpleIRCv3MessageHandler handler); 68 void purple_ircv3_parser_set_fallback_handler(PurpleIRCv3Parser *parser, PurpleIRCv3MessageHandler handler);
69 69
70 /** 70 /**
76 * 76 *
77 * Parses @buffer with @parser. 77 * Parses @buffer with @parser.
78 * 78 *
79 * Returns: %TRUE if the buffer was parsed correctly or %FALSE with @error set. 79 * Returns: %TRUE if the buffer was parsed correctly or %FALSE with @error set.
80 * 80 *
81 * Since: 3.0.0 81 * Since: 3.0
82 */ 82 */
83 PURPLE_IRCV3_AVAILABLE_IN_ALL 83 PURPLE_IRCV3_AVAILABLE_IN_ALL
84 gboolean purple_ircv3_parser_parse(PurpleIRCv3Parser *parser, const gchar *buffer, GError **error, gpointer data); 84 gboolean purple_ircv3_parser_parse(PurpleIRCv3Parser *parser, const gchar *buffer, GError **error, gpointer data);
85 85
86 /** 86 /**
89 * @command: The command string. 89 * @command: The command string.
90 * @handler: (scope forever): The handler to call. 90 * @handler: (scope forever): The handler to call.
91 * 91 *
92 * Calls @handler every time @parser finds the command named @command. 92 * Calls @handler every time @parser finds the command named @command.
93 * 93 *
94 * Since: 3.0.0 94 * Since: 3.0
95 */ 95 */
96 PURPLE_IRCV3_AVAILABLE_IN_ALL 96 PURPLE_IRCV3_AVAILABLE_IN_ALL
97 void purple_ircv3_parser_add_handler(PurpleIRCv3Parser *parser, const char *command, PurpleIRCv3MessageHandler handler); 97 void purple_ircv3_parser_add_handler(PurpleIRCv3Parser *parser, const char *command, PurpleIRCv3MessageHandler handler);
98 98
99 /** 99 /**
103 * @...: A %NULL terminated list of string command names. 103 * @...: A %NULL terminated list of string command names.
104 * 104 *
105 * Like [method@Parser.add_handler] but allows you to add multiple commands at 105 * Like [method@Parser.add_handler] but allows you to add multiple commands at
106 * once that share a handler. 106 * once that share a handler.
107 * 107 *
108 * Since: 3.0.0 108 * Since: 3.0
109 */ 109 */
110 PURPLE_IRCV3_AVAILABLE_IN_ALL 110 PURPLE_IRCV3_AVAILABLE_IN_ALL
111 void purple_ircv3_parser_add_handlers(PurpleIRCv3Parser *parser, PurpleIRCv3MessageHandler handler, ...) G_GNUC_NULL_TERMINATED; 111 void purple_ircv3_parser_add_handlers(PurpleIRCv3Parser *parser, PurpleIRCv3MessageHandler handler, ...) G_GNUC_NULL_TERMINATED;
112 112
113 /** 113 /**
114 * purple_ircv3_parser_add_default_handlers: 114 * purple_ircv3_parser_add_default_handlers:
115 * @parser: The instance. 115 * @parser: The instance.
116 * 116 *
117 * Adds all of the default handlers to @parser. 117 * Adds all of the default handlers to @parser.
118 * 118 *
119 * Since: 3.0.0 119 * Since: 3.0
120 */ 120 */
121 PURPLE_IRCV3_AVAILABLE_IN_ALL 121 PURPLE_IRCV3_AVAILABLE_IN_ALL
122 void purple_ircv3_parser_add_default_handlers(PurpleIRCv3Parser *parser); 122 void purple_ircv3_parser_add_default_handlers(PurpleIRCv3Parser *parser);
123 123
124 G_END_DECLS 124 G_END_DECLS

Mercurial Repository: pidgin3

mercurial