FXWindow.h

/********************************************************************************
*                                                                               *
*                            W i n d o w   O b j e c t                          *
*                                                                               *
*********************************************************************************
* Copyright (C) 1997,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 FXWINDOW_H
#define FXWINDOW_H

#ifndef FXDRAWABLE_H
#include "FXDrawable.h"
#endif

namespace FX {


// Forward declarations
class FXIcon;
class FXBitmap;
class FXCursor;
class FXRegion;
class FXDCWindow;
class FXComposite;
class FXAccelTable;
class FXComposeContext;


enum {
  LAYOUT_NORMAL      = 0,                                   
  LAYOUT_SIDE_TOP    = 0,                                   
  LAYOUT_SIDE_BOTTOM = 0x00000001,                          
  LAYOUT_SIDE_LEFT   = 0x00000002,                          
  LAYOUT_SIDE_RIGHT  = LAYOUT_SIDE_LEFT|LAYOUT_SIDE_BOTTOM, 
  LAYOUT_FILL_COLUMN = 0x00000001,                          
  LAYOUT_FILL_ROW    = 0x00000002,                          
  LAYOUT_LEFT        = 0,                                   
  LAYOUT_RIGHT       = 0x00000004,                          
  LAYOUT_CENTER_X    = 0x00000008,                          
  LAYOUT_FIX_X       = LAYOUT_RIGHT|LAYOUT_CENTER_X,        
  LAYOUT_TOP         = 0,                                   
  LAYOUT_BOTTOM      = 0x00000010,                          
  LAYOUT_CENTER_Y    = 0x00000020,                          
  LAYOUT_FIX_Y       = LAYOUT_BOTTOM|LAYOUT_CENTER_Y,       
  LAYOUT_DOCK_SAME   = 0,                                   
  LAYOUT_DOCK_NEXT   = 0x00000040,                          
  LAYOUT_RESERVED_1  = 0x00000080,
  LAYOUT_FIX_WIDTH   = 0x00000100,                          
  LAYOUT_FIX_HEIGHT  = 0x00000200,                          
  LAYOUT_MIN_WIDTH   = 0,                                   
  LAYOUT_MIN_HEIGHT  = 0,                                   
  LAYOUT_FILL_X      = 0x00000400,                          
  LAYOUT_FILL_Y      = 0x00000800,                          
  LAYOUT_FILL        = LAYOUT_FILL_X|LAYOUT_FILL_Y,         
  LAYOUT_EXPLICIT    = LAYOUT_FIX_X|LAYOUT_FIX_Y|LAYOUT_FIX_WIDTH|LAYOUT_FIX_HEIGHT   
  };


enum {
  FRAME_NONE   = 0,                                     
  FRAME_SUNKEN = 0x00001000,                            
  FRAME_RAISED = 0x00002000,                            
  FRAME_THICK  = 0x00004000,                            
  FRAME_GROOVE = FRAME_THICK,                           
  FRAME_RIDGE  = FRAME_THICK|FRAME_RAISED|FRAME_SUNKEN, 
  FRAME_LINE   = FRAME_RAISED|FRAME_SUNKEN,             
  FRAME_NORMAL = FRAME_SUNKEN|FRAME_THICK               
  };


enum {
  PACK_NORMAL         = 0,              
  PACK_UNIFORM_HEIGHT = 0x00008000,     
  PACK_UNIFORM_WIDTH  = 0x00010000      
  };


enum FXDNDOrigin {
  FROM_SELECTION  = 0,              
  FROM_CLIPBOARD  = 1,              
  FROM_DRAGNDROP  = 2               
  };


enum FXDragAction {
  DRAG_REJECT  = 0,             
  DRAG_ASK     = 1,             
  DRAG_COPY    = 2,             
  DRAG_MOVE    = 3,             
  DRAG_LINK    = 4,             
  DRAG_PRIVATE = 5,             
  DRAG_ACCEPT  = 6              
  };


class FXAPI FXWindow : public FXDrawable {
  FXDECLARE(FXWindow)
  friend class FXApp;
private:
  FXWindow         *parent;             // Parent Window
  FXWindow         *owner;              // Owner Window
  FXWindow         *first;              // First Child
  FXWindow         *last;               // Last Child
  FXWindow         *next;               // Next Sibling
  FXWindow         *prev;               // Previous Sibling
  FXWindow         *focus;              // Focus Child
  FXuint            wk;                 // Window Key
protected:
  FXComposeContext *composeContext;     // Compose context
  FXCursor         *defaultCursor;      // Normal Cursor
  FXCursor         *dragCursor;         // Cursor during drag
  FXAccelTable     *accelTable;         // Accelerator table
  FXObject         *target;             // Target object
  FXSelector        message;            // Message ID
  FXint             xpos;               // Window X Position
  FXint             ypos;               // Window Y Position
  FXColor           backColor;          // Window background color
  FXString          tag;                // Help tag
  FXuint            flags;              // Window state flags
  FXuint            options;            // Window options
public:
  static FXDragType       octetType;    // Raw octet stream
  static FXDragType       deleteType;   // Delete request
  static FXDragType       textType;     // Ascii text request
  static FXDragType       colorType;    // Color request
  static FXDragType       urilistType;  // URI list request
  static FXDragType       utf8Type;     // UTF-8 text request
  static FXDragType       utf16Type;    // UTF-16 text request
  static FXDragType       actionType;   // Clipboard action
  static const FXDragType stringType;   // Clipboard text type (pre-registered)
  static const FXDragType imageType;    // Clipboard image type (pre-registered)
protected:
  virtual FXbool doesOverrideRedirect() const;
protected:
#ifdef WIN32
  virtual FXID GetDC() const;
  virtual int ReleaseDC(FXID) const;
  virtual const void* GetClass() const;
#else
  void addColormapWindows();
  void remColormapWindows();
#endif
protected:
  FXWindow();
  FXWindow(FXApp* a,FXVisual *vis);
  FXWindow(FXApp* a,FXWindow* own,FXuint opts,FXint x,FXint y,FXint w,FXint h);
private:
  FXWindow(const FXWindow&);
  FXWindow& operator=(const FXWindow&);
protected:

  // Window state flags
  enum {
    FLAG_SHOWN        = 0x00000001,     // Is shown
    FLAG_ENABLED      = 0x00000002,     // Able to receive input
    FLAG_UPDATE       = 0x00000004,     // Is subject to GUI update
    FLAG_DROPTARGET   = 0x00000008,     // Drop target
    FLAG_FOCUSED      = 0x00000010,     // Has focus
    FLAG_DIRTY        = 0x00000020,     // Needs layout
    FLAG_RECALC       = 0x00000040,     // Needs recalculation
    FLAG_TIP          = 0x00000080,     // Show tip
    FLAG_HELP         = 0x00000100,     // Show help
    FLAG_DEFAULT      = 0x00000200,     // Default widget
    FLAG_INITIAL      = 0x00000400,     // Initial widget
    FLAG_SHELL        = 0x00000800,     // Shell window
    FLAG_ACTIVE       = 0x00001000,     // Window is active
    FLAG_PRESSED      = 0x00002000,     // Button has been pressed
    FLAG_KEY          = 0x00004000,     // Keyboard key pressed
    FLAG_CARET        = 0x00008000,     // Caret is on
    FLAG_CHANGED      = 0x00010000,     // Window data changed
    FLAG_LASSO        = 0x00020000,     // Lasso mode
    FLAG_TRYDRAG      = 0x00040000,     // Tentative drag mode
    FLAG_DODRAG       = 0x00080000,     // Doing drag mode
    FLAG_SCROLLINSIDE = 0x00100000,     // Scroll only when inside
    FLAG_SCROLLING    = 0x00200000,     // Right mouse scrolling
    FLAG_OWNED        = 0x00400000,     // Owned window handle
    FLAG_CURSOR       = 0x00800000      // Showing cursor
    };

public:

  enum WindowClass {
    ClassNormal,        
    ClassGraphic,       
    ClassSpecial,       
    ClassRoot,          
    ClassShell,         
    ClassPopup,         
    ClassToolTip,       
    ClassMain,          
    ClassDialog,        
    ClassToolBar,       
    ClassSplash,        
    ClassNotify,        
    ClassPanel,         
    ClassDesktop        
    };

public:
  long onPaint(FXObject*,FXSelector,void*);
  long onMap(FXObject*,FXSelector,void*);
  long onUnmap(FXObject*,FXSelector,void*);
  long onConfigure(FXObject*,FXSelector,void*);
  long onUpdate(FXObject*,FXSelector,void*);
  long onMotion(FXObject*,FXSelector,void*);
  long onMouseWheel(FXObject*,FXSelector,void*);
  long onEnter(FXObject*,FXSelector,void*);
  long onLeave(FXObject*,FXSelector,void*);
  long onLeftBtnPress(FXObject*,FXSelector,void*);
  long onLeftBtnRelease(FXObject*,FXSelector,void*);
  long onMiddleBtnPress(FXObject*,FXSelector,void*);
  long onMiddleBtnRelease(FXObject*,FXSelector,void*);
  long onRightBtnPress(FXObject*,FXSelector,void*);
  long onRightBtnRelease(FXObject*,FXSelector,void*);
  long onSpaceBallMotion(FXObject*,FXSelector,void*);
  long onSpaceBallButtonPress(FXObject*,FXSelector,void*);
  long onSpaceBallButtonRelease(FXObject*,FXSelector,void*);
  long onBeginDrag(FXObject*,FXSelector,void*);
  long onEndDrag(FXObject*,FXSelector,void*);
  long onDragged(FXObject*,FXSelector,void*);
  long onKeyPress(FXObject*,FXSelector,void*);
  long onKeyRelease(FXObject*,FXSelector,void*);
  long onUngrabbed(FXObject*,FXSelector,void*);
  long onDestroy(FXObject*,FXSelector,void*);
  long onFocusSelf(FXObject*,FXSelector,void*);
  long onFocusIn(FXObject*,FXSelector,void*);
  long onFocusOut(FXObject*,FXSelector,void*);
  long onSelectionLost(FXObject*,FXSelector,void*);
  long onSelectionGained(FXObject*,FXSelector,void*);
  long onSelectionRequest(FXObject*,FXSelector,void*);
  long onClipboardLost(FXObject*,FXSelector,void*);
  long onClipboardGained(FXObject*,FXSelector,void*);
  long onClipboardRequest(FXObject*,FXSelector,void*);
  long onDNDEnter(FXObject*,FXSelector,void*);
  long onDNDLeave(FXObject*,FXSelector,void*);
  long onDNDMotion(FXObject*,FXSelector,void*);
  long onDNDDrop(FXObject*,FXSelector,void*);
  long onDNDRequest(FXObject*,FXSelector,void*);
  long onQueryHelp(FXObject*,FXSelector,void*);
  long onQueryTip(FXObject*,FXSelector,void*);
  long onCmdShow(FXObject*,FXSelector,void*);
  long onCmdHide(FXObject*,FXSelector,void*);
  long onUpdToggleShown(FXObject*,FXSelector,void*);
  long onCmdToggleShown(FXObject*,FXSelector,void*);
  long onCmdRaise(FXObject*,FXSelector,void*);
  long onCmdLower(FXObject*,FXSelector,void*);
  long onCmdEnable(FXObject*,FXSelector,void*);
  long onCmdDisable(FXObject*,FXSelector,void*);
  long onUpdToggleEnabled(FXObject*,FXSelector,void*);
  long onCmdToggleEnabled(FXObject*,FXSelector,void*);
  long onCmdUpdate(FXObject*,FXSelector,void*);
  long onUpdYes(FXObject*,FXSelector,void*);
  long onCmdDelete(FXObject*,FXSelector,void*);
public:
  enum {
    ID_NONE,
    ID_HIDE,
    ID_SHOW,
    ID_TOGGLESHOWN,
    ID_LOWER,
    ID_RAISE,
    ID_DELETE,
    ID_DISABLE,
    ID_ENABLE,
    ID_TOGGLEENABLED,
    ID_UNCHECK,
    ID_CHECK,
    ID_UNKNOWN,
    ID_UPDATE,
    ID_TIPTIMER,
    ID_SETVALUE,
    ID_SETINTVALUE,
    ID_SETLONGVALUE,
    ID_SETREALVALUE,
    ID_SETSTRINGVALUE,
    ID_SETICONVALUE,
    ID_SETINTRANGE,
    ID_SETREALRANGE,
    ID_GETINTVALUE,
    ID_GETLONGVALUE,
    ID_GETREALVALUE,
    ID_GETSTRINGVALUE,
    ID_GETICONVALUE,
    ID_GETINTRANGE,
    ID_GETREALRANGE,
    ID_SETHELPSTRING,
    ID_GETHELPSTRING,
    ID_SETTIPSTRING,
    ID_GETTIPSTRING,
    ID_QUERY_MENU,
    ID_HOTKEY,
    ID_ACCEL,
    ID_UNPOST,
    ID_POST,
    ID_MDI_TILEHORIZONTAL,
    ID_MDI_TILEVERTICAL,
    ID_MDI_CASCADE,
    ID_MDI_MAXIMIZE,
    ID_MDI_MINIMIZE,
    ID_MDI_RESTORE,
    ID_MDI_CLOSE,
    ID_MDI_WINDOW,
    ID_MDI_MENUWINDOW,
    ID_MDI_MENUMINIMIZE,
    ID_MDI_MENURESTORE,
    ID_MDI_MENUCLOSE,
    ID_MDI_NEXT,
    ID_MDI_PREV,
    ID_LAST
    };
public:

  // Predefined DND type names
  static const FXchar octetTypeName[];
  static const FXchar deleteTypeName[];
  static const FXchar textTypeName[];
  static const FXchar colorTypeName[];
  static const FXchar urilistTypeName[];
  static const FXchar utf8TypeName[];
  static const FXchar utf16TypeName[];
  static const FXchar actionTypeName[];

public:

  FXWindow(FXComposite* p,FXuint opts=0,FXint x=0,FXint y=0,FXint w=0,FXint h=0);

  FXWindow* getParent() const { return parent; }

  FXWindow* getOwner() const { return owner; }

  FXWindow* getNext() const { return next; }

  FXWindow* getPrev() const { return prev; }

  FXWindow* getFirst() const { return first; }

  FXWindow* getLast() const { return last; }

  FXWindow* getFocus() const { return focus; }

  FXWindow* getShell() const;

  FXWindow* getRoot() const;

  virtual WindowClass getWindowClass() const;

  void setKey(FXuint k){ wk=k; }

  FXuint getKey() const { return wk; }

  FXWindow* getChildWithKey(FXuint k) const;

  void setTarget(FXObject *t){ target=t; }

  FXObject* getTarget() const { return target; }

  void setSelector(FXSelector sel){ message=sel; }

  FXSelector getSelector() const { return message; }

  FXint getX() const { return xpos; }

  FXint getY() const { return ypos; }

  virtual FXint getDefaultWidth();

  virtual FXint getDefaultHeight();

  virtual FXint getWidthForHeight(FXint givenheight);

  virtual FXint getHeightForWidth(FXint givenwidth);

  void setX(FXint x);

  void setY(FXint y);

  void setWidth(FXint w);

  void setHeight(FXint h);

  void setLayoutHints(FXuint lout);

  FXuint getLayoutHints() const;

  FXAccelTable* getAccelTable() const { return accelTable; }

  void setAccelTable(FXAccelTable* acceltable){ accelTable=acceltable; }

  void addHotKey(FXHotKey code);

  void remHotKey(FXHotKey code);

  void setHelpTag(const FXString&  text){ tag=text; }

  const FXString& getHelpTag() const { return tag; }

  FXbool isShell() const;

  FXbool isOwnerOf(const FXWindow* window) const;

  FXbool isChildOf(const FXWindow* window) const;

  FXbool containsChild(const FXWindow* child) const;

  FXWindow* getChildAt(FXint x,FXint y) const;

  FXint numChildren() const;

  FXint indexOfChild(const FXWindow *window) const;

  FXWindow* childAtIndex(FXint index) const;

  static FXWindow* commonAncestor(FXWindow* a,FXWindow* b);

  static FXbool before(const FXWindow *a,const FXWindow* b);

  static FXbool after(const FXWindow *a,const FXWindow* b);

  FXComposeContext* getComposeContext() const { return composeContext; }

  void createComposeContext();

  void destroyComposeContext();

  FXbool cursorShown() const;

  void showCursor(FXbool flag=true);

  void setDefaultCursor(FXCursor* cur);

  FXCursor* getDefaultCursor() const { return defaultCursor; }

  void setDragCursor(FXCursor* cur);

  FXCursor* getDragCursor() const { return dragCursor; }

  FXbool getCursorPosition(FXint& x,FXint& y,FXuint& buttons) const;

  FXbool setCursorPosition(FXint x,FXint y);

  FXbool isActive() const;

  virtual FXbool canFocus() const;

  FXbool hasFocus() const;

  FXbool inFocusChain() const;

  virtual void setFocus();

  virtual void killFocus();

  FXbool isDefault() const;

  virtual void setDefault(FXuchar flag=true);

  FXWindow* findDefault() const;

  FXbool isInitial() const;

  void setInitial(FXbool flag=true);

  FXWindow* findInitial() const;

  FXbool isEnabled() const;

  virtual void enable();

  virtual void disable();

  virtual void create();

  virtual void attach(FXID w);

  virtual void detach();

  virtual void destroy();

  virtual void setShape(const FXRegion& region);

  virtual void setShape(FXBitmap* bitmap);

  virtual void setShape(FXIcon* icon);

  virtual void clearShape();

  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 recalc();

  virtual void layout();

  void forceRefresh();

  virtual void reparent(FXWindow* father,FXWindow *other=nullptr);

  void scroll(FXint x,FXint y,FXint w,FXint h,FXint dx,FXint dy) const;

  void update(FXint x,FXint y,FXint w,FXint h) const;

  void update() const;

  void repaint(FXint x,FXint y,FXint w,FXint h) const;

  void repaint() const;

  FXbool grabbed() const;

  void grab();

  void ungrab();

  FXbool grabbedKeyboard() const;

  void grabKeyboard();

  void ungrabKeyboard();

  FXbool shown() const;

  virtual void show();

  virtual void hide();

  virtual FXbool isComposite() const;

  FXbool underCursor() const;

  FXbool hasSelection() const;

  FXbool acquireSelection(const FXDragType *types,FXuint numtypes);

  FXbool releaseSelection();

  FXbool hasClipboard() const;

  FXbool acquireClipboard(const FXDragType *types,FXuint numtypes);

  FXbool releaseClipboard();

  FXbool isDropEnabled() const;

  virtual void dropEnable();

  virtual void dropDisable();

  FXbool isDragging() const;

  FXbool beginDrag(const FXDragType *types,FXuint numtypes);

  FXbool handleDrag(FXint x,FXint y,FXDragAction action=DRAG_COPY);

  FXDragAction endDrag(FXbool drop=true);

  FXbool isDropTarget() const;

  void setDragRectangle(FXint x,FXint y,FXint w,FXint h,FXbool wantupdates=true) const;

  void clearDragRectangle() const;

  void acceptDrop(FXDragAction action=DRAG_ACCEPT) const;

  FXDragAction didAccept() const;

  void dropFinished(FXDragAction action=DRAG_REJECT) const;

  FXbool inquireDNDTypes(FXDNDOrigin origin,FXDragType*& types,FXuint& numtypes) const;

  FXbool offeredDNDType(FXDNDOrigin origin,FXDragType type) const;

  FXDragAction inquireDNDAction() const;

  FXbool setDNDData(FXDNDOrigin origin,FXDragType type,FXuchar* data,FXuint size) const;

  FXbool setDNDData(FXDNDOrigin origin,FXDragType type,const FXString& string) const;

  FXbool getDNDData(FXDNDOrigin origin,FXDragType type,FXuchar*& data,FXuint& size) const;

  FXbool getDNDData(FXDNDOrigin origin,FXDragType type,FXString& string) const;

  virtual FXbool contains(FXint parentx,FXint parenty) const;

  void translateCoordinatesFrom(FXint& tox,FXint& toy,const FXWindow* fromwindow,FXint fromx,FXint fromy) const;

  void translateCoordinatesTo(FXint& tox,FXint& toy,const FXWindow* towindow,FXint fromx,FXint fromy) const;

  virtual void setBackColor(FXColor clr);

  FXColor getBackColor() const { return backColor; }

  virtual FXbool doesSaveUnder() const;

  virtual const FXchar* tr(const FXchar* text,const FXchar* hint=nullptr,FXint count=-1) const FX_FORMAT(2) ;

  virtual void save(FXStream& store) const;

  virtual void load(FXStream& store);

  virtual ~FXWindow();
  };

}

#endif