Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

prpl.h File Reference

Protocol Plugin functions. More...

#include "blist.h"
#include "proxy.h"
#include "plugin.h"

Include dependency graph for prpl.h:

Include dependency graph

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Go to the source code of this file.

Data Structures

struct  _GaimPluginProtocolInfo
 A protocol plugin information structure. More...


Basic Protocol Information

#define GAIM_PRPL_DESC(x)
 Default protocol plugin description.

#define GAIM_PROTO_DEFAULT   "prpl-oscar"
 Default protocol.

enum  GaimProtocol {
  GAIM_PROTO_TOC = 0, GAIM_PROTO_OSCAR, GAIM_PROTO_YAHOO, GAIM_PROTO_ICQ,
  GAIM_PROTO_MSN, GAIM_PROTO_IRC, GAIM_PROTO_FTP, GAIM_PROTO_VGATE,
  GAIM_PROTO_JABBER, GAIM_PROTO_NAPSTER, GAIM_PROTO_ZEPHYR, GAIM_PROTO_GADUGADU,
  GAIM_PROTO_SAMETIME, GAIM_PROTO_TLEN, GAIM_PROTO_RVP, GAIM_PROTO_BACKRUB,
  GAIM_PROTO_MOO, GAIM_PROTO_ELVIN, GAIM_PROTO_TREPIA, GAIM_PROTO_BATTLENET,
  GAIM_PROTO_SSCP, GAIM_PROTO_BLOGGER, GAIM_PROTO_UNTAKEN
}
 Protocol types and numbers. More...


Defines

#define GAIM_AWAY_CUSTOM   _("Custom")
 Custom away message.

#define GAIM_IS_PROTOCOL_PLUGIN(plugin)   ((plugin)->info->type == GAIM_PLUGIN_PROTOCOL)
#define GAIM_PLUGIN_PROTOCOL_INFO(plugin)   ((GaimPluginProtocolInfo *)(plugin)->info->extra_info)
#define GAIM_PRPL_API_VERSION   2

Typedefs

typedef _GaimPluginProtocolInfo GaimPluginProtocolInfo

Enumerations

enum  GaimConvImFlags { GAIM_CONV_IM_AUTO_RESP = 0x0001, GAIM_CONV_IM_IMAGES = 0x0002 }
 Flags applicable to outgoing/incoming IMs from prpls. More...

enum  GaimProtocolOptions {
  OPT_PROTO_CORRECT_TIME = 0x00000002, OPT_PROTO_UNIQUE_CHATNAME = 0x00000004, OPT_PROTO_CHAT_TOPIC = 0x00000008, OPT_PROTO_NO_PASSWORD = 0x00000010,
  OPT_PROTO_MAIL_CHECK = 0x00000020, OPT_PROTO_BUDDY_ICON = 0x00000040, OPT_PROTO_IM_IMAGE = 0x00000080, OPT_PROTO_PASSWORD_OPTIONAL = 0x00000100,
  OPT_PROTO_USE_POINTSIZE = 0x00000200
}
 Protocol options. More...


Functions

const char * gaim_prpl_num_to_id (GaimProtocol protocol)
 Returns the plugin ID for a protocol number.

GaimProtocol gaim_prpl_id_to_num (const char *id)
 Returns the plugin number for a protocol ID.

GaimPlugingaim_find_prpl (const char *id)
 Finds a protocol plugin structure of the specified type.


Detailed Description

Protocol Plugin functions.

gaim

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


Define Documentation

#define GAIM_PRPL_DESC  ) 
 

Value:

"Allows gaim to use the " (x) " protocol.\n\n"      \
        "Now that you have loaded this protocol, use the "  \
        "Account Editor to add an account that uses this "  \
        "protocol. You can access the Account Editor from " \
        "the \"Accounts\" button on the login window or "   \
        "in the \"Tools\" menu in the buddy list window."
Default protocol plugin description.


Enumeration Type Documentation

enum GaimConvImFlags
 

Flags applicable to outgoing/incoming IMs from prpls.

