MuseScore  3.4
Music composition and notation
Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
Ms::UserPaletteController Class Reference

#include <paletteworkspace.h>

Inheritance diagram for Ms::UserPaletteController:
Inheritance graph
[legend]
Collaboration diagram for Ms::UserPaletteController:
Collaboration graph
[legend]

Public Member Functions

 UserPaletteController (QAbstractItemModel *m, PaletteTreeModel *userPalette, QObject *parent=nullptr)
 
bool visible () const
 
void setVisible (bool val)
 
bool custom () const
 
void setCustom (bool val)
 
Qt::DropAction dropAction (const QVariantMap &mimeData, Qt::DropAction proposedAction, const QModelIndex &parent, bool internal) const override
 
bool move (const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild) override
 
bool insert (const QModelIndex &parent, int row, const QVariantMap &mimeData, Qt::DropAction action) override
 
bool insertNewItem (const QModelIndex &parent, int row) override
 
void remove (const QModelIndex &index) override
 
void removeSelection (const QModelIndexList &, const QModelIndex &parent) override
 
void editPaletteProperties (const QModelIndex &index) override
 
void editCellProperties (const QModelIndex &index) override
 
bool userEditable () const
 
void setUserEditable (bool val)
 
bool canEdit (const QModelIndex &) const override
 
bool applyPaletteElement (const QModelIndex &index, Qt::KeyboardModifiers modifiers) override
 
- Public Member Functions inherited from Ms::AbstractPaletteController
 AbstractPaletteController (QObject *parent=nullptr)
 
Q_INVOKABLE Ms::PaletteElementEditorelementEditor (const QModelIndex &index)
 

Protected Member Functions

QAbstractItemModel * model ()
 
const QAbstractItemModel * model () const
 

Private Types

enum  RemoveActionConfirmationType { NoConfirmation, CustomCellHideDeleteConfirmation, CustomPaletteHideDeleteConfirmation }
 

Private Member Functions

bool canDropElements () const override
 
void showHideOrDeleteDialog (const QString &question, std::function< void(RemoveAction)> resultHandler) const
 
void queryRemove (const QModelIndexList &, int customCount)
 
void remove (const QModelIndexList &, AbstractPaletteController::RemoveAction)
 

Private Attributes

QAbstractItemModel * _model
 
PaletteTreeModel_userPalette
 
bool _visible = true
 
bool _custom = false
 
bool _filterCustom = false
 
bool _userEditable = true
 

Additional Inherited Members

- Public Types inherited from Ms::AbstractPaletteController
enum  RemoveAction { RemoveAction::NoAction, RemoveAction::Hide, RemoveAction::DeletePermanently, RemoveAction::AutoAction }
 
- Properties inherited from Ms::AbstractPaletteController
bool canDropElements
 Whether dropping new elements to this palette is generally allowed. More...
 

Member Enumeration Documentation

◆ RemoveActionConfirmationType

Enumerator
NoConfirmation 
CustomCellHideDeleteConfirmation 
CustomPaletteHideDeleteConfirmation 

Constructor & Destructor Documentation

◆ UserPaletteController()

Ms::UserPaletteController::UserPaletteController ( QAbstractItemModel *  m,
PaletteTreeModel userPalette,
QObject *  parent = nullptr 
)
inline

Member Function Documentation

◆ applyPaletteElement()

bool Ms::UserPaletteController::applyPaletteElement ( const QModelIndex &  index,
Qt::KeyboardModifiers  modifiers 
)
overridevirtual

Reimplemented from Ms::AbstractPaletteController.

◆ canDropElements()

bool Ms::UserPaletteController::canDropElements ( ) const
inlineoverrideprivatevirtual

Reimplemented from Ms::AbstractPaletteController.

◆ canEdit()

bool Ms::UserPaletteController::canEdit ( const QModelIndex &  index) const
overridevirtual

Reimplemented from Ms::AbstractPaletteController.

◆ custom()

bool Ms::UserPaletteController::custom ( ) const
inline

◆ dropAction()

Qt::DropAction Ms::UserPaletteController::dropAction ( const QVariantMap &  mimeData,
Qt::DropAction  proposedAction,
const QModelIndex &  parent,
bool  internal 
) const
overridevirtual

Reimplemented from Ms::AbstractPaletteController.

◆ editCellProperties()

void Ms::UserPaletteController::editCellProperties ( const QModelIndex &  index)
overridevirtual

Reimplemented from Ms::AbstractPaletteController.

◆ editPaletteProperties()

void Ms::UserPaletteController::editPaletteProperties ( const QModelIndex &  index)
overridevirtual

Reimplemented from Ms::AbstractPaletteController.

◆ insert()

bool Ms::UserPaletteController::insert ( const QModelIndex &  parent,
int  row,
const QVariantMap &  mimeData,
Qt::DropAction  action 
)
overridevirtual

◆ insertNewItem()

bool Ms::UserPaletteController::insertNewItem ( const QModelIndex &  parent,
int  row 
)
overridevirtual

◆ model() [1/2]

QAbstractItemModel* Ms::UserPaletteController::model ( )
inlineprotected

◆ model() [2/2]

const QAbstractItemModel* Ms::UserPaletteController::model ( ) const
inlineprotected

◆ move()

bool Ms::UserPaletteController::move ( const QModelIndex &  sourceParent,
int  sourceRow,
const QModelIndex &  destinationParent,
int  destinationChild 
)
overridevirtual

◆ queryRemove()

void Ms::UserPaletteController::queryRemove ( const QModelIndexList &  removeIndices,
int  customCount 
)
private

◆ remove() [1/2]

void Ms::UserPaletteController::remove ( const QModelIndexList &  unsortedRemoveIndices,
AbstractPaletteController::RemoveAction  action 
)
private

◆ remove() [2/2]

void Ms::UserPaletteController::remove ( const QModelIndex &  index)
overridevirtual

◆ removeSelection()

void Ms::UserPaletteController::removeSelection ( const QModelIndexList &  selectedIndexes,
const QModelIndex &  parent 
)
overridevirtual

◆ setCustom()

void Ms::UserPaletteController::setCustom ( bool  val)
inline

◆ setUserEditable()

void Ms::UserPaletteController::setUserEditable ( bool  val)
inline

◆ setVisible()

void Ms::UserPaletteController::setVisible ( bool  val)
inline

◆ showHideOrDeleteDialog()

void Ms::UserPaletteController::showHideOrDeleteDialog ( const QString &  question,
std::function< void(RemoveAction)>  resultHandler 
) const
private

◆ userEditable()

bool Ms::UserPaletteController::userEditable ( ) const
inline

◆ visible()

bool Ms::UserPaletteController::visible ( ) const
inline

Member Data Documentation

◆ _custom

bool Ms::UserPaletteController::_custom = false
private

◆ _filterCustom

bool Ms::UserPaletteController::_filterCustom = false
private

◆ _model

QAbstractItemModel* Ms::UserPaletteController::_model
private

◆ _userEditable

bool Ms::UserPaletteController::_userEditable = true
private

◆ _userPalette

PaletteTreeModel* Ms::UserPaletteController::_userPalette
private

◆ _visible

bool Ms::UserPaletteController::_visible = true
private

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