Window Class Reference

#include <Window.h>

Inheritance diagram for Window:

Signals
void	activeViewChanged ()
void	themeChanged ()
void	windowClosed ()

Public Slots
void	activate ()
View *	activeView () const
View *	addView (Document *document)
void	close ()
QAction *	createAction (const QString &id, const QString &text=QString(), const QString &menuLocation=QString("tools/scripts"))
QList< QDockWidget * >	dockers () const
QMainWindow *	qwindow () const
void	showView (View *view)
QList< View * >	views () const

Public Member Functions
	Window (KisMainWindow *window, QObject *parent=0)
bool	operator!= (const Window &other) const
bool	operator== (const Window &other) const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QObject
typedef	QObjectList
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Window represents one Krita mainwindow.

A window can have any number of views open on any number of documents.

Definition at line 22 of file Window.h.

Constructor & Destructor Documentation

Window()

Window::Window ( KisMainWindow * window, QObject * parent = 0 )

explicit

Definition at line 30 of file Window.cpp.

~Window()

Window::~Window ( )

override

Definition at line 40 of file Window.cpp.

Member Function Documentation

activate

void Window::activate ( )

slot

activate activates this Window.

Definition at line 112 of file Window.cpp.

activeView

View * Window::activeView ( ) const

slot

Returns

the currently active view or 0 if no view is active

Definition at line 104 of file Window.cpp.

activeViewChanged

void Window::activeViewChanged ( )

signal

Emitted when the active view changes.

addView

View * Window::addView ( Document * document )

slot

Open a new view on the given document in this window.

Definition at line 83 of file Window.cpp.

close

void Window::close ( )

slot

close the active window and all its Views.

If there are no Views left for a given Document, that Document will also be closed.

Definition at line 119 of file Window.cpp.

createAction

QAction * Window::createAction ( const QString & id, const QString & text = QString(), const QString & menuLocation = QString("tools/scripts") )

slot

createAction creates a QAction object and adds it to the action manager for this Window.

Parameters

id	The unique id for the action. This will be used to propertize the action if any .action file is present
text	The user-visible text of the action. If empty, the text from the .action file is used.
menuLocation	a /-separated string that describes which menu the action should be places in. Default is "tools/scripts"

Returns

the new action.

Definition at line 128 of file Window.cpp.

dockers

QList< QDockWidget * > Window::dockers ( ) const

slot

dockers

Returns

a list of all the dockers belonging to this window

Definition at line 60 of file Window.cpp.

operator!=()

bool Window::operator!=

(

const Window &

other

)

const

Definition at line 50 of file Window.cpp.

operator==()

bool Window::operator==

(

const Window &

other

)

const

Definition at line 45 of file Window.cpp.

qwindow

QMainWindow * Window::qwindow ( ) const

slot

Return a handle to the QMainWindow widget.

This is useful to e.g. parent dialog boxes and message box.

Definition at line 55 of file Window.cpp.

showView

void Window::showView ( View * view )

slot

Make the given view active in this window.

If the view does not belong to this window, nothing happens.

Definition at line 96 of file Window.cpp.

themeChanged

void Window::themeChanged ( )

signal

Emitted when we change the color theme.

views

QList< View * > Window::views ( ) const

slot

Returns

a list of open views in this window

Definition at line 69 of file Window.cpp.

windowClosed

void Window::windowClosed ( )

signal

Emitted when the window is closed.

---

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

• Window.h
• Window.cpp