#include <wxTermContainer.h>

Inheritance diagram for wxTermContainer:

Collaboration diagram for wxTermContainer:

Public Member Functions
	wxTermContainer ()
	Constructors. More...

	wxTermContainer (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxBORDER_STATIC)

bool	Create (wxWindow *parent, wxWindowID id=-1, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxBORDER_STATIC)
	Creation. More...

void	CreateControls ()
	Creates the controls and sizers. More...

void	SetTerminal (NumeReTerminal *terminal)

void	OnScrollbarScrollLineUp (wxScrollEvent &event)
	wxEVT_SCROLL_LINEUP event handler for ID_SCROLLBAR More...

void	OnScrollbarScrollLineDown (wxScrollEvent &event)
	wxEVT_SCROLL_LINEDOWN event handler for ID_SCROLLBAR More...

void	OnScrollbarScrollPageUp (wxScrollEvent &event)
	wxEVT_SCROLL_PAGEUP event handler for ID_SCROLLBAR More...

void	OnScrollbarScrollPageDown (wxScrollEvent &event)
	wxEVT_SCROLL_PAGEDOWN event handler for ID_SCROLLBAR More...

void	OnScrollbarScrollThumbtrack (wxScrollEvent &event)
	wxEVT_SCROLL_THUMBTRACK event handler for ID_SCROLLBAR More...

void	OnWheelScroll (wxMouseEvent &event)
	wxEVT_MOUSEWHEEL event handler More...

void	OnSize (wxSizeEvent &event)
	Empty OnSize event handler. More...

void	OnUpdateUI (wxUpdateUIEvent &event)

void	SetTerminalHistory (int newSize)
	Changes the size of the terminal history buffer. More...

void	SetCaretBlinkTime (int newTime)
	Changes the blinking duration of the terminal caret. More...

Static Public Member Functions
static bool	ShowToolTips ()
	Should we show tooltips? More...

Private Member Functions
void	updateThumbPosition ()
	Updates the thumb position after every scroll operation except of the click-drag scrolling. More...

Private Attributes
NumeReTerminal *	m_terminal

wxScrollBar *	m_scrollbar

int	m_lastThumbPosition

wxBoxSizer *	m_sizer

int	m_lastLinesReceived

Detailed Description

wxTermContainer class declaration

Definition at line 49 of file wxTermContainer.h.

Constructor & Destructor Documentation

◆ wxTermContainer() [1/2]

wxTermContainer::wxTermContainer ( )

Constructors.

wxTermContainer type definition

wxTermContainer event table definition

wxTermContainer constructors

Definition at line 67 of file wxTermContainer.cpp.

◆ wxTermContainer() [2/2]

wxTermContainer::wxTermContainer	(	wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`,
		long	style = `wxBORDER_STATIC`
	)

Definition at line 71 of file wxTermContainer.cpp.

References Create(), m_lastLinesReceived, and m_lastThumbPosition.

Here is the call graph for this function:

Member Function Documentation

◆ Create()

bool wxTermContainer::Create	(	wxWindow *	parent,
		wxWindowID	id = `-1`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`,
		long	style = `wxBORDER_STATIC`
	)

Creation.

wxTermContainer creator

Definition at line 85 of file wxTermContainer.cpp.

References CreateControls(), and TRUE.

Referenced by wxTermContainer().

Here is the call graph for this function:

◆ CreateControls()

void wxTermContainer::CreateControls ( )

Creates the controls and sizers.

Control creation for wxTermContainer

Definition at line 104 of file wxTermContainer.cpp.

References ID_SCROLLBAR, m_scrollbar, m_sizer, and TRUE.

Referenced by Create().

◆ OnScrollbarScrollLineDown()

void wxTermContainer::OnScrollbarScrollLineDown ( wxScrollEvent & event )

wxEVT_SCROLL_LINEDOWN event handler for ID_SCROLLBAR

wxEVT_SCROLL_LINEDOWN event handler for ID_SCROLLBAR public OnScrollbarScrollLineDown Scrolls the terminal down a single line when the user clicks the down button

Parameters

event wxScrollEvent & The generated scroll event

Returns: void

Author: Mark Erikson

Date: 04-22-2004

Definition at line 189 of file wxTermContainer.cpp.

References m_terminal, NumeReTerminal::ScrollTerminal(), and updateThumbPosition().

Here is the call graph for this function:

◆ OnScrollbarScrollLineUp()

