MuseScore/src/engraving/libmscore/textframe.cpp

/*
 * SPDX-License-Identifier: GPL-3.0-only
 * MuseScore-CLA-applies
 *
 * MuseScore
 * Music Composition & Notation
 *
 * Copyright (C) 2021 MuseScore BVBA and others
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
#include "textframe.h"

#include "draw/fontmetrics.h"
#include "io/xml.h"

#include "factory.h"
#include "box.h"
#include "text.h"
#include "score.h"
#include "barline.h"
#include "measurerepeat.h"
#include "symbol.h"
#include "system.h"
#include "image.h"
#include "layoutbreak.h"
#include "fret.h"
#include "mscore.h"

using namespace mu;
using namespace mu::engraving;

namespace Ms {
//---------------------------------------------------------
//   TBox
//---------------------------------------------------------

TBox::TBox(System* parent)
    : VBox(ElementType::TBOX, parent)
{
    setBoxHeight(Spatium(1));
    _text  = Factory::createText(this, Tid::FRAME);
    _text->setLayoutToParentWidth(true);
    _text->setParent(this);
}

TBox::TBox(const TBox& tbox)
    : VBox(tbox)
{
    _text = Factory::copyText(*(tbox._text));
}

TBox::~TBox()
{
    delete _text;
}

//---------------------------------------------------------
//   layout
///   The text box layout() adjusts the frame height to text
///   height.
//---------------------------------------------------------

void TBox::layout()
{
    setPos(PointF());        // !?
    bbox().setRect(0.0, 0.0, system()->width(), 0);
    _text->layout();

    qreal h = 0.;
    if (_text->empty()) {
        h = mu::draw::FontMetrics::ascent(_text->font());
    } else {
        h = _text->height();
    }
    qreal y = topMargin() * DPMM;
    _text->setPos(leftMargin() * DPMM, y);
    h += topMargin() * DPMM + bottomMargin() * DPMM;
    bbox().setRect(0.0, 0.0, system()->width(), h);

    MeasureBase::layout();    // layout LayoutBreak's
}

//---------------------------------------------------------
//   write
//---------------------------------------------------------

void TBox::write(XmlWriter& xml) const
{
    xml.startObject(this);
    Box::writeProperties(xml);
    _text->write(xml);
    xml.endObject();
}

//---------------------------------------------------------
//   read
//---------------------------------------------------------

void TBox::read(XmlReader& e)
{
    while (e.readNextStartElement()) {
        const QStringRef& tag(e.name());
        if (tag == "Text") {
            _text->read(e);
        } else if (Box::readProperties(e)) {
        } else {
            e.unknown();
        }
    }
}

//---------------------------------------------------------
//   drop
//---------------------------------------------------------

EngravingItem* TBox::drop(EditData& data)
{
    EngravingItem* e = data.dropElement;
    switch (e->type()) {
    case ElementType::TEXT:
        _text->undoChangeProperty(Pid::TEXT, toText(e)->xmlText());
        delete e;
        return _text;
    default:
        return VBox::drop(data);
    }
}

//---------------------------------------------------------
//   add
///   Add new EngravingItem \a el to TBox
//---------------------------------------------------------

void TBox::add(EngravingItem* e)
{
    if (e->isText()) {
        // does not normally happen, since drop() handles this directly
        _text->undoChangeProperty(Pid::TEXT, toText(e)->xmlText());
    } else {
        VBox::add(e);
    }
}

//---------------------------------------------------------
//   remove
//---------------------------------------------------------

void TBox::remove(EngravingItem* el)
{
    if (el == _text) {
        // does not normally happen, since Score::deleteItem() handles this directly
        // but if it does:
        // replace with new empty text element
        // this keeps undo/redo happier than just clearing the text
        qDebug("TBox::remove() - replacing _text");
        _text = Factory::createText(this, Tid::FRAME);
        _text->setLayoutToParentWidth(true);
        _text->setParent(this);
    } else {
        VBox::remove(el);
    }
}
}