ManaPlus
Public Member Functions | Protected Member Functions
PartyTab Class Reference

#include <partytab.h>

Inheritance diagram for PartyTab:
ChatTab ConfigListener Tab BasicContainer MouseListener WidgetListener Widget WidgetDeathListener Widget2

Public Member Functions

 PartyTab (const Widget2 *const widget)
 
 ~PartyTab ()
 
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)
 
LabelgetLabel () const
 
void adjustSize ()
 
void setTabbedArea (TabbedArea *tabbedArea)
 
TabbedAreagetTabbedArea () 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)
 
WidgetgetWidgetAt (int x, int y)
 
void death (const Event &event)
 
WidgetfindFirstWidget (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
 
WidgetgetParent () 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 RectgetDimension () 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 ColorgetBaseColor () const
 
void setForegroundColor (const Color &color)
 
const ColorgetForegroundColor () const
 
void setBackgroundColor (const Color &color)
 
const ColorgetBackgroundColor () const
 
virtual void requestFocus ()
 
virtual void requestMoveToTop ()
 
virtual void requestMoveToBottom ()
 
FocusHandlergetFocusHandler ()
 
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)
 
FontgetFont () 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 FocusHandlergetInternalFocusHandler ()
 
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 ColorgetThemeColor (const ThemeColorIdT type, const unsigned int alpha) const A_INLINE
 
const ColorgetThemeCharColor (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)
 
WidgetgetWindow () 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 FontgetGloablFont ()
 
static void cleanGlobalFont ()
 
static bool widgetExists (const Widget *const widget)
 
static void distributeWindowResizeEvent ()
 
static WidgetcallPostInit (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
BrowserBoxmTextOutput
 
ScrollAreamScrollArea
 
std::string mChannelName
 
std::string mLogName
 
ChatTabTypeT mType
 
bool mAllowHightlight
 
bool mRemoveNames
 
bool mNoAway
 
bool mShowOnline
 
- Protected Attributes inherited from Tab
LabelmLabel
 
TabbedAreamTabbedArea
 
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
 
FocusHandlermFocusHandler
 
FocusHandlermInternalFocusHandler
 
WidgetmParent
 
FontmCurrentFont
 
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
 
WidgetmWindow
 
Color mForegroundColor2
 
- Static Protected Attributes inherited from Widget
static FontmGlobalFont = 0
 

Detailed Description

A tab for a party chat channel.

Definition at line 31 of file partytab.h.

Constructor & Destructor Documentation

◆ PartyTab()

PartyTab::PartyTab ( const Widget2 *const  widget)
explicit

Definition at line 46 of file partytab.cpp.

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

46  :
47  // TRANSLATORS: party chat tab name
48  ChatTab(widget, _("Party"), "", "#Party", ChatTabType::PARTY)
49 {
51  mShowOnline = config.getBoolValue("showPartyOnline");
52  config.addListener("showPartyOnline", this);
53 }
#define _(s)
Definition: gettext.h:34
Configuration config
void addListener(const std::string &key, ConfigListener *const listener)
bool getBoolValue(const std::string &key) const
#define setTabColors(name)
Definition: chattab.h:50
bool mShowOnline
Definition: chattab.h:214
ChatTab(const Widget2 *const widget, const std::string &name, const std::string &channel, const std::string &logName, const ChatTabTypeT &type)
Definition: chattab.cpp:66

◆ ~PartyTab()

PartyTab::~PartyTab ( )

Definition at line 55 of file partytab.cpp.

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

56 {
57  config.removeListeners(this);
59 }
Configuration config
void removeListeners(ConfigListener *const listener)
#define CHECKLISTENERS
Definition: localconsts.h:276

Member Function Documentation

◆ getAutoCompleteCommands()

void PartyTab::getAutoCompleteCommands ( StringVect names) const
protectedvirtual

Reimplemented from ChatTab.

Definition at line 130 of file partytab.cpp.

References Net::getNetworkType(), and ServerType::TMWATHENA.

131 {
132  names.push_back("/help");
133  names.push_back("/invite ");
134  names.push_back("/leave");
135  names.push_back("/kick ");
136  names.push_back("/item");
137  names.push_back("/exp");
139  names.push_back("/setleader ");
140 }
ServerTypeT getNetworkType()
Definition: net.cpp:184

◆ getAutoCompleteList()

void PartyTab::getAutoCompleteList ( StringVect names) const
protectedvirtual

Reimplemented from ChatTab.

Definition at line 119 of file partytab.cpp.

References Party::getNames(), Being::getParty(), and localPlayer.

120 {
121  if (localPlayer == nullptr)
122  return;
123 
124  const Party *const p = localPlayer->getParty();
125 
126  if (p != nullptr)
127  p->getNames(names);
128 }
Definition: party.h:61
Party * getParty() const
Definition: being.h:329
LocalPlayer * localPlayer
void getNames(StringVect &names) const
Definition: party.cpp:284

◆ handleCommand()

bool PartyTab::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 66 of file partytab.cpp.

References InputAction::COMMAND_CHANGE_PARTY_LEADER, InputManager::executeChatCommand(), Net::getNetworkType(), inputManager, Net::PartyHandler::invite(), InputAction::KICK_PARTY, InputAction::LEAVE_PARTY, InputAction::PARTY_AUTO_ITEM_SHARE, InputAction::PARTY_EXP_SHARE, InputAction::PARTY_ITEM_SHARE, partyHandler, and ServerType::TMWATHENA.

68 {
69  if (type == "invite")
70  {
71  partyHandler->invite(args);
72  }
73  else if (type == "leave")
74  {
76  args,
77  this);
78  }
79  else if (type == "kick")
80  {
82  args,
83  this);
84  }
85  else if (type == "item")
86  {
88  args,
89  this);
90  }
91  else if (type == "autoitem")
92  {
94  args,
95  this);
96  }
97  else if (type == "exp")
98  {
100  args,
101  this);
102  }
103  else if (type == "setleader" &&
105  {
108  args,
109  this);
110  }
111  else
112  {
113  return false;
114  }
115 
116  return true;
117 }
ServerTypeT getNetworkType()
Definition: net.cpp:184
virtual void invite(const std::string &name) const =0
Net::PartyHandler * partyHandler
Definition: net.cpp:91
InputManager inputManager
bool executeChatCommand(const std::string &cmd, const std::string &args, ChatTab *const tab)

◆ handleInput()

void PartyTab::handleInput ( const std::string &  msg)
protectedvirtual

Reimplemented from ChatTab.

Definition at line 61 of file partytab.cpp.

References Net::PartyHandler::chat(), ChatWindow::doReplace(), and partyHandler.

62 {
64 }
bool msg(InputEvent &event)
Definition: chat.cpp:38
static std::string doReplace(const std::string &msg)
virtual void chat(const std::string &text) const =0
Net::PartyHandler * partyHandler
Definition: net.cpp:91

◆ optionChanged()

void PartyTab::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 147 of file partytab.cpp.

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

148 {
149  if (value == "showPartyOnline")
150  mShowOnline = config.getBoolValue("showPartyOnline");
151 }
Configuration config
bool getBoolValue(const std::string &key) const
bool mShowOnline
Definition: chattab.h:214

◆ playNewMessageSound()

void PartyTab::playNewMessageSound ( ) const
virtual

Reimplemented from ChatTab.

Definition at line 142 of file partytab.cpp.

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

143 {
145 }
SoundManager soundManager
static const std::string SOUND_PARTY
Definition: sound.h:34
void playGuiSound(const std::string &name)

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