GuildTab Class Reference

#include <guildtab.h>

Inheritance diagram for GuildTab:

Public Member Functions
	GuildTab (const Widget2 *const widget)
	~GuildTab ()
bool	handleCommand (const std::string &type, const std::string &args)
void	playNewMessageSound () const
void	optionChanged (const std::string &value)
Public Member Functions inherited from ChatTab
	ChatTab (const Widget2 *const widget, const std::string &name, const std::string &channel, const std::string &logName, const ChatTabTypeT &type)
	~ChatTab ()
void	chatLog (std::string line, ChatMsgTypeT own, const IgnoreRecord ignoreRecord, const TryRemoveColors tryRemoveColors)
void	chatLog (const std::string &nick, std::string msg)
void	chatInput (const std::string &msg)
void	scroll (const int amount)
void	clearText ()
virtual bool	handleCommands (const std::string &type, const std::string &args)
ChatTabTypeT	getType () const
void	saveToLogFile (const std::string &msg) const
const std::list< std::string > &	getRows () const
bool	hasRows () const
void	loadFromLogFile (const std::string &name)
bool	getAllowHighlight () const
void	setAllowHighlight (const bool n)
bool	getRemoveNames () const
void	setRemoveNames (const bool n)
bool	getNoAway () const
void	setNoAway (const bool n)
void	addNewRow (std::string &line)
void	showOnline (const std::string &nick, const Online online)
const std::string &	getChannelName () const
Public Member Functions inherited from Tab
	Tab (const Widget2 *const widget)
	~Tab ()
void	updateAlpha ()
void	draw (Graphics *const graphics)
void	safeDraw (Graphics *const graphics)
void	setTabColor (const Color *const color1, const Color *const color2)
void	setHighlightedTabColor (const Color *const color1, const Color *const color2)
void	setSelectedTabColor (const Color *const color1, const Color *const color2)
void	setFlashTabColor (const Color *const color1, const Color *const color2)
void	setPlayerFlashTabColor (const Color *const color1, const Color *const color2)
void	setFlash (const int flash)
int	getFlash () const
void	widgetResized (const Event &event)
void	widgetMoved (const Event &event)
void	setLabelFont (Font *const font)
Label *	getLabel () const
void	adjustSize ()
void	setTabbedArea (TabbedArea *tabbedArea)
TabbedArea *	getTabbedArea () const
void	setCaption (const std::string &caption)
const std::string &	getCaption () const
void	mouseEntered (MouseEvent &event)
void	mouseExited (MouseEvent &event)
void	setImage (Image *const image)
Public Member Functions inherited from BasicContainer
	BasicContainer (const Widget2 *const widget)
	~BasicContainer ()
void	showWidgetPart (Widget *const widget, const Rect &area)
void	moveToTop (Widget *const widget)
void	moveToBottom (Widget *const widget)
Rect	getChildrenArea ()
void	focusNext ()
void	focusPrevious ()
void	logic ()
void	setFocusHandler (FocusHandler *const focusHandler)
void	setInternalFocusHandler (FocusHandler *const focusHandler)
Widget *	getWidgetAt (int x, int y)
void	death (const Event &event)
Widget *	findFirstWidget (const std::set< Widget * > &list)
void	add (Widget *const widget)
virtual void	remove (Widget *const widget)
virtual void	clear ()
Public Member Functions inherited from Widget
	Widget (const Widget2 *const widget)
	~Widget ()
