Notifier Class Reference

#include <Notifier.h>

Inheritance diagram for Notifier:

Classes
struct	Private

Signals
void	applicationClosing ()
	applicationClosing is emitted when the application is about to close. This happens after any documents and windows are closed.
void	configurationChanged ()
	configurationChanged is emitted every time Krita's configuration has changed.
void	imageClosed (const QString &filename)
	imageClosed is emitted whenever the last view on an image is closed. The image does not exist anymore in Krita
void	imageCreated (Document *image)
	imageCreated is emitted whenever a new image is created and registered with the application.
void	imageSaved (const QString &filename)
	imageSaved is emitted whenever a document is saved.
void	viewClosed (View *view)
	viewClosed is emitted whenever a view is closed
void	viewCreated (View *view)
	viewCreated is emitted whenever a new view is created.
void	windowCreated ()
	windowIsCreated is emitted after main window is completely created
void	windowIsBeingCreated (Window *window)
	windowCreated is emitted whenever a window is being created

Public Member Functions
bool	active () const
	Notifier (QObject *parent=0)
void	setActive (bool value)
	~Notifier () override

Properties
bool	Active

Private Slots
void	imageCreated (KisDocument *document)
void	viewClosed (KisView *view)
void	viewCreated (KisView *view)
void	windowIsBeingCreated (KisMainWindow *window)

Private Attributes
Private *const	d

Detailed Description

The Notifier can be used to be informed of state changes in the Krita application.

Definition at line 22 of file Notifier.h.

Constructor & Destructor Documentation

Notifier()

Notifier::Notifier ( QObject * parent = 0 )

explicit

Definition at line 19 of file Notifier.cpp.

    : QObject(parent)
    , d(new Private)
{
    connect(qApp, SIGNAL(aboutToQuit()), SIGNAL(applicationClosing()));
 
    connect(KisPart::instance(), SIGNAL(sigDocumentAdded(KisDocument*)), SLOT(imageCreated(KisDocument*)));
    connect(KisPart::instance(), SIGNAL(sigDocumentSaved(QString)), SIGNAL(imageSaved(QString)));
    connect(KisPart::instance(), SIGNAL(sigDocumentRemoved(QString)), SIGNAL(imageClosed(QString)));
 
    connect(KisPart::instance(), SIGNAL(sigViewAdded(KisView*)), SLOT(viewCreated(KisView*)));
    connect(KisPart::instance(), SIGNAL(sigViewRemoved(KisView*)), SLOT(viewClosed(KisView*)));
 
    connect(KisPart::instance(), SIGNAL(sigMainWindowIsBeingCreated(KisMainWindow*)), SLOT(windowIsBeingCreated(KisMainWindow*)));
 
    connect(KisPart::instance(), SIGNAL(sigMainWindowCreated()), SIGNAL(windowCreated()));
 
    connect(KisConfigNotifier::instance(), SIGNAL(configChanged()), SIGNAL(configurationChanged()));
 
    blockSignals(false);
}

References applicationClosing(), configurationChanged(), connect(), imageClosed(), imageCreated(), imageSaved(), KisConfigNotifier::instance(), KisPart::instance(), viewClosed(), viewCreated(), windowCreated(), and windowIsBeingCreated().

~Notifier()

Notifier::~Notifier ( )

override

Definition at line 42 of file Notifier.cpp.

{
    delete d;
}

References d.

Member Function Documentation

active()

bool Notifier::active

(

)

const

Returns

true if the Notifier is active.

Definition at line 47 of file Notifier.cpp.

{
    return d->active;
}

References Notifier::Private::active, and d.

applicationClosing

void Notifier::applicationClosing ( )

signal

applicationClosing is emitted when the application is about to close. This happens after any documents and windows are closed.

configurationChanged

void Notifier::configurationChanged ( )

signal

configurationChanged is emitted every time Krita's configuration has changed.

imageClosed

void Notifier::imageClosed ( const QString & filename )

signal

imageClosed is emitted whenever the last view on an image is closed. The image does not exist anymore in Krita

Parameters

filename

the filename of the image.

imageCreated [1/2]

void Notifier::imageCreated ( Document * image )

signal

imageCreated is emitted whenever a new image is created and registered with the application.

imageCreated [2/2]

void Notifier::imageCreated ( KisDocument * document )

privateslot

Definition at line 58 of file Notifier.cpp.

{
    Document *doc = new Document(document, false);
    Q_EMIT imageCreated(doc);
    delete doc;
}

References imageCreated().

imageSaved

void Notifier::imageSaved ( const QString & filename )

signal

imageSaved is emitted whenever a document is saved.

Parameters

filename

the filename of the document that has been saved.

setActive()

void Notifier::setActive

(

bool

value

)

Enable or disable the Notifier

Definition at line 52 of file Notifier.cpp.

{
    d->active = value;
    blockSignals(!value);
}

References Notifier::Private::active, d, and value().

viewClosed [1/2]

void Notifier::viewClosed ( KisView * view )

privateslot

Definition at line 72 of file Notifier.cpp.

{
    View *v = new View(view);
    Q_EMIT viewClosed(v);
    delete v;
}

References v, and viewClosed().

viewClosed [2/2]

void Notifier::viewClosed ( View * view )

signal

viewClosed is emitted whenever a view is closed

Parameters

view

the view

viewCreated [1/2]

void Notifier::viewCreated ( KisView * view )

privateslot

Definition at line 65 of file Notifier.cpp.

{
    View *v = new View(view);
    Q_EMIT viewCreated(v);
    delete v;
}

References v, and viewCreated().

viewCreated [2/2]

void Notifier::viewCreated ( View * view )

signal

viewCreated is emitted whenever a new view is created.

Parameters

view

the view

windowCreated

void Notifier::windowCreated ( )

signal

windowIsCreated is emitted after main window is completely created

windowIsBeingCreated [1/2]

void Notifier::windowIsBeingCreated ( KisMainWindow * window )

privateslot

Definition at line 79 of file Notifier.cpp.

{
    Window *w = new Window(window);
    Q_EMIT windowIsBeingCreated(w);
    delete w;
}

References windowIsBeingCreated().

windowIsBeingCreated [2/2]

void Notifier::windowIsBeingCreated ( Window * window )

signal

windowCreated is emitted whenever a window is being created

Parameters

window

the window; this is called from the constructor of the window, before the xmlgui file is loaded

Member Data Documentation

d

Private* const Notifier::d

private

Definition at line 111 of file Notifier.h.

Property Documentation

Active

bool Notifier::Active

readwrite

Definition at line 27 of file Notifier.h.

---

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

• libs/libkis/Notifier.h
• libs/libkis/Notifier.cpp