kate Library API Documentation

KateMainWindow Class Reference

Collaboration diagram for KateMainWindow:

Collaboration graph
[legend]
List of all members.

Public Slots

void slotProjectNew ()
void slotProjectOpen ()
void slotProjectSave ()
void slotProjectClose ()
void openConstURLProject (const KURL &)

Public Member Functions

 KateMainWindow ()
 ~KateMainWindow ()
Kate::MainWindowmainWindow ()
Kate::ViewManagerviewManager ()
Kate::ToolViewManagertoolViewManager ()
KateViewManagerkateViewManager ()
DCOPObject * dcopObject ()
KMDI::ToolViewAccessor * addToolView (KDockWidget::DockPosition position, QWidget *widget, const QPixmap &icon, const QString &sname, const QString &tabToolTip=0, const QString &tabCaption=0)
bool removeToolView (QWidget *)
bool removeToolView (KMDI::ToolViewAccessor *)
bool showToolView (QWidget *)
bool showToolView (KMDI::ToolViewAccessor *)
bool hideToolView (QWidget *)
bool hideToolView (KMDI::ToolViewAccessor *)
Kate::ProjectactiveProject ()
Kate::ProjectcreateProject (const QString &type, const QString &name, const QString &filename)
Kate::ProjectopenProject (const QString &filename)
void activateProject (Kate::Project *project)
KURL activeDocumentUrl ()
uint mainWindowNumber () const
bool showModOnDiskPrompt ()
void readProperties (KConfig *config)
void saveProperties (KConfig *config)
void saveGlobalProperties (KConfig *sessionConfig)
void openURL (const QString &name=0L)

Protected Member Functions

bool eventFilter (QObject *, QEvent *)
bool event (QEvent *)

Friends

class KateConfigDialog
class KateViewManager

Detailed Description

Definition at line 53 of file katemainwindow.h.


Member Function Documentation

Kate::MainWindow* KateMainWindow::mainWindow  )  [inline]
 

Accessor methodes for interface and child objects.

Definition at line 68 of file katemainwindow.h.

Referenced by KateApp::activeMainWindow(), KateProjectManager::close(), KatePluginManager::disablePluginGUI(), KateProjectManager::disableProjectGUI(), KatePluginManager::enablePluginGUI(), KateProjectManager::enableProjectGUI(), KateProjectList::KateProjectList(), and KateProjectViews::KateProjectViews().

KMDI::ToolViewAccessor * KateMainWindow::addToolView KDockWidget::DockPosition  position,
QWidget *  widget,
const QPixmap &  icon,
const QString &  sname,
const QString &  tabToolTip = 0,
const QString &  tabCaption = 0
 

ToolView Managment, used to create/access/delete toolviews.

Definition at line 798 of file katemainwindow.cpp.

Kate::Project* KateMainWindow::activeProject  )  [inline]
 

current active project

Returns:
active project

Definition at line 99 of file katemainwindow.h.

Kate::Project * KateMainWindow::createProject const QString &  type,
const QString &  name,
const QString &  filename
 

Creates a new project file at give url of given type + opens it.

Parameters:
type projecttype
name project name
filename filename of the new project file
Returns:
new created project object

Definition at line 882 of file katemainwindow.cpp.

References activateProject(), KateProjectManager::create(), and KateProjectManager::self().

Referenced by slotProjectNew().

Kate::Project * KateMainWindow::openProject const QString &  filename  ) 
 

Parameters:
filename name of the project file
Returns:
opened project

Definition at line 892 of file katemainwindow.cpp.

References activateProject(), KateProjectManager::open(), and KateProjectManager::self().

Referenced by openConstURLProject(), and slotProjectOpen().

void KateMainWindow::activateProject Kate::Project project  ) 
 

activate given project

Parameters:
project project to activate

Definition at line 857 of file katemainwindow.cpp.

References KateProjectManager::disableProjectGUI(), KateProjectManager::enableProjectGUI(), Kate::MainWindow::projectChanged(), Kate::Project::projectNumber(), KateProjectManager::self(), and KateProjectManager::setCurrentProject().

Referenced by createProject(), KateMainWindow(), and openProject().

KURL KateMainWindow::activeDocumentUrl  ) 
 

Returns the URL of the current document.

anders: I add this for use from the file selector.

Definition at line 558 of file katemainwindow.cpp.

References KateViewManager::activeView().

Referenced by KateExternalToolAction::expandMacro(), and KateFileSelector::kateViewChanged().

bool KateMainWindow::showModOnDiskPrompt  ) 
 

Prompts the user for what to do with files that are modified on disk if any.

This is optionally run when the window receives focus, and when the last window is closed.

Returns:
true if no documents are modified on disk, or all documents were handled by the dialog; otherwise (the dialog was canceled) false.

Definition at line 772 of file katemainwindow.cpp.

References KateDocManager::firstDocument(), KateViewSpace::modifiedOnDisc(), KateDocManager::nextDocument(), and KateDocManager::self().

Referenced by event().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kate Library Version 3.4.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Jun 14 19:05:41 2006 by doxygen 1.4.4 written by Dimitri van Heesch, © 1997-2003