Actor and Effect fields now show a "ghosted" caption saying their name when they are not focused on and blank.

Originally committed to SVN as r655.

aegisub/changelog.txt

@@ -54,6 +54,7 @@ Please visit http://aegisub.net to download latest version
 - Added buttons to Styles Manager to move styles up, down, to top or to bottom, on both storage and current script. (AMZ)
 - Added sorting functionality to Styles Manager, for both storage and current script. (AMZ)
 - Tweaked the layout of Subtitles Edit area. (AMZ)
+- Actor and Effect fields now show a "ghosted" caption saying their name when they are not focused on and blank. (AMZ)
 
 
 = 1.10 beta - 2006.08.07 ===========================

aegisub/idle_field_event.cpp

@@ -0,0 +1,163 @@
+// Copyright (c) 2006, 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
+//
+// Website: http://aegisub.cellosoft.com
+// Contact: mailto:zeratul@cellosoft.com
+//
+
+
+///////////
+// Headers
+#include "idle_field_event.h"
+#include <wx/event.h>
+#include <wx/settings.h>
+
+
+///////////////
+// Constructor
+IdleFieldHandler::IdleFieldHandler(wxWindow *_control,wxString _name) {
+	control = _control;
+	name = _name;
+	overriden = false;
+	locked = false;
+	text = NULL;
+	box = NULL;
+
+	// Set colours
+	original = control->GetForegroundColour();
+	grey = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT);
+	wxColour bg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW);
+	grey = wxColour((grey.Red() + bg.Red()) / 2,(grey.Green() + bg.Green()) / 2,(grey.Blue() + bg.Blue()) / 2);
+
+	// wxTextCtrl
+	if (control->IsKindOf(CLASSINFO(wxTextCtrl))) {
+		text = (wxTextCtrl*) control;
+		Connect(text->GetId(),wxEVT_COMMAND_TEXT_UPDATED,wxCommandEventHandler(IdleFieldHandler::OnChange));
+	}
+
+	// wxComboBox
+	else if (control->IsKindOf(CLASSINFO(wxComboBox))) {
+		box = (wxComboBox*) control;
+		Connect(box->GetId(),wxEVT_COMMAND_TEXT_UPDATED,wxCommandEventHandler(IdleFieldHandler::OnChange));
+		Connect(box->GetId(),wxEVT_COMMAND_COMBOBOX_SELECTED,wxCommandEventHandler(IdleFieldHandler::OnChange));
+	}
+
+	KillFocus();
+}
+
+
+///////////////
+// Event table
+BEGIN_EVENT_TABLE(IdleFieldHandler,wxEvtHandler)
+	EVT_SET_FOCUS(IdleFieldHandler::OnSetFocus)
+	EVT_KILL_FOCUS(IdleFieldHandler::OnKillFocus)
+END_EVENT_TABLE()
+
+
+///////////////////
+// Get Focus event
+void IdleFieldHandler::OnSetFocus(wxFocusEvent &event) {
+	SetFocus();
+	event.Skip();
+}
+
+
+///////////////////
+// Lose Focus event
+void IdleFieldHandler::OnKillFocus(wxFocusEvent &event) {
+	KillFocus();
+	event.Skip();
+}
+
+
+/////////////
+// Get focus
+void IdleFieldHandler::SetFocus() {
+	if (overriden) {
+		// Prepare
+		locked = true;
+		control->Freeze();
+		control->SetForegroundColour(original);
+
+		// Text
+		if (text) text->SetValue(_T(""));
+
+		// Box
+		if (box) box->SetValue(_T(""));
+
+		// Finish
+		overriden = false;
+		locked = false;
+		control->Thaw();
+	}
+}
+
+
+//////////////
+// Lose Focus
+void IdleFieldHandler::KillFocus() {
+	bool modify = false;
+	if (text && text->GetValue().IsEmpty() || box && box->GetValue().IsEmpty()) modify = true;
+
+	if (modify) {
+		// Prepare
+		locked = true;
+		control->Freeze();
+		control->SetForegroundColour(grey);
+
+		// Text
+		if (text) text->SetValue(name);
+
+		// Box
+		if (box) box->SetValue(name);
+
+		// Finish
+		overriden = true;
+		locked = false;
+		control->Thaw();
+	}
+}
+
+
+//////////////////////////
+// Parent control changed
+void IdleFieldHandler::OnChange(wxCommandEvent &event) {
+	if (locked) return;
+
+	overriden = false;
+	control->SetForegroundColour(original);
+	if (wxWindow::FindFocus() != control) {
+		wxFocusEvent focus(wxEVT_KILL_FOCUS,control->GetId());
+		focus.SetEventObject(control);
+		AddPendingEvent(focus);
+	}
+	event.Skip();
+}

