finalcut/include/final/fwindow.h

277 lines
9.8 KiB
C
Raw Normal View History

2017-11-04 07:03:53 +01:00
/***********************************************************************
* fwindow.h - Intermediate base class for all window objects *
* *
* This file is part of the Final Cut widget toolkit *
* *
* Copyright 2015-2017 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/>. *
***********************************************************************/
/* Inheritance diagram
*
*
*
* FTerm
*
*
*
*
* FVTerm FObject
*
*
*
*
*
*
* FWidget
*
*
*
* 1 *
* FWindow -- - - - FEvent
* :
* :
* : *
* :- - - - FPoint
* :
* :
* : *
* - - - - FWidget
*
*/
2015-05-23 13:35:12 +02:00
#ifndef FWINDOW_H
#define FWINDOW_H
2015-05-23 13:35:12 +02:00
#if !defined (USE_FINAL_H) && !defined (COMPILE_FINAL_CUT)
#error "Only <final/final.h> can be included directly."
#endif
#include "final/fwidget.h"
2015-05-23 13:35:12 +02:00
//----------------------------------------------------------------------
// class FWindow
//----------------------------------------------------------------------
#pragma pack(push)
#pragma pack(1)
class FWindow : public FWidget
{
public:
// Using-declaration
using FWidget::drawBorder;
using FWidget::setPos;
using FWidget::setGeometry;
using FWidget::move;
// Constructor
explicit FWindow (FWidget* = 0);
// Destructor
~FWindow ();
2015-05-23 13:35:12 +02:00
// Accessors
2015-05-23 13:35:12 +02:00
const char* getClassName() const;
2017-08-12 20:10:27 +02:00
static FWindow* getWindowWidget (const FWidget*);
static int getWindowLayer (const FWidget*);
static FWindow* getActiveWindow();
FWidget* getWindowFocusWidget() const;
// Mutators
bool setWindowWidget (bool);
bool setWindowWidget();
bool unsetWindowWidget();
static void setActiveWindow (FWindow*);
2017-08-12 20:10:27 +02:00
void setWindowFocusWidget (const FWidget*);
bool activateWindow (bool);
bool activateWindow();
2017-03-12 00:29:56 +01:00
void unsetActiveWindow();
bool deactivateWindow();
virtual bool setResizeable (bool);
virtual bool setResizeable();
bool unsetResizeable();
bool setTransparentShadow (bool);
bool setTransparentShadow();
bool unsetTransparentShadow();
bool setShadow (bool);
bool setShadow();
bool unsetShadow();
bool setAlwaysOnTop (bool);
bool setAlwaysOnTop();
bool unsetAlwaysOnTop();
// Inquiries
bool isZoomed() const;
bool isWindowActive() const;
bool isWindowHidden() const;
bool isResizeable() const;
bool isAlwaysOnTop() const;
bool hasTransparentShadow() const;
bool hasShadow() const;
// Methods
virtual void drawBorder();
virtual void show();
virtual void hide();
virtual void setX (int, bool = true);
virtual void setY (int, bool = true);
virtual void setPos (int, int, bool = true);
virtual void setWidth (int, bool = true);
virtual void setHeight (int, bool = true);
virtual void setSize (int, int, bool = true);
void setGeometry (int, int, int, int, bool = true);
virtual void move (int, int);
2015-10-19 00:07:07 +02:00
static FWindow* getWindowWidgetAt (const FPoint&);
static FWindow* getWindowWidgetAt (int, int);
2015-05-23 13:35:12 +02:00
static void addWindow (FWidget*);
static void delWindow (FWidget*);
static void swapWindow (FWidget*, FWidget*);
static bool raiseWindow (FWidget*);
bool raiseWindow ();
static bool lowerWindow (FWidget*);
bool lowerWindow ();
bool zoomWindow ();
static void switchToPrevWindow();
2015-05-23 13:35:12 +02:00
static bool activatePrevWindow();
2016-10-09 02:06:06 +02:00
virtual void setShadowSize (int, int);
protected:
// Method
virtual void adjustSize();
// Event handlers
bool event (FEvent*);
virtual void onWindowActive (FEvent*);
virtual void onWindowInactive (FEvent*);
virtual void onWindowRaised (FEvent*);
virtual void onWindowLowered (FEvent*);
// Data Members
static FWindow* previous_window;
private:
// Disable copy constructor
FWindow (const FWindow&);
// Disable assignment operator (=)
FWindow& operator = (const FWindow&);
// Methods
static void deleteFromAlwaysOnTopList (FWidget*);
static void processAlwaysOnTop();
// Data Members
bool window_active;
bool zoomed;
FWidget* win_focus_widget;
FRect normalGeometry;
2015-05-23 13:35:12 +02:00
};
#pragma pack(pop)
// FWindow inline functions
//----------------------------------------------------------------------
inline const char* FWindow::getClassName() const
{ return "FWindow"; }
//----------------------------------------------------------------------
inline bool FWindow::setWindowWidget()
{ return setWindowWidget(true); }
//----------------------------------------------------------------------
inline bool FWindow::unsetWindowWidget()
{ return setWindowWidget(false); }
2015-05-23 13:35:12 +02:00
//----------------------------------------------------------------------
inline bool FWindow::activateWindow()
{ return activateWindow(true); }
//----------------------------------------------------------------------
inline bool FWindow::deactivateWindow()
{ return activateWindow(false); }
2016-10-09 02:06:06 +02:00
//----------------------------------------------------------------------
inline bool FWindow::setResizeable()
{ return setResizeable(true); }
//----------------------------------------------------------------------
inline bool FWindow::unsetResizeable()
{ return setResizeable(false); }
//----------------------------------------------------------------------
inline bool FWindow::setTransparentShadow()
{ return setTransparentShadow(true); }
//----------------------------------------------------------------------
inline bool FWindow::unsetTransparentShadow()
{ return setTransparentShadow(false); }
//----------------------------------------------------------------------
inline bool FWindow::setShadow()
{ return setShadow(true); }
//----------------------------------------------------------------------
inline bool FWindow::unsetShadow()
{ return setShadow(false); }
//----------------------------------------------------------------------
inline bool FWindow::setAlwaysOnTop()
{ return setAlwaysOnTop(true); }
//----------------------------------------------------------------------
inline bool FWindow::unsetAlwaysOnTop()
{ return setAlwaysOnTop(false); }
//----------------------------------------------------------------------
inline bool FWindow::isZoomed() const
{ return zoomed; }
//----------------------------------------------------------------------
inline bool FWindow::isWindowActive() const
{ return window_active; }
//----------------------------------------------------------------------
inline bool FWindow::isResizeable() const
{ return ((flags & fc::resizeable) != 0); }
//----------------------------------------------------------------------
inline bool FWindow::isAlwaysOnTop() const
{ return ((flags & fc::always_on_top) != 0); }
//----------------------------------------------------------------------
inline bool FWindow::hasTransparentShadow() const
{ return ((flags & fc::trans_shadow) != 0); }
//----------------------------------------------------------------------
inline bool FWindow::hasShadow() const
{ return ((flags & fc::shadow) != 0); }
//----------------------------------------------------------------------
inline FWindow* FWindow::getWindowWidgetAt (const FPoint& pos)
{ return getWindowWidgetAt (pos.getX(), pos.getY()); }
//----------------------------------------------------------------------
inline bool FWindow::raiseWindow()
{ return raiseWindow(this); }
//----------------------------------------------------------------------
inline bool FWindow::lowerWindow()
{ return lowerWindow(this); }
2015-05-23 13:35:12 +02:00
#endif // FWINDOW_H