PaletteView Class Reference

The PaletteView class is a wrapper around a MVC method for handling palettes. This class shows a nice widget that can drag and drop, edit colors in a colorset and will handle adding and removing entries if you'd like it to. More...

#include <PaletteView.h>

Inheritance diagram for PaletteView:

Public Slots
bool	addEntryWithDialog (ManagedColor *color)
	addEntryWithDialog This gives a simple dialog for adding colors, with options like adding name, id, and to which group the color should be added.
bool	addGroupWithDialog ()
	addGroupWithDialog gives a little dialog to ask for the desired groupname.
bool	removeSelectedEntryWithDialog ()
	removeSelectedEntryWithDialog removes the selected entry. If it is a group, it pop up a dialog asking whether the colors should also be removed.
void	setPalette (Palette *palette)
	setPalette Set a new palette.
void	trySelectClosestColor (ManagedColor *color)
	trySelectClosestColor tries to select the closest color to the one given. It does not force a change on the active color.

Signals
void	entrySelectedBackGround (Swatch entry)
	entrySelectedBackGround fires when a swatch is selected with rightclick.
void	entrySelectedForeGround (Swatch entry)
	entrySelectedForeGround fires when a swatch is selected with leftclick.

Public Member Functions
	PaletteView (QWidget *parent=0)
	~PaletteView ()

Private Slots
void	fgSelected (QModelIndex index)

Private Attributes
const QScopedPointer< Private >	d

Detailed Description

The PaletteView class is a wrapper around a MVC method for handling palettes. This class shows a nice widget that can drag and drop, edit colors in a colorset and will handle adding and removing entries if you'd like it to.

Definition at line 30 of file PaletteView.h.

Constructor & Destructor Documentation

PaletteView()

PaletteView::PaletteView

(

QWidget *

parent = 0

)

Definition at line 17 of file PaletteView.cpp.

    : QWidget(parent), d(new Private)
{
    d->widget = new KisPaletteView();
    d->model = new KisPaletteModel();
    d->widget->setPaletteModel(d->model);
 
    QVBoxLayout *layout = new QVBoxLayout(this);
    layout->addWidget(d->widget);
 
    //forward signals.
    connect(d->widget, SIGNAL(sigIndexSelected(QModelIndex)),
                 this, SLOT(fgSelected(QModelIndex)));
}

References connect(), d, and fgSelected().

~PaletteView()

PaletteView::~PaletteView

(

)

Definition at line 32 of file PaletteView.cpp.

{
    delete d->widget;
    delete d->model;
}

References d.

Member Function Documentation

addEntryWithDialog

bool PaletteView::addEntryWithDialog ( ManagedColor * color )

slot

addEntryWithDialog This gives a simple dialog for adding colors, with options like adding name, id, and to which group the color should be added.

Parameters

color

the default color to add

Returns

whether it was successful.

Definition at line 44 of file PaletteView.cpp.

{
    if (d->model->colorSet()) {
        return d->widget->addEntryWithDialog(color->color());
    }
    return false;
}

References ManagedColor::color(), and d.

addGroupWithDialog

bool PaletteView::addGroupWithDialog ( )

slot

addGroupWithDialog gives a little dialog to ask for the desired groupname.

Returns

whether this was successful.

Definition at line 52 of file PaletteView.cpp.

{
    if (d->model->colorSet()) {
        return d->widget->addGroupWithDialog();
    }
    return false;
}

References d.

entrySelectedBackGround

void PaletteView::entrySelectedBackGround ( Swatch entry )

signal

entrySelectedBackGround fires when a swatch is selected with rightclick.

Parameters

entry

entrySelectedForeGround

void PaletteView::entrySelectedForeGround ( Swatch entry )

signal

entrySelectedForeGround fires when a swatch is selected with leftclick.

Parameters

entry

fgSelected

void PaletteView::fgSelected ( QModelIndex index )

privateslot

Definition at line 73 of file PaletteView.cpp.

{
    KisSwatch swatch = d->model->getSwatch(index);
    Q_EMIT entrySelectedForeGround(Swatch(swatch));
}

References d, and entrySelectedForeGround().

removeSelectedEntryWithDialog

bool PaletteView::removeSelectedEntryWithDialog ( )

slot

removeSelectedEntryWithDialog removes the selected entry. If it is a group, it pop up a dialog asking whether the colors should also be removed.

Returns

whether this was successful

Definition at line 60 of file PaletteView.cpp.

{
    if (d->model->colorSet()) {
        return d->widget->removeEntryWithDialog(d->widget->currentIndex());
    }
    return false;
}

References d.

setPalette

void PaletteView::setPalette ( Palette * palette )

slot

setPalette Set a new palette.

Parameters

palette

Definition at line 38 of file PaletteView.cpp.

{
    d->model->setColorSet(palette->colorSet());
    d->widget->setPaletteModel(d->model);
}

References d, and palette.

trySelectClosestColor

void PaletteView::trySelectClosestColor ( ManagedColor * color )

slot

trySelectClosestColor tries to select the closest color to the one given. It does not force a change on the active color.

Parameters

color

the color to compare to.

Definition at line 68 of file PaletteView.cpp.

{
    d->widget->selectClosestColor(color->color());
}

References ManagedColor::color(), and d.

Member Data Documentation

d

const QScopedPointer<Private> PaletteView::d

private

Definition at line 94 of file PaletteView.h.

---

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

• libs/libkis/PaletteView.h
• libs/libkis/PaletteView.cpp