/*********************************************************************** * fwindow.cpp - Intermediate base class for all window objects * * * * This file is part of the Final Cut widget toolkit * * * * Copyright 2015-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/fevent.h" #include "final/fmenubar.h" #include "final/fstatusbar.h" #include "final/fwindow.h" namespace finalcut { // static attributes FWindow* FWindow::previous_window = nullptr; //---------------------------------------------------------------------- // class FWindow //---------------------------------------------------------------------- // constructor and destructor //---------------------------------------------------------------------- FWindow::FWindow(FWidget* parent) : FWidget(parent) { setWindowWidget(); FRect geometry = getTermGeometry(); geometry.move(-1, -1); createArea (geometry, getShadow(), vwin); addWindow (this); } //---------------------------------------------------------------------- FWindow::~FWindow() // destructor { auto fapp = FApplication::getApplicationObject(); if ( previous_window == this ) previous_window = nullptr; if ( isAlwaysOnTop() ) deleteFromAlwaysOnTopList (this); // unset the global active window if ( this == FWindow::getActiveWindow() ) unsetActiveWindow(); delWindow (this); if ( ! fapp->isQuit() ) { const auto& t_geometry = getTermGeometryWithShadow(); restoreVTerm (t_geometry); } removeArea (vwin); } // public methods of FWindow //---------------------------------------------------------------------- FWidget* FWindow::getWindowFocusWidget() const { // returns the focused widget of this window return win_focus_widget; } //---------------------------------------------------------------------- bool FWindow::setWindowWidget (bool enable) { if ( isWindowWidget() == enable ) return true; flags.window_widget = enable; if ( enable ) setTermOffset(); else setParentOffset(); return enable; } //---------------------------------------------------------------------- void FWindow::setActiveWindow (FWindow* window) { // activate FWindow object window if ( ! window_list ) return; if ( window_list->empty() ) return; auto iter = window_list->begin(); auto end = window_list->end(); while ( iter != end ) { if ( *iter == window ) { if ( ! window->isWindowActive() ) { window->activateWindow(); FEvent ev(fc::WindowActive_Event); FApplication::sendEvent(window, &ev); } } else { auto w = static_cast(*iter); if ( w->isWindowActive() ) { w->deactivateWindow(); FEvent ev(fc::WindowInactive_Event); FApplication::sendEvent(*iter, &ev); } } ++iter; } } //---------------------------------------------------------------------- void FWindow::setWindowFocusWidget (const FWidget* obj) { // set focus widget of this window win_focus_widget = const_cast(obj); } //---------------------------------------------------------------------- bool FWindow::activateWindow (bool enable) { // activate/deactivate this window if ( enable ) { FWidget::setActiveWindow (this); active_area = getVWin(); } return (window_active = enable); } //---------------------------------------------------------------------- void FWindow::unsetActiveWindow() { // unset the active FWindow object FWidget::setActiveWindow (0); } //---------------------------------------------------------------------- bool FWindow::setResizeable (bool enable) { return (flags.resizeable = enable); } //---------------------------------------------------------------------- bool FWindow::setTransparentShadow (bool enable) { flags.shadow = flags.trans_shadow = enable; if ( enable ) setShadowSize (FSize(2, 1)); else setShadowSize (FSize(0, 0)); return enable; } //---------------------------------------------------------------------- bool FWindow::setShadow (bool enable) { if ( isMonochron() ) return false; if ( enable ) { flags.shadow = true; flags.trans_shadow = false; setShadowSize (FSize(1, 1)); } else { flags.shadow = false; flags.trans_shadow = false; setShadowSize (FSize(0, 0)); } return enable; } //---------------------------------------------------------------------- bool FWindow::setAlwaysOnTop (bool enable) { if ( isAlwaysOnTop() == enable ) return true; flags.always_on_top = enable; if ( enable ) { if ( always_on_top_list ) { deleteFromAlwaysOnTopList (this); always_on_top_list->push_back (this); } } else deleteFromAlwaysOnTopList (this); return enable; } //---------------------------------------------------------------------- bool FWindow::isWindowHidden() const { // returns the window hidden state if ( isVirtualWindow() ) return ! vwin->visible; else return false; } //---------------------------------------------------------------------- void FWindow::drawBorder() { if ( isNewFont() ) { int x1 = 1 , x2 = 1 + int(getWidth()) - 1 , y1 = 1 , y2 = 1 + int(getHeight()) - 1; print() << FPoint(x1, y1) << fc::NF_border_corner_upper_left; // ⎡ for (int x = x1 + 1; x < x2; x++) print (fc::NF_border_line_upper); // ¯ print (fc::NF_rev_border_corner_upper_right); // ⎤ for (int y = y1 + 1; y < y2; y++) { print() << FPoint(x1, y) // border left ⎸ << fc::NF_border_line_left << FPoint(x2, y) // border right⎹ << fc::NF_rev_border_line_right; } print() << FPoint(x1, y2) // lower left corner border ⎣ << fc::NF_border_corner_lower_left; for (std::size_t x = 2; x < getWidth(); x++) // low line _ print (fc::NF_border_line_bottom); print() << FPoint(x2, y2) // lower right corner border ⎦ << fc::NF_rev_border_corner_lower_right; } else { FWidget::drawBorder(); } } //---------------------------------------------------------------------- void FWindow::show() { if ( isVirtualWindow() ) vwin->visible = true; FWidget::show(); } //---------------------------------------------------------------------- void FWindow::hide() { if ( isVirtualWindow() ) vwin->visible = false; FWidget::hide(); } //---------------------------------------------------------------------- void FWindow::setX (int x, bool adjust) { FWidget::setX (x, adjust); if ( isVirtualWindow() ) vwin->offset_left = getTermX() - 1; } //---------------------------------------------------------------------- void FWindow::setY (int y, bool adjust) { if ( y < 1 ) y = 1; FWidget::setY (y, adjust); if ( isVirtualWindow() ) vwin->offset_top = getTermY() - 1; } //---------------------------------------------------------------------- void FWindow::setPos (const FPoint& p, bool adjust) { FPoint pos = p; if ( pos.getY() < 1 ) pos.setY(1); FWidget::setPos (pos, adjust); if ( isVirtualWindow() ) { vwin->offset_left = getTermX() - 1; vwin->offset_top = getTermY() - 1; } } //---------------------------------------------------------------------- void FWindow::setWidth (std::size_t w, bool adjust) { std::size_t old_width = getWidth(); FWidget::setWidth (w, adjust); if ( isVirtualWindow() && getWidth() != old_width ) { FRect geometry = getTermGeometry(); geometry.move(-1, -1); resizeArea (geometry, getShadow(), vwin); } } //---------------------------------------------------------------------- void FWindow::setHeight (std::size_t h, bool adjust) { std::size_t old_height = getHeight(); FWidget::setHeight (h, adjust); if ( isVirtualWindow() && getHeight() != old_height ) { FRect geometry = getTermGeometry(); geometry.move(-1, -1); resizeArea (geometry, getShadow(), vwin); } } //---------------------------------------------------------------------- void FWindow::setSize (const FSize& size, bool adjust) { std::size_t old_width = getWidth(); std::size_t old_height = getHeight(); FWidget::setSize (size, adjust); if ( isVirtualWindow() && (getWidth() != old_width || getHeight() != old_height) ) { FRect geometry = getTermGeometry(); geometry.move(-1, -1); resizeArea (geometry, getShadow(), vwin); } } //---------------------------------------------------------------------- void FWindow::setGeometry ( const FPoint& p, const FSize& size, bool adjust) { // Sets the geometry of the widget int old_x = getX(); int old_y = getY(); FPoint pos = p; FSize old_size = getSize(); if ( pos.getY() < 1 ) pos.setY(1); FWidget::setGeometry (pos, size, adjust); if ( ! isVirtualWindow() ) return; if ( getSize() != old_size ) { FRect geometry = getTermGeometry(); geometry.move(-1, -1); resizeArea (geometry, getShadow(), vwin); } else { if ( getX() != old_x ) vwin->offset_left = getTermX() - 1; if ( getY() != old_y ) vwin->offset_top = getTermY() - 1; } } //---------------------------------------------------------------------- void FWindow::move (const FPoint& pos) { FWidget::move(pos); if ( isVirtualWindow() ) { vwin->offset_left = getTermX() - 1; vwin->offset_top = getTermY() - 1; } } //---------------------------------------------------------------------- FWindow* FWindow::getWindowWidgetAt (int x, int y) { // returns the window object to the corresponding coordinates if ( window_list && ! window_list->empty() ) { auto iter = window_list->end(); auto begin = window_list->begin(); do { --iter; if ( *iter ) { auto w = static_cast(*iter); if ( ! w->isWindowHidden() && w->getTermGeometry().contains(x, y) ) return w; } } while ( iter != begin ); } return 0; } //---------------------------------------------------------------------- void FWindow::addWindow (FWidget* obj) { // add the window object obj to the window list if ( window_list ) window_list->push_back(obj); processAlwaysOnTop(); } //---------------------------------------------------------------------- void FWindow::delWindow (FWidget* obj) { // delete the window object obj from the window list if ( ! window_list || window_list->empty() ) return; auto iter = window_list->begin(); while ( iter != window_list->end() ) { if ( (*iter) == obj ) { window_list->erase (iter); return; } ++iter; } } //---------------------------------------------------------------------- FWindow* FWindow::getWindowWidget (const FWidget* obj) { // returns the window object to the given widget obj auto p_obj = obj->getParentWidget(); while ( ! obj->isWindowWidget() && p_obj ) { obj = p_obj; p_obj = p_obj->getParentWidget(); } if ( obj->isWindowWidget() ) return const_cast(static_cast(obj)); else return 0; } //---------------------------------------------------------------------- int FWindow::getWindowLayer (const FWidget* obj) { // returns the window layer from the widget obj const FWidget* window; if ( ! window_list ) return -1; if ( window_list->empty() ) return -1; if ( ! obj->isWindowWidget() ) { if ( (window = getWindowWidget(obj)) == 0 ) return -1; } else window = obj; auto iter = window_list->begin(); auto end = window_list->end(); while ( iter != end ) { if ( *iter == window ) break; ++iter; } return int(std::distance(window_list->begin(), iter) + 1); } //---------------------------------------------------------------------- void FWindow::swapWindow (FWidget* obj1, FWidget* obj2) { // swaps the window layer between obj1 and obj2 if ( ! window_list ) return; if ( window_list->empty() ) return; if ( obj1->getFlags().modal ) return; if ( obj2->getFlags().modal ) return; auto iter = window_list->begin(); auto end = window_list->end(); auto iter1 = end; auto iter2 = end; while ( iter != end ) { if ( (*iter) == obj1 ) iter1 = iter; else if ( (*iter) == obj2 ) iter2 = iter; ++iter; } if ( iter1 != end && iter2 != end ) std::swap (iter1, iter2); } //---------------------------------------------------------------------- bool FWindow::raiseWindow (FWidget* obj) { // raises the window widget obj to the top if ( ! window_list ) return false; if ( window_list->empty() ) return false; if ( ! obj->isWindowWidget() ) return false; if ( window_list->back() == obj ) return false; if ( window_list->back()->getFlags().modal && ! obj->isMenuWidget() ) return false; auto iter = window_list->begin(); while ( iter != window_list->end() ) { if ( *iter == obj ) { window_list->erase (iter); window_list->push_back (obj); FEvent ev(fc::WindowRaised_Event); FApplication::sendEvent(obj, &ev); processAlwaysOnTop(); return true; } ++iter; } return false; } //---------------------------------------------------------------------- bool FWindow::lowerWindow (FWidget* obj) { // lowers the window widget obj to the bottom if ( ! window_list ) return false; if ( window_list->empty() ) return false; if ( ! obj->isWindowWidget() ) return false; if ( window_list->front() == obj ) return false; if ( obj->getFlags().modal ) return false; auto iter = window_list->begin(); while ( iter != window_list->end() ) { if ( *iter == obj ) { window_list->erase (iter); window_list->insert (window_list->begin(), obj); FEvent ev(fc::WindowLowered_Event); FApplication::sendEvent(obj, &ev); return true; } ++iter; } return false; } //---------------------------------------------------------------------- bool FWindow::zoomWindow() { if ( zoomed ) { zoomed = false; FRect oldGeometry = getTermGeometryWithShadow(); setGeometry (normalGeometry); restoreVTerm (oldGeometry); redraw(); } else { zoomed = true; // save the current geometry normalGeometry = getGeometry(); FRect oldGeometry = getTermGeometryWithShadow(); setGeometry (FPoint(1, 1), FSize(getMaxWidth(), getMaxHeight())); restoreVTerm (oldGeometry); redraw(); } return zoomed; } //---------------------------------------------------------------------- void FWindow::switchToPrevWindow (FWidget* widget) { // switch to previous window // Disable terminal updates to avoid flickering // when redrawing the focused widget if ( widget ) widget->updateTerminal (FVTerm::stop_refresh); bool is_activated = activatePrevWindow(); auto active_win = static_cast(getActiveWindow()); if ( ! is_activated ) { // no previous window -> looking for another window if ( window_list && window_list->size() > 1 ) { auto iter = window_list->end(); auto begin = window_list->begin(); do { --iter; auto w = static_cast(*iter); if ( w && w != active_win && ! (w->isWindowHidden() || w->isWindowActive()) && w != static_cast(getStatusBar()) && w != static_cast(getMenuBar()) ) { setActiveWindow(w); break; } } while ( iter != begin ); } } if ( active_win ) { auto focus = active_win->getWindowFocusWidget(); if ( ! active_win->isWindowActive() ) setActiveWindow(active_win); if ( focus) { focus->setFocus(); if ( ! focus->isWindowWidget() ) focus->redraw(); } } // Enable terminal updates again if ( widget ) widget->updateTerminal (FVTerm::continue_refresh); } //---------------------------------------------------------------------- bool FWindow::activatePrevWindow() { // activate the previous window auto w = previous_window; if ( w ) { if ( w->isWindowActive() ) return true; if ( ! w->isWindowHidden() ) { setActiveWindow(w); return true; } } return false; } //---------------------------------------------------------------------- void FWindow::setShadowSize (const FSize& size) { const FSize& old_shadow = getShadow(); FWidget::setShadowSize (size); const FSize& new_shadow = getShadow(); if ( isVirtualWindow() && (new_shadow != old_shadow) ) { auto geometry = getTermGeometry(); geometry.move(-1, -1); resizeArea (geometry, getShadow(), vwin); } } // protected methods of FWindow //---------------------------------------------------------------------- void FWindow::adjustSize() { int old_x = getX(); int old_y = getY(); FWidget::adjustSize(); if ( zoomed ) setGeometry (FPoint(1, 1), FSize(getMaxWidth(), getMaxHeight()), false); else if ( isVirtualWindow() ) { if ( getX() != old_x ) vwin->offset_left = getTermX() - 1; if ( getY() != old_y ) vwin->offset_top = getTermY() - 1; } } //---------------------------------------------------------------------- bool FWindow::event (FEvent* ev) { switch ( uInt(ev->type()) ) { case fc::WindowActive_Event: onWindowActive (ev); break; case fc::WindowInactive_Event: onWindowInactive (ev); break; case fc::WindowRaised_Event: onWindowRaised (ev); break; case fc::WindowLowered_Event: onWindowLowered (ev); break; default: return FWidget::event(ev); } return true; } //---------------------------------------------------------------------- void FWindow::onWindowActive (FEvent*) { } //---------------------------------------------------------------------- void FWindow::onWindowInactive (FEvent*) { } //---------------------------------------------------------------------- void FWindow::onWindowRaised (FEvent*) { } //---------------------------------------------------------------------- void FWindow::onWindowLowered (FEvent*) { } // private methods of FWindow //---------------------------------------------------------------------- void FWindow::deleteFromAlwaysOnTopList (FWidget* obj) { // delete the window object obj from the always-on-top list if ( ! always_on_top_list || always_on_top_list->empty() ) return; auto iter = always_on_top_list->begin(); while ( iter != always_on_top_list->end() ) { if ( *iter == obj ) { always_on_top_list->erase (iter); return; } ++iter; } } //---------------------------------------------------------------------- void FWindow::processAlwaysOnTop() { // Raise all always-on-top windows if ( ! always_on_top_list || always_on_top_list->empty() ) return; auto iter = always_on_top_list->begin(); while ( iter != always_on_top_list->end() ) { delWindow (*iter); if ( window_list ) window_list->push_back(*iter); ++iter; } } } // namespace finalcut