diff options
| author | Yuval Adam <yuv.adm@gmail.com> | 2014-06-29 12:34:32 +0300 |
|---|---|---|
| committer | Yuval Adam <yuv.adm@gmail.com> | 2014-06-29 12:34:32 +0300 |
| commit | c3e4c9a25c2910d2d66d52215b3406b13d5b23d5 (patch) | |
| tree | added370d1e356901f8579f076e3263fb0464db7 /boards/ek-lm4f232/drivers/slidemenuwidget.h | |
| parent | 990090a4cc9070837d31e66b58d40f0c3d038741 (diff) | |
Add more board models
Diffstat (limited to 'boards/ek-lm4f232/drivers/slidemenuwidget.h')
| -rw-r--r-- | boards/ek-lm4f232/drivers/slidemenuwidget.h | 457 |
1 files changed, 457 insertions, 0 deletions
diff --git a/boards/ek-lm4f232/drivers/slidemenuwidget.h b/boards/ek-lm4f232/drivers/slidemenuwidget.h new file mode 100644 index 0000000..c7a1647 --- /dev/null +++ b/boards/ek-lm4f232/drivers/slidemenuwidget.h @@ -0,0 +1,457 @@ +//*****************************************************************************
+//
+// slidemenuwidget.h - Prototypes for a sliding menu widget.
+//
+// Copyright (c) 2011-2014 Texas Instruments Incorporated. All rights reserved.
+// Software License Agreement
+//
+// Texas Instruments (TI) is supplying this software for use solely and
+// exclusively on TI's microcontroller products. The software is owned by
+// TI and/or its suppliers, and is protected under applicable copyright
+// laws. You may not combine this software with "viral" open-source
+// software in order to form a larger program.
+//
+// THIS SOFTWARE IS PROVIDED "AS IS" AND WITH ALL FAULTS.
+// NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT
+// NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. TI SHALL NOT, UNDER ANY
+// CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
+// DAMAGES, FOR ANY REASON WHATSOEVER.
+//
+// This is part of revision 2.1.0.12573 of the EK-LM4F232 Firmware Package.
+//
+//*****************************************************************************
+
+#ifndef __SLIDEMENUWIDGET_H__
+#define __SLIDEMENUWIDGET_H__
+
+//*****************************************************************************
+//
+//! \addtogroup slidemenuwidget_api
+//! @{
+//
+//*****************************************************************************
+
+//*****************************************************************************
+//
+// If building with a C++ compiler, make all of the definitions in this header
+// have a C binding.
+//
+//*****************************************************************************
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+//*****************************************************************************
+//
+//! The structure that describes a menu item in the menu tree.
+//
+//*****************************************************************************
+typedef struct _SlideMenuItem
+{
+ //
+ //! A pointer to text to be rendered within the node.
+ //
+ char *pcText;
+
+ //
+ //! A child menu that is activated by this menu item, if any. Can be NULL.
+ //
+ struct _SlideMenu *psChildMenu;
+
+ //
+ //! A child widget that is activated by this menu item, if any. Can be
+ //! NULL. If both child menu and child widget are specified, the child
+ //! menu will be used.
+ //
+ tWidget *psChildWidget;
+
+ //
+ //! A color that is used when a child widget is activated. This is the
+ //! color that is used as a background when the menu slides off to make
+ //! the screen available for the child widget. By choosing this color to
+ //! match the background that is used in the child widget, the sliding
+ //! animation and widget painting appears smoother.
+ //
+ uint32_t ui32ChildWidgetColor;
+}
+tSlideMenuItem;
+
+//*****************************************************************************
+//
+//! The structure that describes a menu.
+//
+//*****************************************************************************
+typedef struct _SlideMenu
+{
+ //
+ //! The parent menu of this menu.
+ //
+ struct _SlideMenu *psParent;
+
+ //
+ //! The total number of items in this menu.
+ //
+ uint32_t ui32Items;
+
+ //
+ //! A pointer to the array of menu item structures.
+ //
+ tSlideMenuItem *psSlideMenuItems;
+
+ //
+ //! The menu item index of the item shown on the center of the screen.
+ //! Normally this is the same as the menu item that has the focus, but
+ //! can be different during the time when the menu is "sliding". When this
+ //! is 0, the first menu item is shown in the center of the screen and the
+ //! successive items are shown below it. When non-zero, then this menu
+ //! item is shown in the center, with preceding menu items shown above
+ //! and successive items shown below.
+ //
+ uint32_t ui32CenterIndex;
+
+ //
+ //! The menu item index that has the focus.
+ //
+ uint32_t ui32FocusIndex;
+
+ //
+ //! A flag to indicate if more than one menu item is selectable.
+ //
+ bool bMultiSelectable;
+
+ //
+ //! A set of bit flags to indicate which menu items are selected.
+ //
+ uint32_t ui32SelectedFlags;
+} tSlideMenu;
+
+//*****************************************************************************
+//
+//! The structure that describes a slide menu widget.
+//
+//*****************************************************************************
+typedef struct
+{
+ //
+ //! The generic widget information.
+ //
+ tWidget sBase;
+
+ //
+ //! A pointer to an off-screen display that is used for rendering the
+ //! menus prior to showing on the widget's area of the screen. There
+ //! are two off-screen displays. Each should be the size of the widget
+ //! area. The palette should include any colors that are used by this
+ //! widget.
+ //
+ tDisplay *psDisplayA;
+
+ //
+ //! A pointer to a second off-screen display.
+ //
+ tDisplay *psDisplayB;
+
+ //
+ //! The height, in pixels, of a single menu item (a cell).
+ //
+ uint32_t ui32MenuItemHeight;
+
+ //
+ //! The color used for drawing menu item cell boundaries and text.
+ //
+ uint32_t ui32ColorForeground;
+
+ //
+ //! The background color of menu item cells.
+ //
+ uint32_t ui32ColorBackground;
+
+ //
+ //! The color of a highlighted menu item.
+ //
+ uint32_t ui32ColorHighlight;
+
+ //
+ //! The font to use for menu text.
+ //
+ const tFont *psFont;
+
+ //
+ //! The current menu to display.
+ //
+ tSlideMenu *psSlideMenu;
+
+ //
+ // A function to call when a child widget becomes active or inactive
+ //
+ void (*pfnActive)(tWidget *psWidget, tSlideMenuItem *psMenuItem,
+ bool bActivated);
+}
+tSlideMenuWidget;
+
+//*****************************************************************************
+//
+//! Declares an initialized slide menu widget data structure.
+//!
+//! \param pParent is a pointer to the parent widget.
+//! \param pNext is a pointer to the sibling widget.
+//! \param pChild is a pointer to the first child widget.
+//! \param pDisplay is a pointer to the off-screen display on which to draw.
+//! \param i32X is the X coordinate of the upper left corner of the canvas.
+//! \param i32Y is the Y coordinate of the upper left corner of the canvas.
+//! \param i32Width is the width of the canvas.
+//! \param i32Height is the height of the canvas.
+//! \param psDisplayA is one of two off-screen displays for rendering menus.
+//! \param psDisplayB is one of two off-screen displays for rendering menus.
+//! \param ui32MenuItemHeight is the height of a menu item.
+//! \param ui32Foreground is the foreground color for menu item boundaries and
+//! text.
+//! \param ui32Background is the background color of the menu items.
+//! \param ui32Highlight is the color of a highlighted menu item.
+//! \param psFont is the font to use for the menu text.
+//! \param psMenu is the initial menu to display.
+//! \param pfnWidgetActive is a pointer to a function that will be called when
+//! a child widget is activated or deactivated.
+//!
+//! This macro provides an initialized slide menu widget data structure, which
+//! can be used to construct the widget tree at compile time in global variables
+//! (as opposed to run-time via function calls). This must be assigned to a
+//! variable, such as:
+//!
+//! \verbatim
+//! tSlideMenuWidget g_i16SlideMenu = SlideMenuStruct(...);
+//! \endverbatim
+//!
+//! Or, in an array of variables:
+//!
+//! \verbatim
+//! tSlideMenuWidget g_pi16SlideMenu[] =
+//! {
+//! SlideMenuStruct(...),
+//! SlideMenuStruct(...)
+//! };
+//! \endverbatim
+//!
+//! \return Nothing; this is not a function.
+//
+//*****************************************************************************
+#define SlideMenuStruct(pParent, pNext, pChild, pDisplay, \
+ i32X, i32Y, i32Width, i32Height, \
+ psDisplayA, psDisplayB, \
+ ui32MenuItemHeight, ui32Foreground, ui32Background, \
+ ui32Highlight, psFont, psMenu, pfnWidgetActive) \
+ { \
+ { \
+ sizeof(tSlideMenuWidget), \
+ (tWidget *)(pParent), \
+ (tWidget *)(pNext), \
+ (tWidget *)(pChild), \
+ pDisplay, \
+ { \
+ i32X, \
+ i32Y, \
+ (i32X) + (i32Width) - 1, \
+ (i32Y) + (i32Height) - 1 \
+ }, \
+ SlideMenuMsgProc \
+ }, \
+ psDisplayA, \
+ psDisplayB, \
+ ui32MenuItemHeight, \
+ ui32Foreground, \
+ ui32Background, \
+ ui32Highlight, \
+ psFont, \
+ psMenu, \
+ pfnWidgetActive \
+ }
+
+//*****************************************************************************
+//
+//! Declares an initialized variable containing a slide menu widget data
+//! structure.
+//!
+//! \param i16Name is the name of the variable to be declared.
+//! \param pParent is a pointer to the parent widget.
+//! \param pNext is a pointer to the sibling widget.
+//! \param pChild is a pointer to the first child widget.
+//! \param pDisplay is a pointer to the off-screen display on which to draw.
+//! \param i32X is the X coordinate of the upper left corner of the canvas.
+//! \param i32Y is the Y coordinate of the upper left corner of the canvas.
+//! \param i32Width is the width of the canvas.
+//! \param i32Height is the height of the canvas.
+//! \param psDisplayA is one of two off-screen displays for rendering menus.
+//! \param psDisplayB is one of two off-screen displays for rendering menus.
+//! \param ui32MenuItemHeight is the height of a menu item.
+//! \param ui32Foreground is the foreground color for menu item boundaries and
+//! text.
+//! \param ui32Background is the background color of the menu items.
+//! \param ui32Highlight is the color of a highlighted menu item.
+//! \param psFont is the font to use for the menu text.
+//! \param psMenu is the initial menu to display.
+//! \param pfnWidgetActive is a pointer to a function that will be called when
+//! a child widget is activated or deactivated.
+//!
+//! This macro declares a variable containing an initialized slide menu widget
+//! data structure, which can be used to construct the widget tree at compile
+//! time in global variables (as opposed to run-time via function calls).
+//!
+//! \return Nothing; this is not a function.
+//
+//*****************************************************************************
+#define SlideMenu(i16Name, pParent, pNext, pChild, pDisplay, \
+ i32X, i32Y, i32Width, i32Height, \
+ psDisplayA, psDisplayB, \
+ ui32MenuItemHeight, ui32Foreground, ui32Background, \
+ ui32Highlight, psFont, psMenu, pfnWidgetActive) \
+ tSlideMenuWidget i16Name = \
+ SlideMenuStruct(pParent, pNext, pChild, pDisplay, \
+ i32X, i32Y, i32Width, i32Height, \
+ psDisplayA, psDisplayB, \
+ ui32MenuItemHeight, ui32Foreground, ui32Background,\
+ ui32Highlight, psFont, psMenu, pfnWidgetActive)
+
+//*****************************************************************************
+//
+//! Sets the active menu of the slide menu widget.
+//!
+//! \param psSlideMenuWidget is a pointer to the slide menu widget to modify.
+//! \param psMenu is the new slide menu to make active.
+//!
+//! This function sets the active menu for the widget.
+//!
+//! \return None.
+//
+//*****************************************************************************
+#define SlideMenuMenuSet(psSlideMenuWidget, psMenu) \
+ do \
+ { \
+ (psSlideMenuWidget)->psSlideMenu = (psMenu); \
+ } while(0)
+
+//*****************************************************************************
+//
+//! Sets the active callback function for a slide menu widget.
+//!
+//! \param psSlideMenuWidget is a pointer to the slide menu widget to modify.
+//! \param pfnActivated is a function pointer to the function that should
+//! be called when the menu system activates or deactivates a child widget.
+//!
+//! This function sets the child widget active callback function.
+//!
+//! \return None.
+//
+//*****************************************************************************
+#define SlideMenuActiveCallbackSet(psSlideMenuWidget, pfnActivated) \
+ do \
+ { \
+ (psSlideMenuWidget)->pfnActive = (pfnActivated); \
+ } while(0)
+
+//*****************************************************************************
+//
+//! Gets the index of the menu item that has the focus.
+//!
+//! \param psSlideMenu is a pointer to the menu to query for item index.
+//!
+//! This function returns the index of the menu item that has the focus for
+//! the specified menu.
+//!
+//! \return Index of the menu item that has the focus.
+//
+//*****************************************************************************
+#define SlideMenuFocusItemGet(psSlideMenu) \
+ ((psSlideMenu)->ui32FocusIndex)
+
+//*****************************************************************************
+//
+//! Gets the selected items mask for a menu.
+//!
+//! \param psSlideMenu is a pointer to the menu to query for selected items.
+//!
+//! This function returns a value that is a bit mask of any menu items that
+//! are selected in the current menu. This is meant to work when a menu is
+//! configured to be selectable. Then multiple menu items can be selected and
+//! the selection mask indicates which are selected.
+//!
+//! \return Selection bit mask of selected menu items.
+//
+//*****************************************************************************
+#define SlideMenuSelectedGet(psSlideMenu) \
+ ((psSlideMenu)->ui32SelectedFlags)
+
+//*****************************************************************************
+//
+//! Sets the focus item index for a menu.
+//!
+//! \param psSlideMenu is a pointer to the menu to set the focus item.
+//! \param ui32Focus is the index of the menu item that should have the focus.
+//!
+//! This function is used to specify which menu item should have the focus.
+//!
+//! \return None.
+//
+//*****************************************************************************
+#define SlideMenuFocusItemSet(psSlideMenu, ui32Focus) \
+ do \
+ { \
+ (psSlideMenu)->ui32FocusIndex = (ui32Focus); \
+ (psSlideMenu)->ui32CenterIndex = (ui32Focus); \
+ } while(0)
+
+//*****************************************************************************
+//
+//! Sets the selected items bit mask for a menu.
+//!
+//! \param psSlideMenu is a pointer to the menu to set the selection mask.
+//! \param ui32Selected is a bit mask indicating which menu items should be
+//! marked as selected.
+//!
+//! This function is used to specify which menu items are pre-selected.
+//!
+//! \return None.
+//
+//*****************************************************************************
+#define SlideMenuSelectedSet(psSlideMenu, ui32Selected) \
+ do \
+ { \
+ (psSlideMenu)->ui32SelectedFlags = (ui32Selected); \
+ } while(0)
+
+//*****************************************************************************
+//
+// Prototypes for the slide menu widget APIs.
+//
+//*****************************************************************************
+extern int32_t SlideMenuMsgProc(tWidget *psWidget, uint32_t ui32Msg,
+ uint32_t ui32Param1, uint32_t ui32Param2);
+void SlideMenuDraw(tSlideMenuWidget *psMenuWidget, tContext *pContext,
+ int32_t i32OffsetY);
+extern void SlideMenuInit(tSlideMenuWidget *psWidget, const tDisplay *pDisplay,
+ int32_t i32X, int32_t i32Y, int32_t i32Width, int32_t i32Height,
+ tDisplay *pDisplayOffA, tDisplay *pDisplayOffB,
+ uint32_t ui32ItemHeight,
+ uint32_t ui32Foreground,
+ uint32_t ui32Background,
+ uint32_t ui32Highlight,
+ tFont *psFont, tSlideMenu *psMenu);
+
+//*****************************************************************************
+//
+// Mark the end of the C bindings section for C++ compilers.
+//
+//*****************************************************************************
+#ifdef __cplusplus
+}
+#endif
+
+//*****************************************************************************
+//
+// Close the Doxygen group.
+//! @}
+//
+//*****************************************************************************
+
+#endif // __SLIDEMENUWIDGET_H__
|