636e3e2278
apps/graphics/twm4nx: Revise logic to detect clicks on the background image. The original implementation had some side effects.
apps/graphics/twm4nx: Remove some remaining, unused stuff from TWM that was never used. Menus need to close after the 'terminal' selection is made. Otherwise, the menu can become buried under a newly open menu and not easily recovered.
apps/graphics/twm4ndx: Add a 'critical' bit to the eventID. While resizing, all events will be ignore except those marked critical.
apps/graphics/twm4nx: CBackground now brings up the main menu if the background image is click. This makes the behavior the same across all of the background except when an icon is clicked.
359 lines
11 KiB
C++
359 lines
11 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// apps/include/graphics/twm4nx/Cmenus.hxx
|
|
// Twm4Nx menus definitions
|
|
//
|
|
// Copyright (C) 2019 Gregory Nutt. All rights reserved.
|
|
// Author: Gregory Nutt <gnutt@nuttx.org>
|
|
//
|
|
// Largely an original work but derives from TWM 1.0.10 in many ways:
|
|
//
|
|
// Copyright 1989,1998 The Open Group
|
|
// Copyright 1988 by Evans & Sutherland Computer Corporation,
|
|
//
|
|
// Please refer to apps/twm4nx/COPYING for detailed copyright information.
|
|
// Although not listed as a copyright holder, thanks and recognition need
|
|
// to go to Tom LaStrange, the original author of TWM.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions
|
|
// are met:
|
|
//
|
|
// 1. Redistributions of source code must retain the above copyright
|
|
// notice, this list of conditions and the following disclaimer.
|
|
// 2. Redistributions in binary form must reproduce the above copyright
|
|
// notice, this list of conditions and the following disclaimer in
|
|
// the documentation and/or other materials provided with the
|
|
// distribution.
|
|
// 3. Neither the name NuttX nor the names of its contributors may be
|
|
// used to endorse or promote products derived from this software
|
|
// without specific prior written permission.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
// COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
|
// OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
|
// AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
// ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
// POSSIBILITY OF SUCH DAMAGE.
|
|
//
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef __APPS_INCLUDE_GRAPHICS_TWM4NX_CMENUS_HXX
|
|
#define __APPS_INCLUDE_GRAPHICS_TWM4NX_CMENUS_HXX
|
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
// Included Files
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#include <mqueue.h>
|
|
|
|
#include "graphics/nxwidgets/cwidgeteventhandler.hxx"
|
|
#include "graphics/nxwidgets/cwidgeteventargs.hxx"
|
|
#include "graphics/nxwidgets/cnxtkwindow.hxx"
|
|
|
|
#include "graphics/twm4nx/cwindow.hxx"
|
|
#include "graphics/twm4nx/ctwm4nxevent.hxx"
|
|
#include "graphics/twm4nx/iapplication.hxx"
|
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
// Pre-processor Definitions
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#define TWM_WINDOWS "TwmNxWindows" // for f.menu "TwmNxWindows"
|
|
|
|
#define SIZE_HINDENT 10
|
|
#define SIZE_VINDENT 2
|
|
|
|
#define MAXMENUDEPTH 10 // max number of nested menus
|
|
|
|
#define MOVE_NONE 0 // modes of constrained move
|
|
#define MOVE_VERT 1
|
|
#define MOVE_HORIZ 2
|
|
|
|
#define SHADOWWIDTH 5 // in pixels
|
|
|
|
// Info stings defines
|
|
|
|
#define INFO_LINES 30
|
|
#define INFO_SIZE 200
|
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
// Implementation Classes
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
namespace NXWidgets
|
|
{
|
|
class CButtonArray; // Forward reference
|
|
class CWidgetEventArgs; // Forward reference
|
|
class CWidgetEventArgs; // Forward reference
|
|
}
|
|
|
|
namespace Twm4Nx
|
|
{
|
|
struct SEventMsg; // Forward referernce
|
|
class CMenus; // Forward reference
|
|
|
|
struct SMenuItem
|
|
{
|
|
FAR struct SMenuItem *flink; /**< Forward link to next menu item */
|
|
FAR struct SMenuItem *blink; /**< Backward link previous menu item */
|
|
FAR NXWidgets::CNxString text; /**< The text string for the menu item */
|
|
FAR CMenus *subMenu; /**< Menu root of a pull right menu */
|
|
FAR CTwm4NxEvent *handler; /**< Application event handler */
|
|
uint16_t event; /**< Menu selection event */
|
|
};
|
|
|
|
class CMenus : protected NXWidgets::CWidgetEventHandler, public CTwm4NxEvent
|
|
{
|
|
private:
|
|
|
|
CTwm4Nx *m_twm4nx; /**< Cached Twm4Nx session */
|
|
mqd_t m_eventq; /**< NxWidget event message queue */
|
|
FAR CWindow *m_menuWindow; /**< The menu window */
|
|
FAR NXWidgets::CButtonArray *m_buttons; /**< The menu button array */
|
|
FAR struct SMenuItem *m_menuHead; /**< First item in menu */
|
|
FAR struct SMenuItem *m_menuTail; /**< Last item in menu */
|
|
NXWidgets::CNxString m_menuName; /**< The name of the menu */
|
|
nxgl_coord_t m_entryHeight; /**< Menu entry height */
|
|
uint16_t m_nMenuItems; /**< Number of items in the menu */
|
|
uint8_t m_nrows; /**< Number of rows in the button array */
|
|
char m_info[INFO_LINES][INFO_SIZE];
|
|
|
|
/**
|
|
* Convert the position of a menu window to the position of
|
|
* the containing frame.
|
|
*/
|
|
|
|
void menuToFramePos(FAR const struct nxgl_point_s *menupos,
|
|
FAR struct nxgl_point_s *framepos);
|
|
|
|
/**
|
|
* Convert the position of the containing frame to the position of
|
|
* the menu window.
|
|
*/
|
|
|
|
void frameToMenuPos(FAR const struct nxgl_point_s *framepos,
|
|
FAR struct nxgl_point_s *menupos);
|
|
|
|
/**
|
|
* Convert the size of a menu window to the size of the containing
|
|
* frame.
|
|
*/
|
|
|
|
void menuToFrameSize(FAR const struct nxgl_size_s *menusize,
|
|
FAR struct nxgl_size_s *framesize);
|
|
|
|
/**
|
|
* Convert the size of a containing frame to the size of the menu
|
|
* window.
|
|
*/
|
|
|
|
void frameToMenuSize(FAR const struct nxgl_size_s *framesize,
|
|
FAR struct nxgl_size_s *menusize);
|
|
|
|
/**
|
|
* Create the menu window. Menu windows are always created in the
|
|
* hidden state. When the menu is selected, then it should be shown.
|
|
*
|
|
* @result True is returned on success
|
|
*/
|
|
|
|
bool createMenuWindow(void);
|
|
|
|
/**
|
|
* Calculate the optimal menu frame size
|
|
*
|
|
* @param frameSize The location to return the calculated frame size
|
|
*/
|
|
|
|
void getMenuFrameSize(FAR struct nxgl_size_s &frameSize);
|
|
|
|
/**
|
|
* Calculate the optimal menu window size
|
|
*
|
|
* @param size The location to return the calculated window size
|
|
*/
|
|
|
|
void getMenuWindowSize(FAR struct nxgl_size_s &size);
|
|
|
|
/**
|
|
* Update the menu window size
|
|
*
|
|
* @result True is returned on success
|
|
*/
|
|
|
|
bool setMenuWindowSize(void);
|
|
|
|
/**
|
|
* Set the position of the menu window. Supports positioning of a
|
|
* pop-up window.
|
|
*
|
|
* @param framePos The position of the menu window frame
|
|
* @result True is returned on success
|
|
*/
|
|
|
|
bool setMenuWindowPosition(FAR struct nxgl_point_s *framePos);
|
|
|
|
/**
|
|
* Set the position of the menu window. Supports presentation of a
|
|
* pop-up window.
|
|
*
|
|
* @param framePos The position of the menu window frame
|
|
* @result True is returned on success
|
|
*/
|
|
|
|
inline bool raiseMenuWindow()
|
|
{
|
|
return m_menuWindow->raiseWindow();
|
|
}
|
|
|
|
/**
|
|
* Create the menu button array
|
|
*
|
|
* @result True is returned on success
|
|
*/
|
|
|
|
bool createMenuButtonArray(void);
|
|
|
|
void paintMenu(void);
|
|
void destroyMenu(void);
|
|
|
|
/**
|
|
* Handle a widget action event, overriding the CWidgetEventHandler
|
|
* method. This will indicate a button pre-release event.
|
|
*
|
|
* @param e The event data.
|
|
*/
|
|
|
|
void handleActionEvent(const NXWidgets::CWidgetEventArgs &e);
|
|
|
|
/**
|
|
* Cleanup or initialization error or on deconstruction.
|
|
*/
|
|
|
|
void cleanup(void);
|
|
|
|
public:
|
|
/**
|
|
* CMenus Constructor
|
|
*
|
|
* @param twm4nx. Twm4Nx session
|
|
*/
|
|
|
|
CMenus(CTwm4Nx *twm4nx);
|
|
|
|
/**
|
|
* CMenus Destructor
|
|
*/
|
|
|
|
~CMenus(void);
|
|
|
|
/**
|
|
* CMenus Initializer. Performs the parts of the CMenus construction
|
|
* that may fail. The menu window is created but is not initially
|
|
* visible. Use the show() method to make the menu visible.
|
|
*
|
|
* @param name The menu name
|
|
* @result True is returned on success
|
|
*/
|
|
|
|
bool initialize(FAR NXWidgets::CNxString &name);
|
|
|
|
/**
|
|
* Add an item to a menu
|
|
*
|
|
* @param item Describes the menu item entry
|
|
* @return True if the menu item was added successfully
|
|
*/
|
|
|
|
bool addMenuItem(FAR IApplication *item);
|
|
|
|
/**
|
|
* Return the size of the menu window frame
|
|
*
|
|
* @param frameSize The location in which to return the current menu
|
|
* window frame size.
|
|
* @result True is returned on success
|
|
*/
|
|
|
|
bool getFrameSize(FAR struct nxgl_size_s *frameSize)
|
|
{
|
|
return m_menuWindow->getFrameSize(frameSize);
|
|
}
|
|
|
|
/**
|
|
* Set the position of the menu window frame
|
|
*
|
|
* @param framePos The new menum window frame position
|
|
* @result True is returned on success
|
|
*/
|
|
|
|
bool getFramePosition(FAR struct nxgl_point_s *framePos)
|
|
{
|
|
return m_menuWindow->getFramePosition(framePos);
|
|
}
|
|
|
|
/**
|
|
* Set the position of the menu window frame
|
|
*
|
|
* @param framePos The new menum window frame position
|
|
* @result True is returned on success
|
|
*/
|
|
|
|
bool setFramePosition(FAR const struct nxgl_point_s *framePos)
|
|
{
|
|
return m_menuWindow->setFramePosition(framePos);
|
|
}
|
|
|
|
/**
|
|
* Return true if the menu is currently being displayed
|
|
*
|
|
* @return True if the menu is visible
|
|
*/
|
|
|
|
inline bool isVisible(void)
|
|
{
|
|
return !m_menuWindow->isIconified();
|
|
}
|
|
|
|
/**
|
|
* Make the menu visible.
|
|
*
|
|
* @return True if the menu is shown.
|
|
*/
|
|
|
|
inline bool show(void)
|
|
{
|
|
return m_menuWindow->deIconify();
|
|
}
|
|
|
|
/**
|
|
* Hide the menu
|
|
*
|
|
* @return True if the menu was hidden.
|
|
*/
|
|
|
|
inline bool hide(void)
|
|
{
|
|
return m_menuWindow->iconify();
|
|
}
|
|
|
|
/**
|
|
* Handle MENU events.
|
|
*
|
|
* @param msg. The received NxWidget MENU event message.
|
|
* @return True if the message was properly handled. false is
|
|
* return on any failure.
|
|
*/
|
|
|
|
bool event(FAR struct SEventMsg *msg);
|
|
};
|
|
}
|
|
|
|
#endif // __APPS_INCLUDE_GRAPHICS_TWM4NX_CMENUS_HXX
|