|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRCUI
Access to parts of the IRC user interface, such as chat windows and the like.
Method Summary | |
---|---|
GeneralChatWindow |
createGeneralChatWindow(PluginContext owner,
GeneralChatWindow.Handler h,
java.lang.String logSource,
java.lang.String logCategory,
java.lang.String logItem,
int availableBytes,
java.lang.String ownNick,
java.lang.String target,
boolean startMinimised)
Creates a new chat window. |
MessageDisplay |
getMessageDisplay(Server s)
Obtains a MessageDisplay object which can be used to add text to the current window for a given server. |
Method Detail |
---|
MessageDisplay getMessageDisplay(Server s)
s
- Server to display messages for (may be null)
GeneralChatWindow createGeneralChatWindow(PluginContext owner, GeneralChatWindow.Handler h, java.lang.String logSource, java.lang.String logCategory, java.lang.String logItem, int availableBytes, java.lang.String ownNick, java.lang.String target, boolean startMinimised)
GeneralChatWindow
must be used to
make the window display things.
owner
- Context that owns window. If this plugin is unloaded, the
window will automatically close itselfh
- Callback that handles command entry from the windowlogSource
- Source for log address. Usually a server address but
can be something else. Use null to prevent logginglogCategory
- Category of thing for log. Logger.CATEGORY_xx constant
or custom namelogItem
- Item name for log. For Logger.CATEGORY_USER, must be nick;
for CATEGORY_CHAN, must be channel. For custom types can be anything
appropriateavailableBytes
- Number of bytes allowed per line of text (best
to include a safe margin), used for auto-wrapping text. Applies only to
text not to /-commands which are auto-limited at 400 odd.ownNick
- User's own nick for purposes of this window (display own
messages)target
- Target's nick (or other identifier), i.e. where text to this
window goes; will be matched up against showOwnText valuestartMinimised
- True if window should be minimised to start with
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |