Konsole::MainWindow Class Reference

#include <MainWindow.h>

Inheritance diagram for Konsole::MainWindow:

Public Slots
void	viewFullScreen (bool fullScreen)

Signals
void	newWindowRequest (Profile::Ptr profile, const QString &directory)
void	viewDetached (Session *session)

Public Member Functions
	MainWindow ()
Session *	createSession (Profile::Ptr profile, const QString &directory)
Session *	createSSHSession (Profile::Ptr profile, const KUrl &url)
void	createView (Session *session)
void	setFocus ()
void	setMenuBarInitialVisibility (bool visible)
void	setNavigationBehavior (int behavior)
void	setNavigationPosition (int position)
void	setNavigationStyleSheet (const QString &stylesheet)
void	setNavigationStyleSheetFromFile (const KUrl &stylesheetfile)
void	setNavigationVisibility (int visibility)
void	setShowQuickButtons (bool show)
ViewManager *	viewManager () const

Protected Member Functions
virtual bool	focusNextPrevChild (bool next)
virtual bool	queryClose ()
virtual void	readGlobalProperties (KConfig *config)
virtual void	readProperties (const KConfigGroup &group)
virtual void	saveGlobalProperties (KConfig *config)
virtual void	saveProperties (KConfigGroup &group)
virtual void	showEvent (QShowEvent *event)

Detailed Description

The main window.

This contains the menus and an area which contains the terminal displays.

The main window does not create the views or the container widgets which hold the views. This is done by the ViewManager class. When a MainWindow is instantiated, it creates a new ViewManager. The ViewManager can then be used to create new terminal displays inside the window.

Do not construct new main windows directly, use Application's newMainWindow() method.

Definition at line 57 of file MainWindow.h.

Constructor & Destructor Documentation

MainWindow::MainWindow

(

)

Constructs a new main window.

Do not create new main windows directly, use Application's newMainWindow() method instead.

Definition at line 73 of file MainWindow.cpp.

Member Function Documentation

Session * MainWindow::createSession	(	Profile::Ptr	profile,
		const QString &	directory
	)

Create a new session.

Parameters

profile	The profile to use to create the new session.
directory	Initial working directory for the new session or empty if the default working directory associated with the profile should be used.

Definition at line 469 of file MainWindow.cpp.

Session * MainWindow::createSSHSession	(	Profile::Ptr	profile,
		const KUrl &	url
	)

create a new SSH session.

Parameters

profile	The profile to use to create the new session.
url	the URL representing the new SSH connection

Definition at line 490 of file MainWindow.cpp.

void MainWindow::createView

(

Session *

session

)

create view for the specified session

Definition at line 519 of file MainWindow.cpp.

bool MainWindow::focusNextPrevChild ( bool  next )

protectedvirtual

Definition at line 826 of file MainWindow.cpp.

void Konsole::MainWindow::newWindowRequest ( Profile::Ptr  profile, const QString &  directory  )

signal

Emitted by the main window to request the creation of a new session in a new window.

Parameters

profile	The profile to use to create the first session in the new window.
directory	Initial working directory for the new window or empty if the default working directory associated with the profile should be used.

bool MainWindow::queryClose ( )

protectedvirtual

Definition at line 535 of file MainWindow.cpp.

void MainWindow::readGlobalProperties ( KConfig *  config )

protectedvirtual

Definition at line 619 of file MainWindow.cpp.

void MainWindow::readProperties ( const KConfigGroup &  group )

protectedvirtual

Definition at line 609 of file MainWindow.cpp.

void MainWindow::saveGlobalProperties ( KConfig *  config )

protectedvirtual

Definition at line 614 of file MainWindow.cpp.

void MainWindow::saveProperties ( KConfigGroup &  group )

protectedvirtual

Definition at line 604 of file MainWindow.cpp.

void MainWindow::setFocus

(

)

Helper method to make this window get input focus.

Definition at line 524 of file MainWindow.cpp.

void MainWindow::setMenuBarInitialVisibility

(

bool

visible

)

Set the initial visibility of the menubar.

Definition at line 805 of file MainWindow.cpp.

void MainWindow::setNavigationBehavior

(

int

behavior

)

Definition at line 734 of file MainWindow.cpp.

void MainWindow::setNavigationPosition

(

int

position

)

Definition at line 724 of file MainWindow.cpp.

void MainWindow::setNavigationStyleSheet

(

const QString &

stylesheet

)

Definition at line 729 of file MainWindow.cpp.

void MainWindow::setNavigationStyleSheetFromFile

(

const KUrl &

stylesheetfile

)

Definition at line 739 of file MainWindow.cpp.

void MainWindow::setNavigationVisibility

(

int

visibility

)

Definition at line 719 of file MainWindow.cpp.

void MainWindow::setShowQuickButtons

(

bool

show

)

Definition at line 761 of file MainWindow.cpp.

void MainWindow::showEvent ( QShowEvent *  event )

protectedvirtual

Definition at line 809 of file MainWindow.cpp.

void Konsole::MainWindow::viewDetached ( Session *  session )

signal

Emitted when a view for one session is detached from this window.

void MainWindow::viewFullScreen ( bool  fullScreen )

slot

Definition at line 362 of file MainWindow.cpp.

ViewManager * MainWindow::viewManager

(

)

const

Returns the view manager associated with this window.

The view manager can be used to create new views on particular session objects inside this window.

Definition at line 201 of file MainWindow.cpp.

---

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

• MainWindow.h
• MainWindow.cpp