virtual void	drawFrame (Graphics *graphics)
virtual void	safeDrawFrame (Graphics *graphics)
void	setFrameSize (const unsigned int frameSize)
unsigned int	getFrameSize () const
Widget *	getParent () const
void	setWidth (const int width)
int	getWidth () const
void	setHeight (const int height)
int	getHeight () const
void	setSize (const int width, const int height)
void	setX (const int x)
int	getX () const
void	setY (const int y)
int	getY () const
void	setPosition (const int x, const int y)
void	setDimension (const Rect &dimension)
const Rect &	getDimension () const
void	setFocusable (const bool focusable)
bool	isFocusable () const
virtual bool	isFocused () const
void	setEnabled (const bool enabled)
bool	isEnabled () const
void	setVisible (Visible visible)
bool	isVisible () const
void	setBaseColor (const Color &color)
const Color &	getBaseColor () const
void	setForegroundColor (const Color &color)
const Color &	getForegroundColor () const
void	setBackgroundColor (const Color &color)
const Color &	getBackgroundColor () const
virtual void	requestFocus ()
virtual void	requestMoveToTop ()
virtual void	requestMoveToBottom ()
FocusHandler *	getFocusHandler ()
void	addActionListener (ActionListener *const actionListener)
void	removeActionListener (ActionListener *const actionListener)
void	addDeathListener (WidgetDeathListener *const deathListener)
void	removeDeathListener (WidgetDeathListener *const deathListener)
void	addMouseListener (MouseListener *const mouseListener)
void	removeMouseListener (MouseListener *const mouseListener)
void	addKeyListener (KeyListener *const keyListener)
void	removeKeyListener (KeyListener *const keyListener)
void	addFocusListener (FocusListener *const focusListener)
void	removeFocusListener (FocusListener *const focusListener)
void	addWidgetListener (WidgetListener *const widgetListener)
void	removeWidgetListener (WidgetListener *const widgetListener)
void	setActionEventId (const std::string &actionEventId)
const std::string &	getActionEventId () const
virtual void	getAbsolutePosition (int &x, int &y) const
virtual void	setParent (Widget *parent)
Font *	getFont () const
void	setFont (Font *const font)
virtual void	fontChanged ()
bool	isTabInEnabled () const
void	setTabInEnabled (const bool enabled)
bool	isTabOutEnabled () const
void	setTabOutEnabled (const bool enabled)
void	requestModalFocus ()
virtual void	requestModalMouseInputFocus ()
virtual void	releaseModalFocus ()
virtual void	releaseModalMouseInputFocus ()
virtual bool	isModalFocused () const
virtual bool	isModalMouseInputFocused () const
const std::list< MouseListener * > &	getMouseListeners () const A_CONST
const std::list< KeyListener * > &	getKeyListeners () const A_CONST
const std::list< FocusListener * > &	getFocusListeners () const A_CONST
virtual FocusHandler *	getInternalFocusHandler ()
void	setInternalFocusHandler (FocusHandler *const internalFocusHandler)
void	setId (const std::string &id)
const std::string &	getId () const
virtual void	showPart (const Rect &rectangle)
bool	isAllowLogic () const
void	setMouseConsume (const bool b)
bool	isMouseConsume () const
void	setRedraw (const bool b)
virtual bool	isSelectable () const
void	setSelectable (const bool selectable)
void	windowResized ()
virtual void	postInit ()
Public Member Functions inherited from Widget2
virtual	~Widget2 ()
const Color &	getThemeColor (const ThemeColorIdT type, const unsigned int alpha) const A_INLINE
const Color &	getThemeCharColor (const signed char c, bool &valid) const A_INLINE
virtual void	setWidget2 (const Widget2 *const widget)
void	setPalette (int palette)
void	checkPalette ()
void	setForegroundColor2 (const Color &color)
Widget *	getWindow () const
virtual void	setWindow (Widget *const window)
Public Member Functions inherited from WidgetDeathListener
virtual	~WidgetDeathListener ()
Public Member Functions inherited from MouseListener
virtual	~MouseListener ()
virtual void	mousePressed (MouseEvent &event)
virtual void	mouseReleased (MouseEvent &event)
virtual void	mouseClicked (MouseEvent &event)
virtual void	mouseWheelMovedUp (MouseEvent &event)
virtual void	mouseWheelMovedDown (MouseEvent &event)
virtual void	mouseMoved (MouseEvent &event)
virtual void	mouseDragged (MouseEvent &event)
Public Member Functions inherited from WidgetListener
virtual	~WidgetListener ()
virtual void	widgetHidden (const Event &event)
virtual void	widgetShown (const Event &event)
Public Member Functions inherited from ConfigListener
	ConfigListener ()
virtual	~ConfigListener ()

