• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

Konsole

Konsole::MainWindow

Konsole::MainWindow Class Reference

#include <MainWindow.h>

Inheritance diagram for Konsole::MainWindow:

Inheritance graph
[legend]

List of all members.


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 53 of file MainWindow.h.


Signals

void newSessionRequest (const QString &key, const QString &directory, ViewManager *view)
void newWindowRequest (const QString &key, const QString &directory)
void closeActiveSessionRequest ()

Public Member Functions

 MainWindow ()
ViewManager * viewManager () const
IncrementalSearchBar * searchBar () const
void setSessionList (ProfileList *list)
BookmarkHandler * bookmarkHandler () const
void setDefaultProfile (const QString &key)
QString defaultProfile () const

Protected Member Functions

virtual bool queryClose ()

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 58 of file MainWindow.cpp.


Member Function Documentation

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 127 of file MainWindow.cpp.

IncrementalSearchBar * MainWindow::searchBar (  )  const

Returns the search bar.

TODO - More documentation

Definition at line 181 of file MainWindow.cpp.

void MainWindow::setSessionList ( ProfileList *  list  ) 

Sets the list of sessions to be displayed in the File menu.

Definition at line 270 of file MainWindow.cpp.

BookmarkHandler * MainWindow::bookmarkHandler (  )  const

Returns the bookmark handler associated with this window.

Definition at line 265 of file MainWindow.cpp.

void MainWindow::setDefaultProfile ( const QString &  key  ) 

Sets the default profile key for this window.

This is the default value for the key argument when the newSessionRequest() and newWindow() signals are emitted.

Definition at line 118 of file MainWindow.cpp.

QString MainWindow::defaultProfile (  )  const

Returns the default profile key for this window.

See setDefaultProfile()

Definition at line 122 of file MainWindow.cpp.

void Konsole::MainWindow::newSessionRequest ( const QString &  key,
const QString &  directory,
ViewManager *  view 
) [signal]

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

Parameters:
key The key for 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.
view The view manager owned by this main window

void Konsole::MainWindow::newWindowRequest ( const QString &  key,
const QString &  directory 
) [signal]

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

Parameters:
key The key for 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.

void Konsole::MainWindow::closeActiveSessionRequest (  )  [signal]

Emitted by the main window to request the current session to close.

bool MainWindow::queryClose (  )  [protected, virtual]

Definition at line 315 of file MainWindow.cpp.


The documentation for this class was generated from the following files:
  • MainWindow.h
  • MainWindow.cpp

Konsole

Skip menu "Konsole"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

API Reference

Skip menu "API Reference"
  • Konsole
  • Libraries
  •   libkonq
Generated for API Reference by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal