finalcut/src/ftogglebutton.cpp

664 lines
15 KiB
C++

/***********************************************************************
* ftogglebutton.cpp - Intermediate base class for a toggle button *
* *
* This file is part of the Final Cut widget toolkit *
* *
* Copyright 2014-2018 Markus Gans *
* *
* The Final Cut is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public License *
* as published by the Free Software Foundation; either version 3 of *
* the License, or (at your option) any later version. *
* *
* The Final Cut 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 Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this program. If not, see *
* <http://www.gnu.org/licenses/>. *
***********************************************************************/
#include "final/fapplication.h"
#include "final/fbuttongroup.h"
#include "final/fstatusbar.h"
#include "final/ftogglebutton.h"
namespace finalcut
{
//----------------------------------------------------------------------
// class FToggleButton
//----------------------------------------------------------------------
// constructor and destructor
//----------------------------------------------------------------------
FToggleButton::FToggleButton (FWidget* parent)
: FWidget(parent)
{
init();
if ( parent && parent->isInstanceOf("FButtonGroup") )
{
setGroup(static_cast<FButtonGroup*>(parent));
if ( hasGroup() )
getGroup()->insert(this); // insert into button group
}
}
//----------------------------------------------------------------------
FToggleButton::FToggleButton (const FString& txt, FWidget* parent)
: FWidget(parent)
{
FToggleButton::setText(txt); // call own method
init();
if ( parent && parent->isInstanceOf("FButtonGroup") )
{
setGroup(static_cast<FButtonGroup*>(parent));
if ( hasGroup() )
getGroup()->insert(this); // insert into button group
}
}
//----------------------------------------------------------------------
FToggleButton::~FToggleButton() // destructor
{
delAccelerator();
if ( hasGroup() )
getGroup()->remove(this);
}
// public methods of FToggleButton
//----------------------------------------------------------------------
void FToggleButton::setGeometry ( int x, int y
, std::size_t w, std::size_t h
, bool adjust )
{
// Set the toggle button geometry
std::size_t hotkey_mark = ( getHotkey() ) ? 1 : 0;
std::size_t min_width = button_width + text.getLength() - hotkey_mark;
if ( w < min_width )
w = min_width;
const FRect geometry(x, y, w, h);
if ( hasGroup() )
getGroup()->checkScrollSize(geometry);
FWidget::setGeometry(x, y, w, h, adjust);
}
//----------------------------------------------------------------------
bool FToggleButton::setNoUnderline (bool enable)
{
return (flags.no_underline = enable);
}
//----------------------------------------------------------------------
bool FToggleButton::setEnable (bool enable)
{
FWidget::setEnable(enable);
if ( enable )
{
setHotkeyAccelerator();
if ( hasFocus() )
{
setForegroundColor (wc.toggle_button_active_focus_fg);
setBackgroundColor (wc.toggle_button_active_focus_bg);
}
else
{
setForegroundColor (wc.toggle_button_active_fg);
setBackgroundColor (wc.toggle_button_active_bg);
}
}
else
{
delAccelerator();
setForegroundColor (wc.toggle_button_inactive_fg);
setBackgroundColor (wc.toggle_button_inactive_bg);
}
return enable;
}
//----------------------------------------------------------------------
bool FToggleButton::setFocus (bool enable)
{
FWidget::setFocus(enable);
if ( enable )
{
if ( isEnabled() )
{
if ( isRadioButton() )
focus_inside_group = false;
setForegroundColor (wc.toggle_button_active_focus_fg);
setBackgroundColor (wc.toggle_button_active_focus_bg);
if ( getStatusBar() )
{
const auto& msg = getStatusbarMessage();
const auto& curMsg = getStatusBar()->getMessage();
if ( curMsg != msg )
getStatusBar()->setMessage(msg);
}
}
}
else
{
if ( isEnabled() )
{
setForegroundColor (wc.toggle_button_active_fg);
setBackgroundColor (wc.toggle_button_active_bg);
if ( getStatusBar() )
getStatusBar()->clearMessage();
}
}
return enable;
}
//----------------------------------------------------------------------
bool FToggleButton::setChecked (bool enable)
{
if ( checked != enable )
{
checked = enable;
processToggle();
}
return checked;
}
//----------------------------------------------------------------------
void FToggleButton::setText (const FString& txt)
{
text = txt;
std::size_t hotkey_mark = ( getHotkey() ) ? 1 : 0;
setWidth(button_width + text.getLength() - hotkey_mark);
if ( isEnabled() )
{
delAccelerator();
setHotkeyAccelerator();
}
}
//----------------------------------------------------------------------
void FToggleButton::hide()
{
std::size_t size;
FColor fg, bg;
auto parent_widget = getParentWidget();
FWidget::hide();
if ( parent_widget )
{
fg = parent_widget->getForegroundColor();
bg = parent_widget->getBackgroundColor();
}
else
{
fg = wc.dialog_fg;
bg = wc.dialog_bg;
}
setColor (fg, bg);
size = getWidth();
if ( size == 0 )
return;
auto blank = createBlankArray(size + 1);
setPrintPos (1, 1);
print (blank);
destroyBlankArray (blank);
}
//----------------------------------------------------------------------
void FToggleButton::onMouseDown (FMouseEvent* ev)
{
if ( ev->getButton() != fc::LeftButton )
return;
if ( hasFocus() )
return;
auto focused_widget = getFocusWidget();
setFocus();
if ( focused_widget )
focused_widget->redraw();
redraw();
if ( getStatusBar() )
{
getStatusBar()->drawMessage();
updateTerminal();
flush_out();
}
}
//----------------------------------------------------------------------
void FToggleButton::onMouseUp (FMouseEvent* ev)
{
if ( ev->getButton() != fc::LeftButton )
return;
if ( ! getTermGeometry().contains(ev->getTermPos()) )
return;
if ( isRadioButton() )
{
if ( ! checked )
{
checked = true;
processToggle();
}
}
else
{
checked = ! checked;
processToggle();
}
redraw();
processClick();
}
//----------------------------------------------------------------------
void FToggleButton::onWheel (FWheelEvent* ev)
{
if ( ! hasGroup() )
return;
getGroup()->onWheel(ev);
}
//----------------------------------------------------------------------
void FToggleButton::onAccel (FAccelEvent* ev)
{
if ( ! isEnabled() )
return;
if ( ! hasFocus() )
{
auto focused_widget = static_cast<FWidget*>(ev->focusedWidget());
if ( focused_widget && focused_widget->isWidget() )
{
setFocus();
focused_widget->redraw();
}
}
if ( isRadioButton() )
{
if ( ! checked )
{
checked = true;
processToggle();
}
}
else
{
checked = ! checked;
processToggle();
}
redraw();
if ( getStatusBar() )
{
getStatusBar()->drawMessage();
updateTerminal();
flush_out();
}
processClick();
ev->accept();
}
//----------------------------------------------------------------------
void FToggleButton::onFocusIn (FFocusEvent*)
{
if ( getStatusBar() )
getStatusBar()->drawMessage();
}
//----------------------------------------------------------------------
void FToggleButton::onFocusOut (FFocusEvent* out_ev)
{
if ( getStatusBar() )
{
getStatusBar()->clearMessage();
getStatusBar()->drawMessage();
}
if ( ! hasGroup() )
return;
if ( ! focus_inside_group && isRadioButton() )
{
focus_inside_group = true;
out_ev->ignore();
if ( out_ev->getFocusType() == fc::FocusNextWidget )
getGroup()->focusNextChild();
if ( out_ev->getFocusType() == fc::FocusPreviousWidget )
getGroup()->focusPrevChild();
redraw();
}
else if ( this == getGroup()->getLastButton()
&& out_ev->getFocusType() == fc::FocusNextWidget )
{
out_ev->ignore();
getGroup()->focusNextChild();
redraw();
}
else if ( this == getGroup()->getFirstButton()
&& out_ev->getFocusType() == fc::FocusPreviousWidget )
{
out_ev->ignore();
getGroup()->focusPrevChild();
redraw();
}
}
// protected methods of FToggleButton
//----------------------------------------------------------------------
uChar FToggleButton::getHotkey()
{
if ( text.isEmpty() )
return 0;
std::size_t length = text.getLength();
for (std::size_t i = 0; i < length; i++)
{
try
{
if ( i + 1 < length && text[i] == '&' )
return uChar(text[++i]);
}
catch (const std::out_of_range&)
{
return 0;
}
}
return 0;
}
//----------------------------------------------------------------------
void FToggleButton::setHotkeyAccelerator()
{
uChar hotkey = getHotkey();
if ( hotkey )
{
if ( std::isalpha(hotkey) || std::isdigit(hotkey) )
{
addAccelerator (FKey(std::tolower(hotkey)));
addAccelerator (FKey(std::toupper(hotkey)));
// Meta + hotkey
addAccelerator (fc::Fmkey_meta + FKey(std::tolower(hotkey)));
}
else
addAccelerator (getHotkey());
}
else
delAccelerator();
}
//----------------------------------------------------------------------
bool FToggleButton::isRadioButton() const
{
return isInstanceOf("FRadioButton");
}
//----------------------------------------------------------------------
bool FToggleButton::isCheckboxButton() const
{
return isInstanceOf("FCheckBox");
}
//----------------------------------------------------------------------
void FToggleButton::draw()
{
if ( flags.focus && getStatusBar() )
{
const auto& msg = getStatusbarMessage();
const auto& curMsg = getStatusBar()->getMessage();
if ( curMsg != msg )
{
getStatusBar()->setMessage(msg);
getStatusBar()->drawMessage();
}
}
// set the cursor to the button
if ( isRadioButton() || isCheckboxButton() )
setCursorPos (2, 1);
}
//----------------------------------------------------------------------
void FToggleButton::drawLabel()
{
wchar_t* LabelText;
if ( ! isVisible() )
return;
if ( text.isNull() || text.isEmpty() )
return;
std::size_t length = text.getLength();
try
{
LabelText = new wchar_t[length + 1]();
}
catch (const std::bad_alloc& ex)
{
std::cerr << bad_alloc_str << ex.what() << std::endl;
return;
}
FString txt = text;
wchar_t* src = const_cast<wchar_t*>(txt.wc_str());
wchar_t* dest = const_cast<wchar_t*>(LabelText);
auto hotkeypos = getHotkeyPos(src, dest, length);
if ( hotkeypos != NOT_SET )
length--;
setPrintPos (1 + int(label_offset_pos), 1);
drawText (LabelText, hotkeypos, length);
delete[] LabelText;
}
//----------------------------------------------------------------------
void FToggleButton::processClick()
{
emitCallback("clicked");
}
//----------------------------------------------------------------------
void FToggleButton::processToggle()
{
emitCallback("toggled");
}
//----------------------------------------------------------------------
void FToggleButton::onKeyPress (FKeyEvent* ev)
{
if ( ! isEnabled() )
return;
FKey key = ev->key();
switch ( key )
{
case fc::Fkey_return:
case fc::Fkey_enter:
case fc::Fkey_space:
if ( isRadioButton() )
{
if ( ! checked )
{
checked = true;
processToggle();
}
}
else
{
checked = ! checked;
processToggle();
}
processClick();
ev->accept();
break;
case fc::Fkey_down:
case fc::Fkey_right:
focus_inside_group = true;
focusNextChild();
ev->accept();
break;
case fc::Fkey_up:
case fc::Fkey_left:
focus_inside_group = true;
focusPrevChild();
ev->accept();
break;
default:
break;
}
if ( ev->isAccepted() )
{
draw();
updateTerminal();
}
}
// private methods of FToggleButton
//----------------------------------------------------------------------
void FToggleButton::setGroup (FButtonGroup* btngroup)
{
button_group = btngroup;
}
//----------------------------------------------------------------------
void FToggleButton::init()
{
setGeometry (1, 1, 4, 1, false); // initialize geometry values
if ( isEnabled() )
{
if ( hasFocus() )
{
setForegroundColor (wc.toggle_button_active_focus_fg);
setBackgroundColor (wc.toggle_button_active_focus_bg);
}
else
{
setForegroundColor (wc.toggle_button_active_fg);
setBackgroundColor (wc.toggle_button_active_bg);
}
}
else // inactive
{
setForegroundColor (wc.label_inactive_fg);
setBackgroundColor (wc.label_inactive_bg);
}
}
//----------------------------------------------------------------------
std::size_t FToggleButton::getHotkeyPos ( wchar_t src[]
, wchar_t dest[]
, std::size_t length )
{
// find hotkey position in string
// + generate a new string without the '&'-sign
std::size_t pos = NOT_SET;
wchar_t* txt = src;
for (std::size_t i = 0; i < length; i++)
{
if ( i < length && txt[i] == L'&' && pos == NOT_SET )
{
pos = i;
i++;
src++;
}
*dest++ = *src++;
}
return pos;
}
//----------------------------------------------------------------------
void FToggleButton::drawText ( wchar_t LabelText[]
, std::size_t hotkeypos
, std::size_t length )
{
if ( isMonochron() )
setReverse(true);
if ( isEnabled() )
setColor (wc.label_fg, wc.label_bg);
else
setColor (wc.label_inactive_fg, wc.label_inactive_bg);
for (std::size_t z = 0; z < length; z++)
{
if ( (z == hotkeypos) && flags.active )
{
setColor (wc.label_hotkey_fg, wc.label_hotkey_bg);
if ( ! flags.no_underline )
setUnderline();
print ( LabelText[z] );
if ( ! flags.no_underline )
unsetUnderline();
setColor (wc.label_fg, wc.label_bg);
}
else
print (LabelText[z]);
}
if ( isMonochron() )
setReverse(false);
}
} // namespace finalcut