GG.h

/*
  nazwa="GG API"
  data="2003-04-25"
  ver="1.1"
  info="Nagłówek wtyczki GG."
*/


/** @file Nagłówek wtyczki GG.DLL 


*/
/** @defgroup GG_shared_h Wtyczka GG.dll.

W API od wersji 1.1 znajduje się obsługa zdarzeń w libgadu. 
Potrzebne będą również przynajmniej nagłówki libgadu, które dostępne jest do pobrania
na stronie domowej SDK.

Poniższy przykład powinien wszystko wyjaśnić...
@code
    #include "gg_shared.h"
    // (...)
	// Gdzieś w kodzie "rejestrujemy" naszą wtyczkę. Np. w #IM_START
	IMessage(IM_GG_REGISTERHANDLER,NET_GG,IMT_PROTOCOL,GGER_LOGIN|GGER_EVENT);
	// Dzięki GGER_LOGIN będziemy mogli zmienić parametry logowania do 
	// poszczególnych serwerów, a GGER_EVENT przyśle każdą odpowiedź serwera.
	// Możliwości jest jeszcze kilka...

	// W IMessageProc musimy jeszcze obsłużyć #IM_GG_EVENT
	case IM_GG_EVENT: {
		sIMessage_GGEvent * me = static_cast<sIMessage_GGEvent*>(msgBase);
		// W zależności od typu zdarzenia wykonujemy różne operacje
		switch (me->event_type) {
		    // (...)
		}
		break;}
	// Jeżeli będziemy chcieli gdzieś w kodzie skorzystać z sesji libgadu to:
	gg_session * sess = IMessage(IM_GG_GETSESSION,NET_GG,IMT_PROTOCOL); // Pobieramy sesję
	if (sess) {
		// (...) operacje na sesji z wykorzystaniem libgaduw32.dll
		// Każdą pobraną sesję TRZEBA zwolnić, ale TYLKO gdy zwrócona sesja jest != 0
		IMessage(IM_GG_RELEASESESSION,NET_GG,IMT_PROTOCOL);
	}
@endcode    
@{
*/

#pragma once

#pragma pack(push, 1)

/** Zwraca wskaźnik do sesji libgadu (gg_session) lub 0
    gdy nie ma ustanowionego połączenia. Po zakończeniu
	operowania na sesji trzeba wywołać #IM_GG_RELEASESESSION.
	
	Do samego sprawdzania istnienia połączenia najlepiej posłuży
	#IM_ISCONNECTED.

	@return (gg_session*) Wskaźnik sesji.
	*/
#define IM_GG_GETSESSION IM_USER+10001 
/** Zwalnia pobrany wcześniej wskaźnik sesji... */
#define IM_GG_RELEASESESSION IM_USER+10002

/** Wtyczka będzie otrzymywała powiadomienia przy wybranych
    zdarzeniach w libgadu.

	@param (int) połączone flagi GGER_ oznaczające o jakich zdarzeniach wtyczka powinna być powiadamiana.
*/
#define IM_GG_REGISTERHANDLER IM_USER+10003

enum GGER_enum {
   GGER_LOGIN = 1, ///< Zaraz przed nawiązaniem połączenia. Można je anulować przez GGERF_ABORT
   GGER_LOGGEDIN = 2, ///< Udane logowanie
   GGER_LOGOUT = 4, ///< Zakończenie połączenia
   GGER_EVENT = 8, ///< Zdarzenie sieciowe
   GGER_FIRSTLOOP = 0x10, ///< Po zalogowaniu i przesłaniu wszystkich informacji (lista kontaktów, status itp.)
   GGER_BEFORELOGIN = 0x20, ///< Zaraz przed rozpoczęciem procedury logowania (i przed określeniem IP serwera)
   GGER_BEFORELOGOUT = 0x40, ///< Zaraz przed zakończeniem połączenia (nie zostanie wywołane w razie zerwania połączenia)
};

