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  GaimBuddyIconSpec
 A description of a Buddy Icon specification. More...
struct  proto_chat_entry
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.

Defines

#define NO_BUDDY_ICONS   {NULL, 0, 0, 0, 0, 0}
#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)

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  GaimConvChatFlags { GAIM_CONV_CHAT_WHISPER = 0x0001, GAIM_CONV_CHAT_DELAYED = 0x0002 }
enum  GaimIconScaleRules { GAIM_ICON_SCALE_DISPLAY = 0x01, GAIM_ICON_SCALE_SEND = 0x02 }
enum  GaimProtocolOptions {
  OPT_PROTO_UNIQUE_CHATNAME = 0x00000004, OPT_PROTO_CHAT_TOPIC = 0x00000008, OPT_PROTO_NO_PASSWORD = 0x00000010, OPT_PROTO_MAIL_CHECK = 0x00000020,
  OPT_PROTO_IM_IMAGE = 0x00000080, OPT_PROTO_PASSWORD_OPTIONAL = 0x00000100, OPT_PROTO_USE_POINTSIZE = 0x00000200, OPT_PROTO_NO_NORMALIZE_CONV = 0x00000400
}
 Protocol options. More...

Functions

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 GaimConvChatFlags
 

Enumeration values:
GAIM_CONV_CHAT_WHISPER  Whispered message.
GAIM_CONV_CHAT_DELAYED  Delayed message.

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 GaimIconScaleRules
 

Enumeration values:
GAIM_ICON_SCALE_DISPLAY  We scale the icon when we display it.
GAIM_ICON_SCALE_SEND  We scale the icon before we send it to the server.

enum GaimProtocolOptions
 

Protocol options.

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

Enumeration values:
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_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

OPT_PROTO_NO_NORMALIZE_CONV  Don't normalize buddy names for conversations.

Probably just Jabber (so resources don't get stripped)


Function Documentation

GaimPlugin* gaim_find_prpl const char *  id  ) 
 

Finds a protocol plugin structure of the specified type.

Parameters:
id The protocol plugin;


Generated on Sun Jun 5 18:07:53 2005 for gaim by  doxygen 1.3.9.1