oak-editor/app/dialog/sequence/sequence.h

/***

  Olive - Non-Linear Video Editor
  Copyright (C) 2022 Olive Team
  Modifications Copyright (C) 2025 mikesolar

  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  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 <http://www.gnu.org/licenses/>.

***/

#ifndef OAK_SEQUENCEDIALOG_H
#define OAK_SEQUENCEDIALOG_H

#include <QComboBox>
#include <QDialog>
#include <QSpinBox>

#include "node/project/sequence/sequence.h"
#include "sequencedialogparametertab.h"
#include "sequencedialogpresettab.h"
#include "undo/undocommand.h"

namespace olive
{

/**
 * @brief A dialog for editing Sequence parameters
 *
 * This dialog exposes all the parameters of a Sequence to users allowing them to set up a Sequence however they wish.
 * A Sequence can be sent to this dialog through the constructor. All fields will be filled using that Sequence's
 * parameters, allowing the user to view and edit them. Accepting the dialog will apply them back to that Sequence,
 * either directly or using an UndoCommand (see SetUndoable()).
 *
 * If creating a new Sequence, the Sequence must still be constructed first before sending it to SequenceDialog.
 * SequenceDialog does not create any new objects. In most cases when creating a new Sequence, editing its parameters
 * with SequenceDialog will be paired with the action of adding the Sequence to a project. In this situation, since the
 * latter will be the main undoable action, the parameter editing doesn't have to be undoable since to the user they'll
 * be viewed as one single action (see SetUndoable()).
 */
class SequenceDialog : public QDialog {
	Q_OBJECT
public:
	/**
   * @brief Used to set the dialog mode of operation (see SequenceDialog())
   */
	enum Type { k_new, k_existing };

	/**
   * @brief SequenceDialog Constructor
   *
   * @param s
   * Sequence to edit
   *
   * @param t
   * Mode of operation (changes some UI like the window title to best represent the action being performed)
   *
   * @param parent
   * QWidget parent
   */
	SequenceDialog(Sequence *s, Type t = k_existing, QWidget *parent = nullptr);

	/**
   * @brief Set whether the parameter changes should be made into an undo command or not
   *
   * Defaults to true.
   */
	void set_undoable(bool u);

	/**
   * @brief Set whether the name of this Sequence can be edited with this dialog
   *
   * Defaults to true.
   */
	void set_name_is_editable(bool e);

public slots:
	/**
   * @brief Function called when the user presses OK
   */
	virtual void accept() override;

private:
	Sequence *sequence_;

	SequenceDialogPresetTab *preset_tab_;

	SequenceDialogParameterTab *parameter_tab_;

	bool make_undoable_;

	QLineEdit *name_field_;

	/**
   * @brief An UndoCommand for setting the parameters on a sequence
   */
	class SequenceParamCommand : public UndoCommand {
	public:
		SequenceParamCommand(Sequence *s, const VideoParams &video_params,
							 const AudioParams &audio_params,
							 const QString &name, bool autocache);

		virtual Project *get_relevant_project() const override;

	protected:
		virtual void redo() override;
		virtual void undo() override;

	private:
		Sequence *sequence_;

		VideoParams new_video_params_;
		AudioParams new_audio_params_;
		QString new_name_;
		bool new_autocache_;

		VideoParams old_video_params_;
		AudioParams old_audio_params_;
		QString old_name_;
		bool old_autocache_;
	};

private slots:
	void set_as_default_clicked();
};

}

#endif // OAK_SEQUENCEDIALOG_H