/*

Miranda NG: the free IM client for Microsoft* Windows*

Copyright (C) 2012-21 Miranda NG team (https://miranda-ng.org)
Copyright (c) 2000-08 Miranda ICQ/IM project,
all portions of this codebase are copyrighted to the people
listed in contributors.txt.

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, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/

#ifndef M_OPTIONS_H__
#define M_OPTIONS_H__

#ifndef M_CORE_H__
#include <m_core.h>
#endif

/* Opt/Initialise
The user opened the options dialog. Modules should do whatever initialisation
they need and call opt/addpage one or more times if they want pages displayed
in the options dialog
wParam = addInfo
lParam = 0
addInfo should be passed straight to the wParam of opt/addpage
*/
#define ME_OPT_INITIALISE   "Opt/Initialise"

/* Opt/AddPage
Must only be called during an opt/initialise hook
Adds a page to the options dialog
wParam = addInfo
lParam = (LPARAM)(OPTIONSDIALOGPAGE*)odp
addInfo must have come straight from the wParam of opt/initialise
Pages in the options dialog operate just like pages in property sheets. See the
Microsoft documentation for details on how they operate.
Strings in the structure can be released as soon as the service returns, but
icons must be kept around. This is not a problem if you're loading them from a
resource.
Prior to v0.1.2.1 the options dialog would resize to fit the largest page, but
since then it is fixed in size. The largest page that fits neatly is 314x240
DLUs.
*/

// WARNING: do not use Translate(TS) for pszTitle, pszGroup or pszTab as they
// are translated by the core, which may lead to double translation.
// Use LPGEN instead which are just dummy wrappers/markers for "lpgen.pl".

struct OPTIONSDIALOGPAGE
{
	int position; // a position number, lower numbers are topmost
	MAllStrings szTitle, szGroup, szTab; // [TRANSLATED-BY-CORE]
	DLGPROC pfnDlgProc;
	char *pszTemplate;
	HPLUGIN pPlugin;
	DWORD flags;

	union {
		LPARAM dwInitParam; // a value to pass to lParam of WM_INITDIALOG message
		class CDlgBase *pDialog;
	};
};

#define ODPF_BOLDGROUPS     4   // give group box titles a bold font
#define ODPF_UNICODE        8   // string fields in OPTIONSDIALOGPAGE are wchar_t*
#define ODPF_USERINFOTAB    16  // options page is tabbed
#define ODPF_DONTTRANSLATE  32  // do not translate option page title

#define PSM_GETBOLDFONT   (WM_USER+102)   //returns HFONT used for group box titles

EXTERN_C MIR_APP_DLL(int) Options_AddPage(WPARAM wParam, OPTIONSDIALOGPAGE *odp, HPLUGIN);

EXTERN_C MIR_APP_DLL(void) KillModuleOptions(HPLUGIN);

// The behaviour if the options dialog is already open is that it will just be
// activated, the page won't be changed. This may change in the future.

// set pszGroup to NULL if it's a root item
// set pszPage to NULL to just open the options at no specific page
// set pszTab to NULL to just open the options at no specific tab

// Opens the options dialog, optionally at the specified page
// Returns 0 on success, nonzero on failure
EXTERN_C MIR_APP_DLL(void) Options_Open(const wchar_t *pszGroup, const wchar_t *pszPage, const wchar_t *pszTab, HPLUGIN);

// Opens the options dialog, with only specified page
EXTERN_C MIR_APP_DLL(void) Options_OpenPage(const wchar_t *pszGroup, const wchar_t *pszPage, const wchar_t *pszTab, HPLUGIN);

#endif  //M_OPTIONS_H__