Window Class Reference

#include <Window.h>

Inheritance diagram for Window:

Classes
struct	Private

Public Slots
void	activate ()
	activate activates this Window.
View *	activeView () const
View *	addView (Document *document)
void	close ()
	close the active window and all its Views. If there are no Views left for a given Document, that Document will also be closed.
QAction *	createAction (const QString &id, const QString &text=QString(), const QString &menuLocation=QString("tools/scripts"))
	createAction creates a QAction object and adds it to the action manager for this Window.
QList< QDockWidget * >	dockers () const
	dockers
QMainWindow *	qwindow () const
void	showView (View *v)
QList< View * >	views () const

Signals
void	activeViewChanged ()
	Emitted when the active view changes.
void	themeChanged ()
	Emitted when we change the color theme.
void	windowClosed ()
	Emitted when the window is closed.

Public Member Functions
bool	operator!= (const Window &other) const
bool	operator== (const Window &other) const
	Window (KisMainWindow *window, QObject *parent=0)
	~Window () override

Private Attributes
Private *const	d

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 29 of file Window.cpp.

    : QObject(parent)
    , d(new Private)
{
    d->window = window;
    connect(window, SIGNAL(destroyed(QObject*)), SIGNAL(windowClosed()));
    connect(window, SIGNAL(themeChanged()), SIGNAL(themeChanged()));
    connect(window, SIGNAL(activeViewChanged()), SIGNAL(activeViewChanged()));
}

References activeViewChanged(), d, themeChanged(), Window::Private::window, and windowClosed().

~Window()

Window::~Window ( )

override

Definition at line 39 of file Window.cpp.

{
    delete d;
}

References d.

Member Function Documentation

activate

void Window::activate ( )

slot

activate activates this Window.

Definition at line 112 of file Window.cpp.

{
    if (d->window) {
        d->window->activateWindow();
    }
}

References d, and Window::Private::window.

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.

{
    if (d->window) {
        return new View(d->window->activeView());
    }
    return 0;
}

References d, and Window::Private::window.

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 82 of file Window.cpp.

{
    if (d->window && document) {
        // Once the document is shown in the ui, it's owned by Krita
        // If the Document instance goes out of scope, it shouldn't
        // delete the owned image.
        document->setOwnsDocument(false);
        KisView *view = d->window->newView(document->document());
        return new View(view);
    }
    return 0;
}

References d, and Window::Private::window.

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.

{
    if (d->window) {
        KisPart::instance()->removeMainWindow(d->window);
        d->window->close();
    }
}

References d, KisPart::instance(), KisPart::removeMainWindow(), and Window::Private::window.

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.

{
    KisAction *action = d->window->viewManager()->actionManager()->createAction(id);
    if (!text.isEmpty()) {
        action->setText(text);
    }
    action->setObjectName(id);
    action->setProperty("menulocation", menuLocation);
    return action;
}

References d, and Window::Private::window.

dockers

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

slot

dockers

Returns

a list of all the dockers belonging to this window

Definition at line 59 of file Window.cpp.

{
    KisMainWindow *mainWindow = d->window;
 
    if (!mainWindow) return {};
 
    return mainWindow->dockWidgets();
}

References d, KisMainWindow::dockWidgets(), and Window::Private::window.

operator!=()

bool Window::operator!=

(

const Window &

other

)

const

Definition at line 49 of file Window.cpp.

{
    return !(operator==(other));
}

References operator==().

operator==()

bool Window::operator==

(

const Window &

other

)

const

Definition at line 44 of file Window.cpp.

{
    return (d->window == other.d->window);
}

References d, and Window::Private::window.

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 54 of file Window.cpp.

{
    return d->window;
}

References d, and Window::Private::window.

showView

void Window::showView ( View * v )

slot

Make the given view active in this window. If the view does not belong to this window, nothing happens.

Definition at line 95 of file Window.cpp.

{
    if (v && v->view()) {
        KisView *view = v->view();
        view->setVisible(true);
        d->window->setActiveView(view);
    }
}

References d, v, and Window::Private::window.

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 68 of file Window.cpp.

{
    QList<View *> ret;
    if (d->window) {
        foreach(QPointer<KisView> view, KisPart::instance()->views()) {
            if (view->mainWindow() == d->window) {
                ret << new View(view);
            }
        }
    }
    return ret;
 
}

References d, KisPart::instance(), views(), and Window::Private::window.

windowClosed

void Window::windowClosed ( )

signal

Emitted when the window is closed.

Member Data Documentation

d

Private* const Window::d

private

Definition at line 106 of file Window.h.

---

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

• libs/libkis/Window.h
• libs/libkis/Window.cpp