Enumeration values:
GAIM_CONV_IM_AUTO_RESP  Auto response.
GAIM_CONV_IM_IMAGES  Contains images.

enum GaimProtocol
 

Protocol types and numbers.

Do not assume a new protocol number without talking to Rob Flynn or Sean Egan first!

Enumeration values:
GAIM_PROTO_TOC  AIM TOC protocol.
GAIM_PROTO_OSCAR  AIM OSCAR protocol.
GAIM_PROTO_YAHOO  Yahoo Messenger protocol.
GAIM_PROTO_ICQ  Outdated ICQ protocol.
GAIM_PROTO_MSN  MSN Messenger protocol.
GAIM_PROTO_IRC  IRC protocol.
GAIM_PROTO_FTP  FTP protocol.
GAIM_PROTO_VGATE  VGATE protocol.
GAIM_PROTO_JABBER  Jabber protocol.
GAIM_PROTO_NAPSTER  Napster/OpenNAP protocol.
GAIM_PROTO_ZEPHYR  MIT Zephyr protocol.
GAIM_PROTO_GADUGADU  Gadu-Gadu protocol.
GAIM_PROTO_SAMETIME  SameTime protocol.
GAIM_PROTO_TLEN  TLEN protocol.
GAIM_PROTO_RVP  RVP protocol.
GAIM_PROTO_BACKRUB  Instant Massager protocol.
GAIM_PROTO_MOO  MOO protocol.
GAIM_PROTO_ELVIN  Elvin Protocol.
GAIM_PROTO_TREPIA  Trepia IM protocol.
GAIM_PROTO_BATTLENET  Battle.NET protocol.
GAIM_PROTO_SSCP  SSCP (ConfMgr) protocol.
GAIM_PROTO_BLOGGER  Blogger xml-rpc protocol.
GAIM_PROTO_UNTAKEN  Untaken protocol number.

enum GaimProtocolOptions
 

Protocol options.

These should all be stuff that some plugins can do and others can't.

Enumeration values:
OPT_PROTO_CORRECT_TIME  Synchronize the time between the local computer and the server.

TOC and Oscar have signon time, and the server's time needs to be adjusted to match your computer's time.

We wouldn't need this if everyone used NTP.

OPT_PROTO_UNIQUE_CHATNAME  Use a unique name, not an alias, for chat rooms.

Jabber lets you choose what name you want for chat. So it shouldn't be pulling the alias for when you're in chat; it gets annoying.

OPT_PROTO_CHAT_TOPIC  Chat rooms have topics.

IRC and Jabber support this.

OPT_PROTO_NO_PASSWORD  Don't require passwords for sign-in.

Zephyr doesn't require passwords, so there's no need for a password prompt.

OPT_PROTO_MAIL_CHECK  Notify on new mail.

MSN and Yahoo notify you when you have new mail.

OPT_PROTO_BUDDY_ICON  Buddy icon support.

Oscar and Jabber have buddy icons.

OPT_PROTO_IM_IMAGE  Images in IMs.

Oscar lets you send images in direct IMs.

OPT_PROTO_PASSWORD_OPTIONAL  Allow passwords to be optional.

Passwords in IRC are optional, and are needed for certain functionality.

OPT_PROTO_USE_POINTSIZE  Allows font size to be specified in sane point size.

Probably just Jabber and Y!M


Function Documentation

GaimPlugin* gaim_find_prpl const char *  id  ) 
 

Finds a protocol plugin structure of the specified type.

Parameters:
type The protocol plugin;

GaimProtocol gaim_prpl_id_to_num const char *  id  ) 
 

Returns the plugin number for a protocol ID.

Parameters:
id The protocol ID.
Returns:
The protocol ID for valid protocol plugin IDs.

const char* gaim_prpl_num_to_id GaimProtocol  protocol  ) 
 

Returns the plugin ID for a protocol number.

Parameters:
protocol The protocol number.
Returns:
The plugin ID for those numbers that support it.


Generated on Tue Aug 3 17:36:43 2004 for gaim by doxygen 1.3.4