summaryrefslogtreecommitdiff
path: root/libpurple/purplerequestgroup.h
diff options
context:
space:
mode:
authorElliott Sales de Andrade <quantum.analyst@gmail.com>2023-03-05 02:11:09 -0600
committerElliott Sales de Andrade <quantum.analyst@gmail.com>2023-03-05 02:11:09 -0600
commitb42150b099ccb8b8341a7e9776b3d43ccc92f840 (patch)
treee4b4920bf6f1fe5cff0c31c601420de693e6ba20 /libpurple/purplerequestgroup.h
parent0d228ccaec8541bdf2609d5247af48d4556ffa3f (diff)
downloadpidgin-b42150b099ccb8b8341a7e9776b3d43ccc92f840.tar.gz
Split PurpleRequestFieldGroup into its own files
As before, this uses `hg cp`, so it _looks_ like a bunch of deletion. Again, there's a bit of private API for the cross-struct access, which should go away later. I also dropped 'field' from the file name, as it seems like there's no need to have that there in the final class name. I did not do any other API changes to make this a simpler review. Testing Done: Compiled and opened Request Fields from the Demo. Reviewed at https://reviews.imfreedom.org/r/2316/
Diffstat (limited to 'libpurple/purplerequestgroup.h')
-rw-r--r--libpurple/purplerequestgroup.h109
1 files changed, 109 insertions, 0 deletions
diff --git a/libpurple/purplerequestgroup.h b/libpurple/purplerequestgroup.h
new file mode 100644
index 0000000000..09dc4a3a3e
--- /dev/null
+++ b/libpurple/purplerequestgroup.h
@@ -0,0 +1,109 @@
+/*
+ * Purple - Internet Messaging Library
+ * Copyright (C) Pidgin Developers <devel@pidgin.im>
+ *
+ * Purple 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 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 <purple.h> may be included directly"
+#endif
+
+#ifndef PURPLE_REQUEST_GROUP_H
+#define PURPLE_REQUEST_GROUP_H
+
+#include <stdlib.h>
+
+#include <glib.h>
+#include <glib-object.h>
+
+/**
+ * PurpleRequestFieldGroup:
+ *
+ * A group of fields with a title.
+ */
+typedef struct _PurpleRequestFieldGroup PurpleRequestFieldGroup;
+
+#include "purplerequestfield.h"
+
+G_BEGIN_DECLS
+
+/**
+ * purple_request_field_group_new:
+ * @title: The optional title to give the group.
+ *
+ * Creates a fields group with an optional title.
+ *
+ * Returns: (transfer full): A new fields group
+ */
+PurpleRequestFieldGroup *purple_request_field_group_new(const char *title);
+
+/**
+ * purple_request_field_group_destroy:
+ * @group: The group to destroy.
+ *
+ * Destroys a fields group.
+ */
+void purple_request_field_group_destroy(PurpleRequestFieldGroup *group);
+
+/**
+ * purple_request_field_group_add_field:
+ * @group: The group to add the field to.
+ * @field: The field to add to the group.
+ *
+ * Adds a field to the group.
+ */
+void purple_request_field_group_add_field(PurpleRequestFieldGroup *group,
+ PurpleRequestField *field);
+
+/**
+ * purple_request_field_group_get_title:
+ * @group: The group.
+ *
+ * Returns the title of a fields group.
+ *
+ * Returns: The title, if set.
+ */
+const char *purple_request_field_group_get_title(
+ const PurpleRequestFieldGroup *group);
+
+/**
+ * purple_request_field_group_get_fields:
+ * @group: The group.
+ *
+ * Returns a list of all fields in a group.
+ *
+ * Returns: (element-type PurpleRequestField) (transfer none): The list of fields in the group.
+ */
+GList *purple_request_field_group_get_fields(
+ const PurpleRequestFieldGroup *group);
+
+/**
+ * purple_request_field_group_get_fields_list:
+ * @group: The group.
+ *
+ * Returns a list of all fields in a group.
+ *
+ * Returns: (transfer none): The list of fields in the group.
+ */
+PurpleRequestFields *purple_request_field_group_get_fields_list(
+ const PurpleRequestFieldGroup *group);
+
+G_END_DECLS
+
+#endif /* PURPLE_REQUEST_GROUP_H */