#define GGERF_ABORT 1  ///< Przerwanie obsługiwania Eventu...
/** Wtyczka, która zarejestrowała się jako handler otrzyma
    ten komunikat w razie wystąpienia któregoś z "zamówionych"
	zdarzeń. Komunikat będzie typu sIMessage_GGEvent.

	@return Połączone flagi GGERF_ , lub 0.
*/
#define IM_GG_EVENT IM_USER+10100

/** Struktura do przesyłania IM_GG_EVENT */
struct sIMessage_GGEvent: public sIMessage_base {
	GGER_enum eventType;   ///< Typ zdarzenia - jedna z flag GGER_
	/** W zależności od typu zdarzenia w data
	    przekazywana jest odpowiednia strukturka, lub 0.
		Większość przekazywanych struktur można modyfikować.
		Zdarzenia najczęściej wywoływane są PRZED wykonaniem
		samej operacji...
		*/
	union {
       struct gg_login_params * login_params; ///< Parametry logowania [GGER_LOGIN , GGER_BEFORELOGIN]
	   struct gg_event * event; ///< Zdarzenie sieciowe [GGER_EVENT]
	   void * pointer;
	} data;
	sIMessage_GGEvent()
		:sIMessage_base() {s_size=sizeof(sIMessage_GGEvent);}
};

#define IM_GG_HTMLTOMSG IM_USER+10010
#define IM_GG_MSGTOHTML IM_USER+10011


struct sIMessage_GGHtmlFormat: public sIMessage_base {
	sIMessage_GGHtmlFormat(bool fromHtml, const char* body, char* format, int formatSize):body(body), format(format), formatSize(formatSize), result(0) {
		this->id = fromHtml ? IM_GG_HTMLTOMSG : IM_GG_MSGTOHTML;
		s_size=sizeof(*this);
	}

	const char* body;
	const char* result;
	char* format;
	int formatSize;
};


#define CFG_GG_LOGIN    1053
#define CFG_GG_PASS     1054
#define CFG_GG_STATUS   1055 //INT 
#define CFG_GG_STARTSTATUS 1056 //INT
#define CFG_GG_DESCR   1057 //INT
#define CFG_GG_SERVER  1059  
#define CFG_GG_SERVERCHOSEN  1060
#define CFG_GG_TRAYMENU 1061

#define CFG_GG_FRIENDSONLY 1058  //INT
#define CFG_GG_USESSL  1063
#define CFG_GG_DONTRESUMEDISCONNECTED 1064

#define IMIA_GGSTATUS_OFFLINE 1001
#define IMIA_GGSTATUS_ONLINE 1002
#define IMIA_GGSTATUS_AWAY 1003
#define IMIA_GGSTATUS_HIDDEN 1004
#define IMIA_GGSTATUS_DESC   1005

#define IMIG_GGSTATUS_SERVER 1020

#define IMIG_MAIN_OPTIONS_LIST_GG 1010
#define IMIA_LIST_GG_IMPORT 1011
#define IMIA_LIST_GG_EXPORT 1012
#define IMIA_LIST_GG_CLEAR  1013
#define IMIA_LIST_GG_REFRESH 1014

#define IMIA_GGHIDESTATUS 1015

#define IMIA_NFO_GGSAVE   1022
#define IMIA_NFO_GGREFRESH   1021


#define IMIG_GGSTATUS 1000

#define IMIG_GGCFG_USER 1050
#define IMIC_GG_ACCOUNT  1051
#define IMIC_GG_NEWPASS  1052
#define IMIC_GG_REMINDPASS 1053
#define IMIC_GG_DEFSERVERS 1054
#define IMIC_GG_REMOVEACCOUNT  1055
#define IMIC_GG_SERVERSSSLONLY 1056
//#define IMIC_GG_PORT  1052
//#define IMIC_GG_LOGIN  1053
//#define IMIC_GG_PASS  1054

#pragma pack(pop)

/**@}*/