aegisub/idle_field_event.h

@@ -0,0 +1,70 @@
+// Copyright (c) 2006, 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
+//
+// Website: http://aegisub.cellosoft.com
+// Contact: mailto:zeratul@cellosoft.com
+//
+
+
+#pragma once
+
+
+///////////
+// Headers
+#include <wx/wxprec.h>
+
+
+/////////
+// Class
+class IdleFieldHandler : public wxEvtHandler {
+private:
+	wxComboBox *box;
+	wxTextCtrl *text;
+	bool overriden;
+	bool locked;
+	wxColour grey;
+	wxColour original;
+
+	wxWindow *control;
+	wxString name;
+
+	void SetFocus();
+	void KillFocus();
+
+	void OnSetFocus(wxFocusEvent &event);
+	void OnKillFocus(wxFocusEvent &event);
+	void OnChange(wxCommandEvent &event);
+
+public:
+	IdleFieldHandler(wxWindow *control,wxString name);
+
+	DECLARE_EVENT_TABLE()
+};

aegisub/subs_edit_box.cpp

@@ -58,6 +58,7 @@
 #include "frame_main.h"
 #include "utils.h"
 #include "dialog_search_replace.h"
+#include "idle_field_event.h"
 
 
 
@@ -84,8 +85,10 @@ SubsEditBox::SubsEditBox (wxWindow *parent,SubtitlesGrid *gridp) : wxPanel(paren
 	StyleBox->SetToolTip(_("Style for this line."));
 	ActorBox = new wxComboBox(this,ACTOR_COMBOBOX,_T(""),wxDefaultPosition,wxSize(110,25),styles,wxCB_DROPDOWN);
 	ActorBox->SetToolTip(_("Actor name for this speech. This is only for reference, and is mainly useless."));
+	ActorBox->PushEventHandler(new IdleFieldHandler(ActorBox,_("Actor")));
 	Effect = new HiliModTextCtrl(this,EFFECT_BOX,_T(""),wxDefaultPosition,wxSize(120,20),0);
 	Effect->SetToolTip(_("Effect for this line. This can be used to store extra information for karaoke scripts, or for the effects supported by the renderer."));
+	Effect->PushEventHandler(new IdleFieldHandler(Effect,_("Effect")));
 
 	// Middle controls
 	Layer = new HiliModTextCtrl(this,LAYER_BOX,_T(""),wxDefaultPosition,wxSize(40,20),0,NumValidator());
@@ -251,6 +254,10 @@ void SubsEditBox::Update (bool timeOnly) {
 				StyleBox->Select(StyleBox->FindString(curdiag->Style));
 				ActorBox->SetValue(curdiag->Actor);
 				ActorBox->SetStringSelection(curdiag->Actor);
+
+				// Force actor box to update its idle status
+				wxCommandEvent changeEvent(wxEVT_COMMAND_TEXT_UPDATED,ActorBox->GetId());
+				ActorBox->GetEventHandler()->AddPendingEvent(changeEvent);
 			}
 
 			// Audio