TerminalCallTip Class Reference

This class represents the calltip in the terminal. The associated window will only be shown and hidden. No new window is created for eachs calltip. More...

#include <terminalcalltip.hpp>

Inheritance diagram for TerminalCallTip:

Collaboration diagram for TerminalCallTip:

Public Member Functions
	TerminalCallTip (wxWindow *parent, const wxSize &s=wxDefaultSize)
	TerminalCallTip constructor. More...
void	PopUp (const wxPoint &pos, const wxString &text)
	Show the calltip at the desired position. This function does not check, whether the calltip is acutally visible. More...
void	Dismiss ()
	Remove the shown calltip. More...
void	Resize (const wxSize &s)
	Change the calltip's size. More...
void	ChangeFont (const wxFont &font)
	Changes the font of the calltip. More...
void	Highlight (size_t start, size_t len)
	Hightlight the section of the text in the calltip. More...
virtual bool	AcceptsFocus () const override
virtual bool	AcceptsFocusFromKeyboard () const override
virtual bool	AcceptsFocusRecursively () const override

Private Attributes
wxTextCtrl *	m_text

Detailed Description

This class represents the calltip in the terminal. The associated window will only be shown and hidden. No new window is created for eachs calltip.

Definition at line 31 of file terminalcalltip.hpp.

Constructor & Destructor Documentation

TerminalCallTip()

TerminalCallTip::TerminalCallTip	(	wxWindow *	parent,
		const wxSize &	s = wxDefaultSize
	)

TerminalCallTip constructor.

Parameters

parent	wxWindow*
s	const wxSize&

Definition at line 30 of file terminalcalltip.cpp.

References m_text.

Member Function Documentation

AcceptsFocus()

virtual bool TerminalCallTip::AcceptsFocus ( ) const

inlineoverridevirtual

Definition at line 46 of file terminalcalltip.hpp.

AcceptsFocusFromKeyboard()

virtual bool TerminalCallTip::AcceptsFocusFromKeyboard ( ) const

inlineoverridevirtual

Definition at line 51 of file terminalcalltip.hpp.

AcceptsFocusRecursively()

virtual bool TerminalCallTip::AcceptsFocusRecursively ( ) const

inlineoverridevirtual

Definition at line 56 of file terminalcalltip.hpp.

ChangeFont()

void TerminalCallTip::ChangeFont

(

const wxFont &

font

)

Changes the font of the calltip.

Parameters

font	const wxFont&

Returns

void

Definition at line 97 of file terminalcalltip.cpp.

References m_text.

Referenced by NumeReTerminal::SetFont().

Dismiss()

void TerminalCallTip::Dismiss

(

)

Remove the shown calltip.

Returns

void

Definition at line 70 of file terminalcalltip.cpp.

Referenced by NumeReTerminal::CalltipCancel().

Highlight()

void TerminalCallTip::Highlight	(	size_t	start,
		size_t	len
	)

Hightlight the section of the text in the calltip.

Parameters

start	size_t
len	size_t

Returns

void

Definition at line 112 of file terminalcalltip.cpp.

References m_text.

Referenced by NumeReTerminal::Calltip().

PopUp()

void TerminalCallTip::PopUp	(	const wxPoint &	pos,
		const wxString &	text
	)

Show the calltip at the desired position. This function does not check, whether the calltip is acutally visible.

Parameters

pos	const wxPoint&
text	const wxString&

Returns

void

Definition at line 52 of file terminalcalltip.cpp.

References m_text.

Referenced by NumeReTerminal::Calltip().

Resize()

void TerminalCallTip::Resize

(

const wxSize &

s

)

Change the calltip's size.

Parameters

s	const wxSize&

Returns

void

Definition at line 83 of file terminalcalltip.cpp.

References m_text.

Referenced by NumeReTerminal::Calltip().

Member Data Documentation

m_text

wxTextCtrl* TerminalCallTip::m_text

private

Definition at line 34 of file terminalcalltip.hpp.

Referenced by ChangeFont(), Highlight(), PopUp(), Resize(), and TerminalCallTip().

---

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

• D:/CPP/numere-source/trunk/gui/terminal/terminalcalltip.hpp
• D:/CPP/numere-source/trunk/gui/terminal/terminalcalltip.cpp