ChatWindow Class Reference
[User interface related classes (windows, dialogs)]
#include <chat.h>
Inheritance diagram for ChatWindow:
Detailed Description
The chat window.Definition at line 62 of file chat.h.
Public Member Functions | |
| ChatWindow () | |
| Constructor. | |
| ~ChatWindow () | |
| Destructor: used to write back values to the config file. | |
| void | widgetResized (const gcn::Event &event) |
| Called when the widget changes size. | |
| void | logic () |
| void | resetToDefaultSize () |
| Reset the chat window and recorder window attached to it to their default positions. | |
| ChatTab * | getFocused () const |
| Gets the focused tab. | |
| void | clearTab (ChatTab *tab) |
| Clear the given tab. | |
| void | clearTab () |
| Clear the current tab. | |
| void | prevTab () |
| Switch to the previous tab in order. | |
| void | nextTab () |
| Switch to the next tab in order. | |
| void | action (const gcn::ActionEvent &event) |
| Performs action. | |
| bool | requestChatFocus () |
| Request focus for typing chat message. | |
| bool | isInputFocused () |
| Checks whether ChatWindow is Focused or not. | |
| void | chatInput (std::string &msg) |
| Passes the text to the current tab as input. | |
| void | keyPressed (gcn::KeyEvent &event) |
| Called when key is pressed. | |
| void | addInputText (std::string input_str) |
| Add the given text to the chat input. | |
| void | addItemText (const std::string &item) |
| Called to add item to chat. | |
| void | setVisible (bool visible) |
| Override to reset mTmpVisible. | |
| void | scroll (int amount) |
| Scrolls the chat window. | |
| void | setRecordingFile (const std::string &msg) |
| Sets the file being recorded to. | |
| bool | getReturnTogglesChat () const |
| void | setReturnTogglesChat (bool toggles) |
| void | doPresent () |
| void | whisper (const std::string &nick, std::string mes, bool own=false) |
| ChatTab * | addWhisperTab (const std::string &nick, bool switchTo=false) |
Protected Member Functions | |
| void | removeTab (ChatTab *tab) |
| Remove the given tab from the window. | |
| void | addTab (ChatTab *tab) |
| Add the tab to the window. | |
| void | removeWhisper (std::string nick) |
| void | adjustTabSize () |
Protected Attributes | |
| ItemLinkHandler * | mItemLinkHandler |
| Used for showing item popup on clicking links. | |
| Recorder * | mRecorder |
| ChatInput * | mChatInput |
| Input box for typing chat messages. | |
Private Types | |
| typedef std::map< const std::string, ChatTab * > | TabMap |
| typedef std::list< std::string > | History |
| typedef History::iterator | HistoryIterator |
Private Attributes | |
| bool | mTmpVisible |
| TabbedArea * | mChatTabs |
| Tabbed area for holding each channel. | |
| Tab * | mCurrentTab |
| TabMap | mWhispers |
| Manage whisper tabs. | |
| History | mHistory |
| Command history. | |
| HistoryIterator | mCurHist |
| History iterator. | |
| bool | mReturnToggles |
| Marks whether <Return> toggles the chat log or not. | |
Friends | |
| class | ChatTab |
| class | WhisperTab |
Member Typedef Documentation
typedef std::map<const std::string, ChatTab*> ChatWindow::TabMap [private] |
typedef std::list<std::string> ChatWindow::History [private] |
typedef History::iterator ChatWindow::HistoryIterator [private] |
Constructor & Destructor Documentation
| ChatWindow::~ChatWindow | ( | ) |
Member Function Documentation
| void ChatWindow::widgetResized | ( | const gcn::Event & | event | ) |
| void ChatWindow::resetToDefaultSize | ( | ) | [virtual] |
| ChatTab * ChatWindow::getFocused | ( | ) | const |
| void ChatWindow::clearTab | ( | ChatTab * | tab | ) |
| void ChatWindow::prevTab | ( | ) |
| void ChatWindow::nextTab | ( | ) |
| void ChatWindow::action | ( | const gcn::ActionEvent & | event | ) |
| bool ChatWindow::requestChatFocus | ( | ) |
| bool ChatWindow::isInputFocused | ( | ) |
| void ChatWindow::chatInput | ( | std::string & | msg | ) |
| void ChatWindow::keyPressed | ( | gcn::KeyEvent & | event | ) |
| void ChatWindow::addInputText | ( | std::string | input_str | ) |
| void ChatWindow::addItemText | ( | const std::string & | item | ) |
| void ChatWindow::setVisible | ( | bool | visible | ) |
| void ChatWindow::scroll | ( | int | amount | ) |
| void ChatWindow::setRecordingFile | ( | const std::string & | msg | ) |
| void ChatWindow::setReturnTogglesChat | ( | bool | toggles | ) | [inline] |
| void ChatWindow::whisper | ( | const std::string & | nick, | |
| std::string | mes, | |||
| bool | own = false | |||
| ) |
| ChatTab * ChatWindow::addWhisperTab | ( | const std::string & | nick, | |
| bool | switchTo = false | |||
| ) |
| void ChatWindow::removeTab | ( | ChatTab * | tab | ) | [protected] |
| void ChatWindow::addTab | ( | ChatTab * | tab | ) | [protected] |
| void ChatWindow::removeWhisper | ( | std::string | nick | ) | [protected] |
Friends And Related Function Documentation
friend class WhisperTab [friend] |
Member Data Documentation
ItemLinkHandler* ChatWindow::mItemLinkHandler [protected] |
Recorder* ChatWindow::mRecorder [protected] |
ChatInput* ChatWindow::mChatInput [protected] |
bool ChatWindow::mTmpVisible [private] |
TabbedArea* ChatWindow::mChatTabs [private] |
Tab* ChatWindow::mCurrentTab [private] |
TabMap ChatWindow::mWhispers [private] |
History ChatWindow::mHistory [private] |
HistoryIterator ChatWindow::mCurHist [private] |
bool ChatWindow::mReturnToggles [private] |
The documentation for this class was generated from the following files:
