/*
 * Pidgin - Internet Messenger
 * Copyright (C) Pidgin Developers <devel@pidgin.im>
 *
 * Pidgin 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(PIDGIN_GLOBAL_HEADER_INSIDE) && !defined(PIDGIN_COMPILATION)
# error "only <pidgin.h> may be included directly"
#endif

#ifndef PIDGIN_ACCOUNT_EDITOR_H
#define PIDGIN_ACCOUNT_EDITOR_H

#include <gtk/gtk.h>

#include <adwaita.h>

#include <purple.h>

#include "pidginversion.h"

/**
 * PidginAccountEditor:
 *
 * #PidginAccountEditor is a dialog that allows you to edit an account.
 *
 * Since: 3.0
 */

G_BEGIN_DECLS

#define PIDGIN_TYPE_ACCOUNT_EDITOR pidgin_account_editor_get_type()

PIDGIN_AVAILABLE_IN_3_0
G_DECLARE_FINAL_TYPE(PidginAccountEditor, pidgin_account_editor, PIDGIN,
                     ACCOUNT_EDITOR, AdwPreferencesPage)

/**
 * pidgin_account_editor_new:
 * @account: (nullable): The [class@Purple.Account] to edit.
 *
 * Creates a new account editor with the given account.
 *
 * If %NULL is given, a new account will created.
 *
 * Returns: (transfer full) (type PidginAccountEditor): The new account editor.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
GtkWidget *pidgin_account_editor_new(PurpleAccount *account);

/**
 * pidgin_account_editor_get_account:
 *
 * Gets the account.
 *
 * Returns: (transfer none) (nullable): The account.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
PurpleAccount *pidgin_account_editor_get_account(PidginAccountEditor *editor);

/**
 * pidgin_account_editor_set_account:
 * @account: (nullable): the account to edit
 *
 * Sets the account to edit.
 *
 * You can pass %NULL to remove the current account or edit a new account.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
void pidgin_account_editor_set_account(PidginAccountEditor *editor, PurpleAccount *account);

/**
 * pidgin_account_editor_get_valid:
 *
 * Gets whether or not the settings for the account are valid and can be saved.
 *
 * Returns: true if the account has valid values.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
gboolean pidgin_account_editor_get_valid(PidginAccountEditor *editor);

/**
 * pidgin_account_editor_get_account_name:
 *
 * Gets the account name that is being edited.
 *
 * Returns: (nullable): The account name.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
const char *pidgin_account_editor_get_account_name(PidginAccountEditor *editor);

/**
 * pidgin_account_editor_get_account_settings:
 *
 * Gets the account settings that are being edited.
 *
 * Returns: (transfer none): The account settings.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
PurpleAccountSettings *pidgin_account_editor_get_account_settings(PidginAccountEditor *editor);

/**
 * pidgin_account_editor_get_protocol:
 *
 * Gets the protocol that is selected in the editor.
 *
 * Returns: (transfer none): The selected protocol.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
PurpleProtocol *pidgin_account_editor_get_protocol(PidginAccountEditor *editor);

/**
 * pidgin_account_editor_get_show_advanced:
 *
 * Gets whether or not advanced settings should be shown.
 *
 * Returns: true if advanced settings are being shown.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
gboolean pidgin_account_editor_get_show_advanced(PidginAccountEditor *editor);

/**
 * pidgin_account_editor_save:
 *
 * Save the settings to the account.
 *
 * If this is a new account, it will be set to match the current global status
 * which is "online" in most cases.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
void pidgin_account_editor_save(PidginAccountEditor *editor);

/**
 * pidgin_account_editor_set_account_name:
 * @account_name: (nullable): the new account name
 *
 * Sets the account name to be edited.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
void pidgin_account_editor_set_account_name(PidginAccountEditor *editor, const char *account_name);

/**
 * pidgin_account_editor_set_protocol:
 * @protocol: (nullable): the new protocol
 *
 * Sets the selected protocol in the editor.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
void pidgin_account_editor_set_protocol(PidginAccountEditor *editor, PurpleProtocol *protocol);

/**
 * pidgin_account_editor_set_show_advanced:
 * @show_advanced: the new setting
 *
 * Sets whether or not advanced settings should be shown.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
void pidgin_account_editor_set_show_advanced(PidginAccountEditor *editor, gboolean show_advanced);

G_END_DECLS

#endif /* PIDGIN_ACCOUNT_EDITOR_H */
