FXTopWindow.h

/********************************************************************************
*                                                                               *
*                 T o p - L e v e l   W i n d o w   W i d g e t                 *
*                                                                               *
*********************************************************************************
* Copyright (C) 1998,2024 by Jeroen van der Zijp.   All Rights Reserved.        *
*********************************************************************************
* This library 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.                                           *
*                                                                               *
* This library 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/>          *
********************************************************************************/
#ifndef FXTOPWINDOW_H
#define FXTOPWINDOW_H

#ifndef FXSHELL_H
#include "FXShell.h"
#endif

namespace FX {


enum {
  DECOR_NONE        = 0,                                  
  DECOR_TITLE       = 0x00020000,                         
  DECOR_MINIMIZE    = 0x00040000,                         
  DECOR_MAXIMIZE    = 0x00080000,                         
  DECOR_CLOSE       = 0x00100000,                         
  DECOR_BORDER      = 0x00200000,                         
  DECOR_SHRINKABLE  = 0x00400000,                         
  DECOR_STRETCHABLE = 0x00800000,                         
  DECOR_RESIZE      = DECOR_SHRINKABLE|DECOR_STRETCHABLE, 
  DECOR_MENU        = 0x01000000,                         
  DECOR_ALL         = (DECOR_TITLE|DECOR_MINIMIZE|DECOR_MAXIMIZE|DECOR_CLOSE|DECOR_BORDER|DECOR_SHRINKABLE|DECOR_STRETCHABLE|DECOR_MENU)
  };


enum {
  PLACEMENT_DEFAULT,            
  PLACEMENT_VISIBLE,            
  PLACEMENT_CURSOR,             
  PLACEMENT_OWNER,              
  PLACEMENT_SCREEN,             
  PLACEMENT_MAXIMIZED           
  };


enum {
  STACK_NORMAL,                 
  STACK_BOTTOM,                 
  STACK_TOP                     
  };


class FXToolBar;
class FXIcon;


class FXAPI FXTopWindow : public FXShell {
  FXDECLARE_ABSTRACT(FXTopWindow)
protected:
  FXString  title;                    // Window title
  FXIcon   *icon;                     // Window icon (big)
  FXIcon   *miniIcon;                 // Window icon (small)
  FXint     padtop;                   // Top margin
  FXint     padbottom;                // Bottom margin
  FXint     padleft;                  // Left margin
  FXint     padright;                 // Right margin
  FXint     hspacing;                 // Horizontal child spacing
  FXint     vspacing;                 // Vertical child spacing
protected:
  FXTopWindow();
  void settitle();
  void seticons();
  void setdecorations();
  FXTopWindow(FXApp* ap,const FXString& name,FXIcon *ic,FXIcon *mi,FXuint opts,FXint x,FXint y,FXint w,FXint h,FXint pl,FXint pr,FXint pt,FXint pb,FXint hs,FXint vs);
  FXTopWindow(FXWindow* ow,const FXString& name,FXIcon *ic,FXIcon *mi,FXuint opts,FXint x,FXint y,FXint w,FXint h,FXint pl,FXint pr,FXint pt,FXint pb,FXint hs,FXint vs);
private:
  FXTopWindow(const FXTopWindow&);
  FXTopWindow& operator=(const FXTopWindow&);
#ifdef WIN32
  virtual const void* GetClass() const;
#endif
public:
  long onFocusUp(FXObject*,FXSelector,void*);
  long onFocusDown(FXObject*,FXSelector,void*);
  long onFocusLeft(FXObject*,FXSelector,void*);
  long onFocusRight(FXObject*,FXSelector,void*);
  long onSessionNotify(FXObject*,FXSelector,void*);
  long onSessionClosed(FXObject*,FXSelector,void*);
  long onRestore(FXObject*,FXSelector,void*);
  long onMaximize(FXObject*,FXSelector,void*);
  long onMinimize(FXObject*,FXSelector,void*);
  long onCmdRestore(FXObject*,FXSelector,void*);
  long onCmdMaximize(FXObject*,FXSelector,void*);
  long onCmdMinimize(FXObject*,FXSelector,void*);
  long onCmdFullScreen(FXObject*,FXSelector,void*);
  long onCmdClose(FXObject*,FXSelector,void*);
  long onCmdSetStringValue(FXObject*,FXSelector,void*);
  long onCmdGetStringValue(FXObject*,FXSelector,void*);
  long onCmdSetIconValue(FXObject*,FXSelector,void*);
  long onCmdGetIconValue(FXObject*,FXSelector,void*);
public:
  enum {
    ID_RESTORE=FXShell::ID_LAST,        
    ID_MAXIMIZE,                        
    ID_MINIMIZE,                        
    ID_FULLSCREEN,                      
    ID_CLOSE,                           
    ID_QUERY_DOCK,                      
    ID_LAST
    };
public:

  virtual void create();

  virtual void detach();

  virtual void destroy();

  virtual void layout();

  virtual void setFocus();

  virtual void killFocus();

  virtual void show();

  virtual void hide();

  virtual void show(FXuint placement);

  void place(FXuint placement);

  virtual FXint getDefaultWidth();

  virtual FXint getDefaultHeight();

  FXbool getWMBorders(FXint& left,FXint& right,FXint& top,FXint& bottom);

  virtual void raise();

  virtual void lower();

  virtual void move(FXint x,FXint y);

  virtual void resize(FXint w,FXint h);

  virtual void position(FXint x,FXint y,FXint w,FXint h);

  virtual void flash(FXbool yes);

  virtual FXbool restore(FXbool notify=false);

  virtual FXbool maximize(FXbool notify=false);

  virtual FXbool minimize(FXbool notify=false);

  virtual FXbool fullScreen(FXbool notify=false);

  virtual FXbool stackingOrder(FXuint order);

  virtual FXbool close(FXbool notify=false);

  FXbool isMaximized() const;

  FXbool isMinimized() const;

  FXbool isFullScreen() const;

  void setTitle(const FXString& name);

  FXString getTitle() const { return title; }

  void setPadTop(FXint pt);

  FXint getPadTop() const { return padtop; }

  void setPadBottom(FXint pb);

  FXint getPadBottom() const { return padbottom; }

  void setPadLeft(FXint pl);

  FXint getPadLeft() const { return padleft; }

  void setPadRight(FXint pr);

  FXint getPadRight() const { return padright; }

  FXint getHSpacing() const { return hspacing; }

  FXint getVSpacing() const { return vspacing; }

  void setHSpacing(FXint hs);

  void setVSpacing(FXint vs);

  void setPackingHints(FXuint ph);

  FXuint getPackingHints() const;

  void setDecorations(FXuint decorations);

  FXuint getDecorations() const;

  FXIcon* getIcon() const { return icon; }

  void setIcon(FXIcon* ic);

  FXIcon* getMiniIcon() const { return miniIcon; }

  void setMiniIcon(FXIcon *ic);

  virtual void save(FXStream& store) const;

  virtual void load(FXStream& store);

  virtual ~FXTopWindow();
  };

}

#endif