Protected Member Functions
void	handleInput (const std::string &msg)
void	getAutoCompleteList (StringVect &names) const
void	getAutoCompleteCommands (StringVect &names) const
Protected Member Functions inherited from ChatTab
void	setCurrent ()
virtual void	handleCommandStr (const std::string &msg)
virtual void	handleHelp (const std::string &msg)
void	addRow (std::string &line)
Protected Member Functions inherited from BasicContainer
virtual void	drawChildren (Graphics *const graphics)
virtual void	safeDrawChildren (Graphics *const graphics)
virtual void	logicChildren ()
Protected Member Functions inherited from Widget
void	distributeActionEvent ()
void	distributeResizedEvent ()
void	distributeMovedEvent ()
void	distributeHiddenEvent ()
void	distributeShownEvent ()
Protected Member Functions inherited from Widget2
	Widget2 (const Widget2 *const widget)
Protected Member Functions inherited from WidgetDeathListener
	WidgetDeathListener ()
Protected Member Functions inherited from MouseListener
	MouseListener ()
Protected Member Functions inherited from WidgetListener
	WidgetListener ()

Additional Inherited Members
Public Types inherited from Tab
enum	{   TAB_STANDARD = 0 , TAB_HIGHLIGHTED = 1 , TAB_SELECTED = 2 , TAB_UNUSED = 3 ,   TAB_COUNT = 4 }
Static Public Member Functions inherited from Tab
static void	finalCleanup ()
Static Public Member Functions inherited from Widget
static void	setGlobalFont (Font *const font)
static Font *	getGloablFont ()
static void	cleanGlobalFont ()
static bool	widgetExists (const Widget *const widget)
static void	distributeWindowResizeEvent ()
static Widget *	callPostInit (Widget *const widget)
Data Fields inherited from Widget
Visible	mVisible
Protected Types inherited from BasicContainer
typedef std::vector< Widget * >	WidgetList
typedef WidgetList::iterator	WidgetListIterator
typedef WidgetList::const_iterator	WidgetListConstIterator
typedef WidgetList::reverse_iterator	WidgetListReverseIterator
typedef WidgetList::const_reverse_iterator	WidgetListCReverseIterator
Protected Types inherited from Widget
typedef std::list< MouseListener * >	MouseListenerList
typedef MouseListenerList::iterator	MouseListenerIterator
typedef std::list< KeyListener * >	KeyListenerList
typedef KeyListenerList::iterator	KeyListenerIterator
typedef std::list< ActionListener * >	ActionListenerList
typedef ActionListenerList::iterator	ActionListenerIterator
typedef std::list< WidgetDeathListener * >	WidgetDeathListenerList
typedef WidgetDeathListenerList::iterator	WidgetDeathListenerIterator
typedef std::list< FocusListener * >	FocusListenerList
typedef FocusListenerList::iterator	FocusListenerIterator
typedef std::list< WidgetListener * >	WidgetListenerList
typedef WidgetListenerList::iterator	WidgetListenerIterator
Protected Attributes inherited from ChatTab
BrowserBox *	mTextOutput
ScrollArea *	mScrollArea
std::string	mChannelName
std::string	mLogName
ChatTabTypeT	mType
bool	mAllowHightlight
bool	mRemoveNames
bool	mNoAway
bool	mShowOnline
Protected Attributes inherited from Tab
Label *	mLabel
TabbedArea *	mTabbedArea
bool	mHasMouse
Protected Attributes inherited from BasicContainer
WidgetList	mWidgets
WidgetList	mLogicWidgets
Protected Attributes inherited from Widget
MouseListenerList	mMouseListeners
KeyListenerList	mKeyListeners
ActionListenerList	mActionListeners
WidgetDeathListenerList	mDeathListeners
FocusListenerList	mFocusListeners
WidgetListenerList	mWidgetListeners
Color	mForegroundColor
Color	mBackgroundColor
Color	mBaseColor
Rect	mDimension
std::string	mActionEventId
std::string	mId
FocusHandler *	mFocusHandler
FocusHandler *	mInternalFocusHandler
Widget *	mParent
Font *	mCurrentFont
unsigned int	mFrameSize
bool	mFocusable
bool	mTabIn
bool	mTabOut
bool	mEnabled
bool	mAllowLogic
bool	mMouseConsume
bool	mRedraw
bool	mSelectable
Protected Attributes inherited from Widget2
int	mPaletteOffset
Widget *	mWindow
Color	mForegroundColor2
Static Protected Attributes inherited from Widget
static Font *	mGlobalFont = 0

Detailed Description

A tab for a guild chat channel.

Definition at line 32 of file guildtab.h.

Constructor & Destructor Documentation

GuildTab()

