FXAccelTable.h

/********************************************************************************
*                                                                               *
*                   A c c e l e r a t o r   T a b l e   C l a s s               *
*                                                                               *
*********************************************************************************
* 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 FXACCELTABLE_H
#define FXACCELTABLE_H

#ifndef FXOBJECT_H
#include "FXObject.h"
#endif

namespace FX {


class FXAPI FXAccelTable : public FXObject {
  FXDECLARE(FXAccelTable)
protected:
  struct FXAccelKey {
    FXObject    *target;    // Target object of message
    FXSelector   messagedn; // Message being sent
    FXSelector   messageup; // Message being sent
    FXHotKey     code;      // Keysym and modifier mask to match
    };
private:
  FXAccelKey *key;          // Accelerator table
  FXuint      max;          // Largest table index
  FXuint      num;          // Number of entries
private:
  void resize(FXuint m);
private:
  FXAccelTable(const FXAccelTable&);
  FXAccelTable &operator=(const FXAccelTable&);
public:
  long onKeyPress(FXObject*,FXSelector,void*);
  long onKeyRelease(FXObject*,FXSelector,void*);
public:

  FXAccelTable();

  void addAccel(FXHotKey hotkey,FXObject* target=nullptr,FXSelector seldn=0,FXSelector selup=0);

  void addAccel(const FXchar* string,FXObject* target=nullptr,FXSelector seldn=0,FXSelector selup=0);
  void addAccel(const FXString& string,FXObject* target=nullptr,FXSelector seldn=0,FXSelector selup=0);

  void removeAccel(FXHotKey hotkey);

  void removeAccel(const FXchar* string);
  void removeAccel(const FXString& string);

  FXbool hasAccel(FXHotKey hotkey) const;

  FXbool hasAccel(const FXchar* string) const;
  FXbool hasAccel(const FXString& string) const;

  FXObject* targetOfAccel(FXHotKey hotkey) const;

  FXObject* targetOfAccel(const FXchar* string) const;
  FXObject* targetOfAccel(const FXString& string) const;

  static FXHotKey parseAccel(const FXchar* string);
  static FXHotKey parseAccel(const FXString& string);

  static FXString unparseAccel(FXHotKey key);

  virtual void save(FXStream& store) const;

  virtual void load(FXStream& store);

  virtual ~FXAccelTable();
  };


extern FXAPI FXHotKey parseHotKey(const FXString& string);

extern FXAPI FXint findHotKey(const FXString& string);

extern FXAPI FXString stripHotKey(const FXString& string);

}

#endif