uMenuItemStringWithHistory Class Reference

uMenuItemString extended by a simple history function and tab completion More...

#include <uMenu.h>

Inheritance diagram for uMenuItemStringWithHistory:

[legend]

Collaboration diagram for uMenuItemStringWithHistory:

[legend]

List of all members.

Public Member Functions
	uMenuItemStringWithHistory (uMenu *M, const tOutput &desc, const tOutput &help, tString &c, int maxLength, history_t &history, int limit, uAutoCompleter *completer=0)
	Consructor.
	~uMenuItemStringWithHistory ()
	Destructor.
virtual bool	Event (SDL_Event &e)
	Handles an event.
virtual void	Render (REAL x, REAL y, REAL alpha=1, bool selected=0)
	Renders the search suggestion if needed and calls uMenuItemString::Render().
Protected Attributes
history_t &	m_History
	The saved history lines.
unsigned int	m_HistoryPos
	The current position within the history.
unsigned int	m_HistoryLimit
	The maximal length of the history.
uAutoCompleter *	m_Completer
	The object used for completion.
bool	m_Searchmode
	Are we in search mode?
bool	m_SearchFailing
	Is the seach turning up any useful results?
Classes
class	history_t
	handles loading and saving the contents of the history to a file More...

---

Detailed Description

uMenuItemString extended by a simple history function and tab completion

Definition at line 436 of file uMenu.h.

---

Constructor & Destructor Documentation

uMenuItemStringWithHistory::uMenuItemStringWithHistory	(	uMenu *	M,
		const tOutput &	desc,
		const tOutput &	help,
		tString &	c,
		int	maxLength,
		history_t &	history,
		int	limit,
		uAutoCompleter *	completer = 0
	)

Consructor.

Parameters:

	M	passed on to uMenuItemString
	desc	passed on to uMenuItemString
	help	passed on to uMenuItemString
	c	passed on to uMenuItemString
	maxLength	passed on to uMenuItemString
	history	a reference to the history of commands
	limit	the limit for the history's size
	completer	the autocompleter to be used, if 0, no completion will take place

Definition at line 1069 of file uMenu.cpp.

01071                                                                                                                                                                                             :
01072         uMenuItemString(M, desc,help,c, maxLength ),
01073         m_History(history),
01074         m_HistoryPos(0),
01075         m_HistoryLimit(limit),
01076         m_Completer(completer),
01077 m_Searchmode(false) {
    m_History.push_front(tString());

uMenuItemStringWithHistory::~uMenuItemStringWithHistory

(

)

Destructor.

This destructor will write the currently displayed string into the history if it isn't already in it.

Definition at line 1080 of file uMenu.cpp.

References uMenuItemString::content, tString::Len(), m_History, and m_HistoryLimit.

                                                        {
    if(content->Len() > 1){
        for(history_t::iterator i=m_History.begin(); i!=m_History.end(); ++i) {
            if(*i == *content) {
                m_History.erase(i);
                break;
            }
        }
        m_History.front() = *content;
    } else {
        m_History.pop_front();
    }
    if(m_History.size() > m_HistoryLimit)

Here is the call graph for this function:

---

Member Function Documentation

bool uMenuItemStringWithHistory::Event

(

SDL_Event &

e

)

[virtual]

Handles an event.

Parameters:

e

the event to process

Returns:

true if the event was handled, false if it wasn't

Reimplemented from uMenuItemString.

Reimplemented in eMenuItemChat, and gMemuItemConsole.

Definition at line 1098 of file uMenu.cpp.

Referenced by gMemuItemConsole::Event().

                                                  {
#ifndef DEDICATED
    if (e.type==SDL_KEYDOWN &&
            (e.key.keysym.sym==SDLK_UP && !m_Searchmode )){
        if (m_History.size() - 1 > m_HistoryPos)
        {
            if(m_HistoryPos == 0)  //the new entry... save it before overwriting it
                m_History.front() = *content;
            m_HistoryPos++;
            *content = m_History[m_HistoryPos];
            cursorPos = content->Len() - 1;
        }

        return true;
    }
    else if (e.type==SDL_KEYDOWN &&
             (e.key.keysym.sym==SDLK_DOWN && !m_Searchmode)){
        if (m_HistoryPos > 0)
        {
            m_HistoryPos--;
            *content = m_History[m_HistoryPos];
            cursorPos = content->Len() - 1;
        }

        return true;
    }
    else if (e.type==SDL_KEYDOWN && e.key.keysym.mod & KMOD_CTRL && e.key.keysym.sym == SDLK_r ) {
        m_Searchmode = true;
        if(m_HistoryPos == 0 && !content->empty()) {  //the new entry... save it before overwriting it
            m_History.front() = *content;
            m_History.push_front(tString());
        }
        content->erase();
        m_HistoryPos++;
        cursorPos=0;
        m_SearchFailing=false;
        return true;
    }
    else if (e.type==SDL_KEYDOWN &&
             (e.key.keysym.sym==SDLK_TAB && !m_Searchmode)){
        if(m_Completer != 0) {
            cursorPos = m_Completer->Complete(*content, cursorPos);
        }

        return true;
    }
    else if (e.type==SDL_KEYDOWN && m_Searchmode) {
        if(e.key.keysym.sym==SDLK_LEFT || e.key.keysym.sym==SDLK_RIGHT) {
            *content = m_History[m_HistoryPos];
            m_Searchmode = false;
            cursorPos=0;
            return true;
        }
        bool ret = uMenuItemString::Event(e);
        tString searchstring = content->ToLower();
        unsigned int pos = 0;
        for(history_t::iterator iter = m_History.begin(); iter != m_History.end(); ++iter, ++pos) {
            if (iter->ToLower().find(searchstring) != tString::npos) {
                m_HistoryPos = pos;
                m_SearchFailing=false;
                return ret;
            }
        }
        m_SearchFailing=true;
        return ret;
    }

    else
        return uMenuItemString::Event(e);
#endif

Here is the caller graph for this function:

void uMenuItemStringWithHistory::Render	(	REAL	x,
		REAL	y,
		REAL	alpha = 1,
		bool	selected = 0
	)			[virtual]

Renders the search suggestion if needed and calls uMenuItemString::Render().

Reimplemented from uMenuItemString.

Definition at line 1171 of file uMenu.cpp.

                                                                              {
    if(m_Searchmode) {
        DisplayText(-.88, y-.1, ((m_SearchFailing ? "Failing reverse search: " : "Reverse search: ") + m_History[m_HistoryPos]).c_str(), selected, alpha, -1);
    }

---

Member Data Documentation

history_t& uMenuItemStringWithHistory::m_History [protected]

The saved history lines.

Definition at line 446 of file uMenu.h.

Referenced by ~uMenuItemStringWithHistory().

unsigned int uMenuItemStringWithHistory::m_HistoryPos [protected]

The current position within the history.

Definition at line 447 of file uMenu.h.

unsigned int uMenuItemStringWithHistory::m_HistoryLimit [protected]

The maximal length of the history.

Definition at line 448 of file uMenu.h.

Referenced by ~uMenuItemStringWithHistory().

uAutoCompleter* uMenuItemStringWithHistory::m_Completer [protected]

The object used for completion.

Definition at line 449 of file uMenu.h.

bool uMenuItemStringWithHistory::m_Searchmode [protected]

Are we in search mode?

Definition at line 450 of file uMenu.h.

bool uMenuItemStringWithHistory::m_SearchFailing [protected]

Is the seach turning up any useful results?

Definition at line 451 of file uMenu.h.

---

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

• src/ui/uMenu.h
• src/ui/uMenu.cpp

---