Aegisub/aegisub/src/timeedit_ctrl.cpp
Thomas Goyne d990bbbb99 Eliminate all unnecessary uses of L and _T
Originally committed to SVN as r5611.
2011-09-28 19:43:11 +00:00

330 lines
8 KiB
C++

// Copyright (c) 2005, Rodrigo Braz Monteiro
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
// * Neither the name of the Aegisub Group nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// Aegisub Project http://www.aegisub.org/
//
// $Id$
/// @file timeedit_ctrl.cpp
/// @brief Edit-control for editing SSA-format timestamps
/// @ingroup custom_control
///
#include "config.h"
#ifndef AGI_PRE
#include <wx/clipbrd.h>
#include <wx/dataobj.h>
#include <wx/menu.h>
#include <wx/valtext.h>
#endif
#include "ass_time.h"
#include "compat.h"
#include "main.h"
#include "timeedit_ctrl.h"
#include "video_context.h"
#ifdef __WXGTK__
/// Use the multiline style only on wxGTK to workaround some wxGTK bugs with the default singleline style.
#define TimeEditWindowStyle wxTE_MULTILINE | wxTE_CENTRE
#else
/// All other platforms than wxGTK.
#define TimeEditWindowStyle wxTE_CENTRE
#endif
/// @brief Constructor
/// @param parent
/// @param id
/// @param value
/// @param pos
/// @param size
/// @param style
/// @param validator
/// @param name
///
TimeEdit::TimeEdit(wxWindow* parent, wxWindowID id, const wxString& value, const wxPoint& pos, const wxSize& size, long style, const wxValidator& validator, const wxString& name) :
wxTextCtrl(parent,id,value,pos,size,TimeEditWindowStyle | style,validator,name)
{
// Set validator
wxTextValidator val(wxFILTER_INCLUDE_CHAR_LIST);
wxArrayString includes;
includes.Add("0");
includes.Add("1");
includes.Add("2");
includes.Add("3");
includes.Add("4");
includes.Add("5");
includes.Add("6");
includes.Add("7");
includes.Add("8");
includes.Add("9");
includes.Add(".");
includes.Add(":");
val.SetIncludes(includes);
SetValidator(val);
// Other stuff
if (!value) SetValue(time.GetASSFormated());
// This is a multiline control on wxGTK so we need to size it manually there
#ifdef __WXGTK__
int w, h;
GetTextExtent(GetValue(),&w,&h);
w += 30;
h += 8;
SetSizeHints(w,h,w,h);
#endif
ready = true;
byFrame = false;
isEnd = false;
Bind(wxEVT_COMMAND_TEXT_UPDATED, &TimeEdit::OnModified, this);
Bind(wxEVT_CONTEXT_MENU, &TimeEdit::OnContextMenu, this);
}
BEGIN_EVENT_TABLE(TimeEdit, wxTextCtrl)
EVT_KEY_DOWN(TimeEdit::OnKeyDown)
EVT_MENU(Time_Edit_Copy,TimeEdit::OnCopy)
EVT_MENU(Time_Edit_Paste,TimeEdit::OnPaste)
END_EVENT_TABLE()
/// @brief Modified event
/// @param event
void TimeEdit::OnModified(wxCommandEvent &event) {
event.Skip();
Modified();
}
/// @brief Modified function
void TimeEdit::Modified() {
if (!ready) return;
ready = false;
if (byFrame) Update();
else UpdateTime(true);
ready = true;
}
/// @brief Set time and update stuff
/// @param ms
/// @param setModified
void TimeEdit::SetTime(AssTime newTime) {
if (newTime != time) {
time = newTime;
UpdateText();
}
}
/// @brief Toggles between set by frame and time
/// @param enable
void TimeEdit::SetByFrame(bool enableByFrame) {
if (enableByFrame == byFrame) return;
if (enableByFrame) {
if (VideoContext::Get()->IsLoaded()) {
byFrame = true;
UpdateText();
}
}
else {
byFrame = false;
UpdateText();
}
}
/// @brief Update text to reflect time value
void TimeEdit::UpdateText() {
ready = false;
if (byFrame) {
int frame_n = VideoContext::Get()->FrameAtTime(time.GetMS(),isEnd ? agi::vfr::END : agi::vfr::START);
ChangeValue(wxString::Format("%i", frame_n));
}
else ChangeValue(time.GetASSFormated());
ready = true;
}
/// @brief Update
void TimeEdit::Update() {
if (byFrame) {
long temp;
GetValue().ToLong(&temp);
SetTime(VideoContext::Get()->TimeAtFrame(temp,isEnd ? agi::vfr::END : agi::vfr::START));
}
// Update time if not on insertion mode
else if (!OPT_GET("Subtitle/Time Edit/Insert Mode")->GetBool()) {
UpdateTime();
}
}
/// @brief Reads value from a text control and update it
/// @param byUser
void TimeEdit::UpdateTime(bool byUser) {
bool insertion = OPT_GET("Subtitle/Time Edit/Insert Mode")->GetBool();
wxString text = GetValue();
long start=0,end=0;
if (insertion && byUser) {
GetSelection(&start,&end);
if (start == end) {
wxString nextChar = text.Mid(start,1);
if (nextChar == ":" || nextChar == ".") {
wxString temp = text;
text = temp.Left(start-1);
text += nextChar;
text += temp.Mid(start-1,1);
text += temp.Mid(start+2);
start++;
end++;
}
else if (nextChar.IsEmpty()) text.Remove(start-1,1);
else text.Remove(start,1);
}
}
// Update time
time.ParseASS(text);
if (insertion) {
ChangeValue(time.GetASSFormated());
SetSelection(start,end);
}
}
/// @brief Key pressed
/// @param event
void TimeEdit::OnKeyDown(wxKeyEvent &event) {
// Get key ID
int key = event.GetKeyCode();
bool insertMode = OPT_GET("Subtitle/Time Edit/Insert Mode")->GetBool();
Refresh();
// Check if it's an acceptable key
#ifdef __APPLE__
if (!event.CmdDown()) {
#else
if (!event.ControlDown()) {
#endif
if (byFrame || !insertMode || (key != WXK_BACK && key != WXK_DELETE)) {
// Reset selection first, if necessary
if (!byFrame && insertMode) {
long from=0,to=0;
GetSelection(&from,&to);
if (to != from) SetSelection(from,from);
}
// Allow it through
event.Skip();
}
}
else {
// Copy
if (key == 'C' || key == 'X') {
CopyTime();
}
// Paste
if (key == 'V') {
PasteTime();
}
}
}
///// Mouse/copy/paste events down here /////
/// @brief Mouse event
/// @param event
void TimeEdit::OnContextMenu(wxContextMenuEvent &event) {
if (!byFrame && OPT_GET("Subtitle/Time Edit/Insert Mode")->GetBool()) {
wxMenu menu;
menu.Append(Time_Edit_Copy,_("&Copy"));
menu.Append(Time_Edit_Paste,_("&Paste"));
PopupMenu(&menu);
}
}
/// @brief Menu Copy
void TimeEdit::OnCopy(wxCommandEvent &) {
SetFocus();
SetSelection(0,GetValue().Length());
CopyTime();
Refresh();
}
/// @brief Menu Paste
void TimeEdit::OnPaste(wxCommandEvent &) {
SetFocus();
PasteTime();
Refresh();
}
/// @brief Copy to clipboard
void TimeEdit::CopyTime() {
if (byFrame) {
Copy();
return;
}
// Time
if (wxTheClipboard->Open()) {
wxTheClipboard->SetData(new wxTextDataObject(GetStringSelection()));
wxTheClipboard->Close();
}
}
/// @brief Paste from clipboard
void TimeEdit::PasteTime() {
if (byFrame) {
Paste();
return;
}
// Time
if (wxTheClipboard->Open()) {
// Read text
wxString text;
if (wxTheClipboard->IsSupported(wxDF_TEXT)) {
wxTextDataObject data;
wxTheClipboard->GetData(data);
text = data.GetText();
text.Trim(false).Trim(true);
}
wxTheClipboard->Close();
// Paste time
AssTime tempTime;
tempTime.ParseASS(text);
if (tempTime.GetASSFormated() == text) {
ready = false;
SetValue(text);
SetSelection(0,GetValue().Length());
ready = true;
Modified();
}
}
}