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

Konsole

Konsole::ViewManager

Konsole::ViewManager Class Reference

Manages the terminal display widgets in a Konsole window or part. More...

#include <ViewManager.h>

Inheritance diagram for Konsole::ViewManager:

Inheritance graph
[legend]

List of all members.


Public Types

enum  NavigationMethod { TabbedNavigation, NoNavigation }

Signals

void activeViewChanged (SessionController *controller)
void empty ()
void newViewRequest (Profile::Ptr)
void newViewRequest ()
void setMenuBarVisibleRequest (bool)
void splitViewToggle (bool multipleViews)
void viewDetached (Session *session)
void viewPropertiesChanged (const QList< ViewProperties * > &propertiesList)

Public Member Functions

QWidget * activeView () const
SessionController * activeViewController () const
void applyProfile (TerminalDisplay *view, const Profile::Ptr profile, bool applyContainerSettings)
void createView (Session *session)
NavigationMethod navigationMethod () const
void restoreSessions (const KConfigGroup &group)
void saveSessions (KConfigGroup &group)
IncrementalSearchBar * searchBar () const
void setNavigationMethod (NavigationMethod method)
 ViewManager (QObject *parent, KActionCollection *collection)
QList< ViewProperties * > viewProperties () const
QWidget * widget () const
 ~ViewManager ()

Detailed Description

Manages the terminal display widgets in a Konsole window or part.

When a view manager is created, it constructs a splitter widget ( accessed via widget() ) to hold one or more view containers. Each view container holds one or more terminal displays and a navigation widget ( eg. tabs or a list ) to allow the user to navigate between the displays in that container.

The view manager provides menu actions ( defined in the 'konsoleui.rc' XML file ) to manipulate the views and view containers - for example, actions to split the view left/right or top/bottom, detach a view from the current window and navigate between views and containers. These actions are added to the collection specified in the ViewManager's constructor.

The view manager provides facilities to construct display widgets for a terminal session and also to construct the SessionController which provides the menus and other user interface elements specific to each display/session pair.

Definition at line 68 of file ViewManager.h.


Member Enumeration Documentation

enum Konsole::ViewManager::NavigationMethod

This enum describes the available types of navigation widget which newly created containers can provide to allow navigation between open sessions.

Enumerator:
TabbedNavigation  Each container has a row of tabs (one per session) which the user can click on to navigate between open sessions.
NoNavigation  The container has no navigation widget.

Definition at line 120 of file ViewManager.h.


Constructor & Destructor Documentation

ViewManager::ViewManager ( QObject *  parent,
KActionCollection *  collection 
)

Constructs a new view manager with the specified parent.

View-related actions defined in 'konsoleui.rc' are created and added to the specified collection.

Definition at line 51 of file ViewManager.cpp.

ViewManager::~ViewManager (  ) 

Definition at line 90 of file ViewManager.cpp.


Member Function Documentation

QWidget * ViewManager::activeView (  )  const

Returns the view manager's active view.

Definition at line 107 of file ViewManager.cpp.

void Konsole::ViewManager::activeViewChanged ( SessionController *  controller  )  [signal]

Emitted when the active view changes.

Parameters:
controller The controller associated with the active view

SessionController * ViewManager::activeViewController (  )  const

Returns the controller for the active view.

activeViewChanged() is emitted when this changes.

Definition at line 525 of file ViewManager.cpp.

void ViewManager::applyProfile ( TerminalDisplay *  view,
const Profile::Ptr  profile,
bool  applyContainerSettings 
)

Applies the view-specific settings associated with specified profile to the terminal display view.

If applyContainerSettings is true then tab bar settings in the profile will also be applied

Definition at line 731 of file ViewManager.cpp.

void ViewManager::createView ( Session *  session  ) 

Creates a new view to display the outout from and deliver input to session.

Constructs a new container to hold the views if no container has yet been created.

Definition at line 570 of file ViewManager.cpp.

void Konsole::ViewManager::empty (  )  [signal]

Emitted when the last view is removed from the view manager.

ViewManager::NavigationMethod ViewManager::navigationMethod (  )  const

Returns the type of navigation widget created in new containers.

See setNavigationMethod()

Definition at line 670 of file ViewManager.cpp.

void Konsole::ViewManager::newViewRequest ( Profile::Ptr   )  [signal]

Requests creation of a new view, with the selected profile.

void Konsole::ViewManager::newViewRequest (  )  [signal]

Requests creation of a new view with the default profile.

void ViewManager::restoreSessions ( const KConfigGroup &  group  ) 

Definition at line 907 of file ViewManager.cpp.

void ViewManager::saveSessions ( KConfigGroup &  group  ) 

Session management.

Definition at line 871 of file ViewManager.cpp.

IncrementalSearchBar * ViewManager::searchBar (  )  const

Returns the search bar.

Definition at line 530 of file ViewManager.cpp.

void Konsole::ViewManager::setMenuBarVisibleRequest ( bool   )  [signal]

Emitted when menu bar visibility changes because a profile that requires so is activated.

void ViewManager::setNavigationMethod ( NavigationMethod  method  ) 

Sets the type of widget provided to navigate between open sessions in a container.

The changes will only apply to newly created containers.

The default method is TabbedNavigation. To disable navigation widgets, call setNavigationMethod(ViewManager::NoNavigation) before creating any sessions.

Definition at line 643 of file ViewManager.cpp.

void Konsole::ViewManager::splitViewToggle ( bool  multipleViews  )  [signal]

Emitted when the number of views containers changes.

This is used to disable or enable menu items which can only be used when there are one or multiple containers visible.

Parameters:
multipleViews True if there are multiple view containers open or false if there is just a single view.

void Konsole::ViewManager::viewDetached ( Session *  session  )  [signal]

Emitted when a session is detached from a view owned by this ViewManager.

QList< ViewProperties * > ViewManager::viewProperties (  )  const

Returns the list of view properties for views in the active container.

Each view widget is associated with a ViewProperties instance which provides access to basic information about the session being displayed in the view, such as title, current directory and associated icon.

Definition at line 852 of file ViewManager.cpp.

void Konsole::ViewManager::viewPropertiesChanged ( const QList< ViewProperties * > &  propertiesList  )  [signal]

Emitted when the list of view properties ( as returned by viewProperties() ) changes.

This occurs when views are added to or removed from the active container, or if the active container is changed.

QWidget * ViewManager::widget (  )  const

Return the main widget for the view manager which holds all of the views managed by this ViewManager instance.

Definition at line 120 of file ViewManager.cpp.


The documentation for this class was generated from the following files:
  • ViewManager.h
  • ViewManager.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.7
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