GuildTab::GuildTab ( const Widget2 *const  widget )

explicit

Definition at line 46 of file guildtab.cpp.

                                              :
    // TRANSLATORS: guild chat tab name
    ChatTab(widget, _("Guild"), "", "#Guild", ChatTabType::GUILD)
{
    setTabColors(ThemeColorId::GUILD_CHAT_TAB);
    mShowOnline = config.getBoolValue("showGuildOnline");
    config.addListener("showGuildOnline", this);
}

References Configuration::addListener(), config, Configuration::getBoolValue(), ChatTab::mShowOnline, and setTabColors.

~GuildTab()

GuildTab::~GuildTab

(

)

Definition at line 55 of file guildtab.cpp.

{
    config.removeListeners(this);
    CHECKLISTENERS
}

References CHECKLISTENERS, config, and Configuration::removeListeners().

Member Function Documentation

getAutoCompleteCommands()

void GuildTab::getAutoCompleteCommands ( StringVect &  names ) const

protectedvirtual

Reimplemented from ChatTab.

Definition at line 108 of file guildtab.cpp.

{
    names.push_back("/help");
    names.push_back("/invite ");
    names.push_back("/kick ");
    names.push_back("/notice ");
    names.push_back("/leave");
}

getAutoCompleteList()

void GuildTab::getAutoCompleteList ( StringVect &  names ) const

protectedvirtual

Reimplemented from ChatTab.

Definition at line 102 of file guildtab.cpp.

{
    if (EAthena::taGuild != nullptr)
        EAthena::taGuild->getNames(names);
}

References Guild::getNames(), and EAthena::taGuild.

handleCommand()

bool GuildTab::handleCommand ( const std::string &  type, const std::string &  args  )

virtual

Handle special commands. Allows a tab to handle commands it defines itself.

Returns

true if the command was handled false if the command was not handled

Reimplemented from ChatTab.

Definition at line 61 of file guildtab.cpp.

{
    if (type == "invite" && (EAthena::taGuild != nullptr))
    {
        guildHandler->invite(args);
    }
    else if (type == "leave" && (EAthena::taGuild != nullptr))
    {
        inputManager.executeChatCommand(InputAction::LEAVE_GUILD,
            std::string(),
            this);
    }
    else if (type == "kick" && (EAthena::taGuild != nullptr))
    {
        inputManager.executeChatCommand(InputAction::KICK_GUILD,
            args,
            this);
    }
    else if (type == "notice" && (EAthena::taGuild != nullptr))
    {
        inputManager.executeChatCommand(InputAction::GUILD_NOTICE,
            args,
            this);
    }
    else
    {
        return false;
    }
 
    return true;
}

References InputManager::executeChatCommand(), InputAction::GUILD_NOTICE, guildHandler, inputManager, Net::GuildHandler::invite(), InputAction::KICK_GUILD, InputAction::LEAVE_GUILD, and EAthena::taGuild.

handleInput()

void GuildTab::handleInput ( const std::string &  msg )

protectedvirtual

Reimplemented from ChatTab.

Definition at line 94 of file guildtab.cpp.

{
    if (EAthena::taGuild == nullptr)
        return;
 
    guildHandler->chat(ChatWindow::doReplace(msg));
}

References Net::GuildHandler::chat(), ChatWindow::doReplace(), guildHandler, Actions::msg(), and EAthena::taGuild.

optionChanged()

void GuildTab::optionChanged ( const std::string &  name )

virtual

Called when an option changed. The config listener will have to be registered to the option name first.

Implements ConfigListener.

Definition at line 122 of file guildtab.cpp.

{
    if (value == "showGuildOnline")
        mShowOnline = config.getBoolValue("showGuildOnline");
}

References config, Configuration::getBoolValue(), and ChatTab::mShowOnline.

playNewMessageSound()

void GuildTab::playNewMessageSound ( ) const

virtual

Reimplemented from ChatTab.

Definition at line 117 of file guildtab.cpp.

{
    soundManager.playGuiSound(SOUND_GUILD);
}

References SoundManager::playGuiSound(), SOUND_GUILD, and soundManager.

---

The documentation for this class was generated from the following files:

• src/gui/widgets/tabs/chat/guildtab.h (986a3bf)
• src/gui/widgets/tabs/chat/guildtab.cpp (986a3bf)