void wxTermContainer::OnScrollbarScrollLineUp ( wxScrollEvent & event )

wxEVT_SCROLL_LINEUP event handler for ID_SCROLLBAR

@begin wxTermContainer event handler declarations

wxEVT_SCROLL_LINEUP event handler for ID_SCROLLBAR public OnScrollbarScrollLineUp Scrolls the terminal up a single line when the user clicks the up button

Parameters

event wxScrollEvent & The generated scroll event

Returns: void

Author: Mark Erikson

Date: 04-22-2004

Definition at line 160 of file wxTermContainer.cpp.

References m_terminal, NumeReTerminal::ScrollTerminal(), and updateThumbPosition().

Here is the call graph for this function:

◆ OnScrollbarScrollPageDown()

void wxTermContainer::OnScrollbarScrollPageDown ( wxScrollEvent & event )

wxEVT_SCROLL_PAGEDOWN event handler for ID_SCROLLBAR

wxEVT_SCROLL_PAGEDOWN event handler for ID_SCROLLBAR public OnScrollbarScrollPageDown Scrolls the terminal down a "page" when the user clicks in the scrollbar

Parameters

event wxScrollEvent & The generated scroll event

Returns: void

Author: Mark Erikson

Date: 04-22-2004

Definition at line 231 of file wxTermContainer.cpp.

References GenericTerminal::Height(), m_terminal, NumeReTerminal::ScrollTerminal(), and updateThumbPosition().

Here is the call graph for this function:

◆ OnScrollbarScrollPageUp()

void wxTermContainer::OnScrollbarScrollPageUp ( wxScrollEvent & event )

wxEVT_SCROLL_PAGEUP event handler for ID_SCROLLBAR

wxEVT_SCROLL_PAGEUP event handler for ID_SCROLLBAR public OnScrollbarScrollPageUp Scrolls the terminal up a "page" when the user clicks in the scrollbar

Parameters

event wxScrollEvent & The generated scroll event

Returns: void

Author: Mark Erikson

Date: 04-22-2004

Definition at line 210 of file wxTermContainer.cpp.

References GenericTerminal::Height(), m_terminal, NumeReTerminal::ScrollTerminal(), and updateThumbPosition().

Here is the call graph for this function:

◆ OnScrollbarScrollThumbtrack()

void wxTermContainer::OnScrollbarScrollThumbtrack ( wxScrollEvent & event )

wxEVT_SCROLL_THUMBTRACK event handler for ID_SCROLLBAR

wxEVT_SCROLL_THUMBTRACK event handler for ID_SCROLLBAR public OnScrollbarScrollThumbtrack Scrolls the terminal as the user drags the scroll thumb

Parameters

event wxScrollEvent & The generated scroll event

Returns: void

Author: Mark Erikson

Date: 04-22-2004

Definition at line 252 of file wxTermContainer.cpp.

References m_lastThumbPosition, m_terminal, and NumeReTerminal::ScrollTerminal().

Here is the call graph for this function:

◆ OnSize()

void wxTermContainer::OnSize ( wxSizeEvent & event )

Empty OnSize event handler.

Parameters

event wxSizeEvent&

Returns: void

Definition at line 313 of file wxTermContainer.cpp.

◆ OnUpdateUI()

void wxTermContainer::OnUpdateUI ( wxUpdateUIEvent & event )

public OnUpdateUI Updates the scrollbar position, based on the amount of text received by the terminal

Parameters

event wxUpdateUIEvent & The generated UI event

Returns: void

Author: Mark Erikson

Date: 04-22-2004

Definition at line 328 of file wxTermContainer.cpp.

References GenericTerminal::GetScrollHeight(), GenericTerminal::GetScrollPosition(), GenericTerminal::Height(), m_lastLinesReceived, m_lastThumbPosition, m_scrollbar, and m_terminal.

Here is the call graph for this function:

◆ OnWheelScroll()

void wxTermContainer::OnWheelScroll ( wxMouseEvent & event )

wxEVT_MOUSEWHEEL event handler

Definition at line 169 of file wxTermContainer.cpp.

References m_terminal, NumeReTerminal::ScrollTerminal(), and updateThumbPosition().

Here is the call graph for this function:

◆ SetCaretBlinkTime()

void wxTermContainer::SetCaretBlinkTime ( int newTime )

Changes the blinking duration of the terminal caret.

Parameters

newTime int

