/***********************************************************************
* fbuttongroup.cpp - The FButtonGroup widget organizes FToggleButton *
* widgets in a group. *
* *
* This file is part of the Final Cut widget toolkit *
* *
* Copyright 2014-2019 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 *
* . *
***********************************************************************/
#include "final/fapplication.h"
#include "final/fbuttongroup.h"
#include "final/fcolorpair.h"
#include "final/fevent.h"
#include "final/fsize.h"
#include "final/fstatusbar.h"
#include "final/ftogglebutton.h"
namespace finalcut
{
//----------------------------------------------------------------------
// class FButtonGroup
//----------------------------------------------------------------------
// constructor and destructor
//----------------------------------------------------------------------
FButtonGroup::FButtonGroup(FWidget* parent)
: FScrollView(parent)
{
init();
}
//----------------------------------------------------------------------
FButtonGroup::FButtonGroup (const FString& txt, FWidget* parent)
: FScrollView(parent)
, text{txt}
{
init();
setText(txt);
}
//----------------------------------------------------------------------
FButtonGroup::~FButtonGroup() // destructor
{
if ( buttonlist.empty() )
return;
auto iter = buttonlist.begin();
while ( iter != buttonlist.end() )
{
auto toggle_button = static_cast(*iter);
toggle_button->setGroup(nullptr);
iter = buttonlist.erase(iter);
}
}
// public methods of FButtonGroup
//----------------------------------------------------------------------
FToggleButton* FButtonGroup::getButton (int index) const
{
if ( buttonlist.empty() )
return 0;
if ( index <= 0 || index > int(getCount()) )
return 0;
auto iter = buttonlist.begin();
std::advance (iter, index - 1);
return static_cast(*iter);
}
//----------------------------------------------------------------------
FToggleButton* FButtonGroup::getFirstButton()
{
auto widget = FWidget::getFirstFocusableWidget(buttonlist);
auto toggle_button = static_cast(widget);
return toggle_button;
}
//----------------------------------------------------------------------
FToggleButton* FButtonGroup::getLastButton()
{
auto widget = FWidget::getLastFocusableWidget(buttonlist);
auto toggle_button = static_cast(widget);
return toggle_button;
}
//----------------------------------------------------------------------
bool FButtonGroup::setEnable (bool enable)
{
FWidget::setEnable(enable);
if ( enable )
setHotkeyAccelerator();
else
delAccelerator();
return enable;
}
//----------------------------------------------------------------------
void FButtonGroup::setText (const FString& txt)
{
text.setString(txt);
if ( isEnabled() )
{
delAccelerator();
setHotkeyAccelerator();
}
}
//----------------------------------------------------------------------
bool FButtonGroup::isChecked (int index) const
{
auto button = getButton(index);
if ( button )
return button->isChecked();
else
return false;
}
//----------------------------------------------------------------------
bool FButtonGroup::hasFocusedButton() const
{
if ( buttonlist.empty() )
return false;
for (auto&& item : buttonlist)
{
auto toggle_button = static_cast(item);
if ( toggle_button->hasFocus() )
return true;
}
return false;
}
//----------------------------------------------------------------------
bool FButtonGroup::hasCheckedButton() const
{
if ( buttonlist.empty() )
return false;
for (auto&& item : buttonlist)
{
auto toggle_button = static_cast(item);
if ( toggle_button->isChecked() )
return true;
}
return false;
}
//----------------------------------------------------------------------
void FButtonGroup::hide()
{
FColor fg{}, bg{};
FWidget::hide();
auto parent_widget = getParentWidget();
if ( ! buttonlist.empty() )
{
for (auto&& item : buttonlist)
{
// Hide items
auto toggle_button = static_cast(item);
toggle_button->hide();
}
}
if ( parent_widget )
{
fg = parent_widget->getForegroundColor();
bg = parent_widget->getBackgroundColor();
}
else
{
const auto& wc = getFWidgetColors();
fg = wc.dialog_fg;
bg = wc.dialog_bg;
}
setColor (fg, bg);
std::size_t size = getWidth();
if ( size == 0 )
return;
// Hide border
unsetViewportPrint();
for (int y{0}; y < int(getHeight()); y++)
print() << FPoint(1, 1 + y) << FString(size, L' ');
setViewportPrint();
}
//----------------------------------------------------------------------
void FButtonGroup::insert (FToggleButton* button)
{
if ( ! button )
return;
if ( button->getGroup() )
button->getGroup()->remove(button);
// setChecked the first FRadioButton
if ( buttonlist.size() == 1 )
{
auto first_button = static_cast(*buttonlist.begin());
if ( isRadioButton(first_button) )
first_button->setChecked();
}
button->setGroup(this);
buttonlist.push_back(button);
button->addCallback
(
"toggled",
F_METHOD_CALLBACK (this, &FButtonGroup::cb_buttonToggled)
);
}
//----------------------------------------------------------------------
void FButtonGroup::remove (FToggleButton* button)
{
if ( ! button || buttonlist.empty() )
return;
auto iter = buttonlist.begin();
while ( iter != buttonlist.end() )
{
auto toggle_button = static_cast(*iter);
if ( toggle_button == button )
{
iter = buttonlist.erase(iter);
button->setGroup(nullptr);
button->delCallback(this);
break;
}
else
++iter;
}
}
//----------------------------------------------------------------------
void FButtonGroup::checkScrollSize (FToggleButton* button)
{
// Check and adjust the scroll size
checkScrollSize (button->getGeometry());
}
//----------------------------------------------------------------------
void FButtonGroup::checkScrollSize (const FRect& r)
{
// Check and adjust the scroll size
FRect scrollgeometry (1, 1, getScrollWidth(), getScrollHeight());
if ( ! scrollgeometry.contains(r) )
{
FRect r_combined (scrollgeometry.combined(r));
setScrollSize (r_combined.getSize());
}
}
//----------------------------------------------------------------------
void FButtonGroup::onMouseDown (FMouseEvent* ev)
{
if ( ev->getButton() != fc::LeftButton )
return;
directFocus();
}
//----------------------------------------------------------------------
void FButtonGroup::onAccel (FAccelEvent*)
{
directFocus();
}
//----------------------------------------------------------------------
void FButtonGroup::onFocusIn (FFocusEvent* in_ev)
{
in_ev->ignore(); // Change default value to ignore
if ( hasCheckedButton() && ! buttonlist.empty() )
{
for (auto&& item : buttonlist)
{
auto toggle_button = static_cast(item);
if ( toggle_button->isChecked() )
{
if ( isRadioButton(toggle_button) )
{
auto prev_element = getFocusWidget();
toggle_button->setFocus();
FFocusEvent cfi (fc::ChildFocusIn_Event);
FApplication::sendEvent(this, &cfi);
FFocusEvent in (fc::FocusIn_Event);
FApplication::sendEvent(toggle_button, &in);
if ( in.isAccepted() )
in_ev->accept();
if ( prev_element )
prev_element->redraw();
toggle_button->redraw();
}
break;
}
} // end of range-based for loop
}
if ( ! in_ev->isAccepted() )
{
in_ev->accept();
auto prev_element = getFocusWidget();
if ( in_ev->getFocusType() == fc::FocusNextWidget )
focusFirstChild();
else if ( in_ev->getFocusType() == fc::FocusPreviousWidget )
focusLastChild();
if ( prev_element )
prev_element->redraw();
if ( getFocusWidget() )
getFocusWidget()->redraw();
}
if ( getStatusBar() )
{
getStatusBar()->drawMessage();
updateTerminal();
flushOutputBuffer();
}
}
// protected methods of FButtonGroup
//----------------------------------------------------------------------
void FButtonGroup::setHotkeyAccelerator()
{
setHotkeyViaString (this, text);
}
//----------------------------------------------------------------------
void FButtonGroup::draw()
{
if ( isMonochron() )
setReverse(true);
setColor();
clearArea();
if ( isMonochron() )
setReverse(false);
FScrollView::draw();
drawLabel();
}
//----------------------------------------------------------------------
void FButtonGroup::drawLabel()
{
if ( text.isNull() || text.isEmpty() )
return;
FString label_text{};
FString txt{" " + text + " "};
unsetViewportPrint();
auto hotkeypos = finalcut::getHotkeyPos(txt, label_text);
if ( hasBorder() )
FWidget::setPrintPos (FPoint(2, 1));
else
FWidget::setPrintPos (FPoint(0, 1));
drawText (label_text, hotkeypos);
setViewportPrint();
}
// private methods of FButtonGroup
//----------------------------------------------------------------------
bool FButtonGroup::isRadioButton (const FToggleButton* button) const
{
if ( ! button )
return false;
return bool( button->getClassName() == "FRadioButton" );
}
//----------------------------------------------------------------------
void FButtonGroup::init()
{
const auto& wc = getFWidgetColors();
setForegroundColor (wc.label_fg);
setBackgroundColor (wc.label_bg);
setMinimumSize (FSize(7, 3));
buttonlist.clear(); // no buttons yet
}
//----------------------------------------------------------------------
void FButtonGroup::drawText ( const FString& label_text
, std::size_t hotkeypos )
{
const auto& wc = getFWidgetColors();
std::size_t column_width = getColumnWidth(label_text);
std::size_t length = label_text.getLength();
bool ellipsis{false};
if ( column_width > getClientWidth() )
{
std::size_t len = getClientWidth() - 3;
FString s = finalcut::getColumnSubString (label_text, 1, len);
length = s.getLength();
ellipsis = true;
}
if ( isMonochron() )
setReverse(true);
if ( isEnabled() )
setColor(wc.label_emphasis_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) && getFlags().active )
{
setColor (wc.label_hotkey_fg, wc.label_hotkey_bg);
if ( ! getFlags().no_underline )
setUnderline();
print (label_text[z]);
if ( ! getFlags().no_underline )
unsetUnderline();
setColor (wc.label_emphasis_fg, wc.label_bg);
}
else
print (label_text[z]);
}
if ( ellipsis ) // Print ellipsis
print() << FColorPair (wc.label_ellipsis_fg, wc.label_bg) << "..";
if ( isMonochron() )
setReverse(true);
}
//----------------------------------------------------------------------
void FButtonGroup::directFocus()
{
if ( ! hasFocusedButton() )
{
bool found_checked{false};
if ( hasCheckedButton() && ! buttonlist.empty() )
{
for (auto&& item : buttonlist)
{
auto toggle_button = static_cast(item);
if ( toggle_button->isChecked() )
{
if ( isRadioButton(toggle_button) )
{
found_checked = true;
auto focused_widget = getFocusWidget();
toggle_button->setFocus();
if ( focused_widget )
focused_widget->redraw();
focused_widget = getFocusWidget();
if ( focused_widget )
focused_widget->redraw();
}
break;
}
} // end of range-based for loop
}
if ( ! found_checked )
{
auto focused_widget = getFocusWidget();
focusFirstChild();
if ( focused_widget )
focused_widget->redraw();
focused_widget = getFocusWidget();
if ( focused_widget )
focused_widget->redraw();
}
}
if ( getStatusBar() )
{
getStatusBar()->drawMessage();
updateTerminal();
flushOutputBuffer();
}
}
//----------------------------------------------------------------------
void FButtonGroup::cb_buttonToggled (FWidget* widget, FDataPtr)
{
auto button = static_cast(widget);
if ( ! button->isChecked() )
return;
if ( buttonlist.empty() )
return;
for (auto&& item : buttonlist)
{
auto toggle_button = static_cast(item);
if ( toggle_button != button
&& toggle_button->isChecked()
&& isRadioButton(toggle_button) )
{
toggle_button->unsetChecked();
if ( toggle_button->isShown() )
toggle_button->redraw();
}
}
}
} // namespace finalcut