Returns: void

Definition at line 381 of file wxTermContainer.cpp.

References m_terminal, and NumeReTerminal::SetCursorBlinkRate().

Referenced by NumeReWindow::EvaluateOptions().

Here is the call graph for this function:

◆ SetTerminal()

void wxTermContainer::SetTerminal ( NumeReTerminal * terminal )

public SetTerminal Assigns a terminal widget to this container

Parameters

terminal wxTerm * The terminal to use

Returns: void

Author: Mark Erikson

Date: 04-22-2004

Definition at line 295 of file wxTermContainer.cpp.

References GenericTerminal::Height(), m_scrollbar, m_sizer, and m_terminal.

Referenced by NumeReWindow::NumeReWindow().

Here is the call graph for this function:

◆ SetTerminalHistory()

void wxTermContainer::SetTerminalHistory ( int newSize )

Changes the size of the terminal history buffer.

Parameters

newSize int

Returns: void

Definition at line 367 of file wxTermContainer.cpp.

References m_terminal, and GenericTerminal::SetTerminalHistory().

Referenced by NumeReWindow::EvaluateOptions().

Here is the call graph for this function:

◆ ShowToolTips()

bool wxTermContainer::ShowToolTips ( )

static

Should we show tooltips?

Definition at line 280 of file wxTermContainer.cpp.

References TRUE.

◆ updateThumbPosition()

void wxTermContainer::updateThumbPosition ( )

private

Updates the thumb position after every scroll operation except of the click-drag scrolling.

Returns: void

Definition at line 140 of file wxTermContainer.cpp.

References GenericTerminal::GetScrollHeight(), GenericTerminal::GetScrollPosition(), GenericTerminal::Height(), m_lastThumbPosition, and m_terminal.

Referenced by OnScrollbarScrollLineDown(), OnScrollbarScrollLineUp(), OnScrollbarScrollPageDown(), OnScrollbarScrollPageUp(), and OnWheelScroll().

Here is the call graph for this function:

Member Data Documentation

◆ m_lastLinesReceived

int wxTermContainer::m_lastLinesReceived

private

Definition at line 110 of file wxTermContainer.h.

Referenced by OnUpdateUI(), and wxTermContainer().

◆ m_lastThumbPosition

int wxTermContainer::m_lastThumbPosition

private

Definition at line 108 of file wxTermContainer.h.

Referenced by OnScrollbarScrollThumbtrack(), OnUpdateUI(), updateThumbPosition(), and wxTermContainer().

◆ m_scrollbar

wxScrollBar* wxTermContainer::m_scrollbar

private

Definition at line 104 of file wxTermContainer.h.

Referenced by CreateControls(), OnUpdateUI(), and SetTerminal().

◆ m_sizer

wxBoxSizer* wxTermContainer::m_sizer

private

Definition at line 109 of file wxTermContainer.h.

Referenced by CreateControls(), and SetTerminal().

◆ m_terminal

NumeReTerminal* wxTermContainer::m_terminal

private

Definition at line 103 of file wxTermContainer.h.

Referenced by OnScrollbarScrollLineDown(), OnScrollbarScrollLineUp(), OnScrollbarScrollPageDown(), OnScrollbarScrollPageUp(), OnScrollbarScrollThumbtrack(), OnUpdateUI(), OnWheelScroll(), SetCaretBlinkTime(), SetTerminal(), SetTerminalHistory(), and updateThumbPosition().

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

D:/CPP/numere-source/trunk/gui/compositions/wxTermContainer.h
D:/CPP/numere-source/trunk/gui/compositions/wxTermContainer.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ wxTermContainer() [1/2]

◆ wxTermContainer() [2/2]

Member Function Documentation

◆ Create()

◆ CreateControls()

◆ OnScrollbarScrollLineDown()

◆ OnScrollbarScrollLineUp()

◆ OnScrollbarScrollPageDown()

◆ OnScrollbarScrollPageUp()

◆ OnScrollbarScrollThumbtrack()

◆ OnSize()

◆ OnUpdateUI()

◆ OnWheelScroll()

◆ SetCaretBlinkTime()

◆ SetTerminal()

◆ SetTerminalHistory()

◆ ShowToolTips()

◆ updateThumbPosition()

Member Data Documentation

◆ m_lastLinesReceived

◆ m_lastThumbPosition

◆ m_scrollbar

◆ m_sizer

◆ m_terminal