224 lines
8.4 KiB
C
224 lines
8.4 KiB
C
/*********************************************************************
|
|
* Portions COPYRIGHT 2016 STMicroelectronics *
|
|
* Portions SEGGER Microcontroller GmbH & Co. KG *
|
|
* Solutions for real time microcontroller applications *
|
|
**********************************************************************
|
|
* *
|
|
* (c) 1996 - 2015 SEGGER Microcontroller GmbH & Co. KG *
|
|
* *
|
|
* Internet: www.segger.com Support: support@segger.com *
|
|
* *
|
|
**********************************************************************
|
|
|
|
** emWin V5.32 - Graphical user interface for embedded applications **
|
|
All Intellectual Property rights in the Software belongs to SEGGER.
|
|
emWin is protected by international copyright laws. Knowledge of the
|
|
source code may not be used to write a similar product. This file may
|
|
only be used in accordance with the following terms:
|
|
|
|
The software has been licensed to STMicroelectronics International
|
|
N.V. a Dutch company with a Swiss branch and its headquarters in Plan-
|
|
les-Ouates, Geneva, 39 Chemin du Champ des Filles, Switzerland for the
|
|
purposes of creating libraries for ARM Cortex-M-based 32-bit microcon_
|
|
troller products commercialized by Licensee only, sublicensed and dis_
|
|
tributed under the terms and conditions of the End User License Agree_
|
|
ment supplied by STMicroelectronics International N.V.
|
|
Full source code is available at: www.segger.com
|
|
|
|
We appreciate your understanding and fairness.
|
|
----------------------------------------------------------------------
|
|
File : SCROLLBAR.h
|
|
Purpose : SCROLLBAR include
|
|
--------------------END-OF-HEADER-------------------------------------
|
|
*/
|
|
|
|
/**
|
|
******************************************************************************
|
|
* @attention
|
|
*
|
|
* Licensed under MCD-ST Liberty SW License Agreement V2, (the "License");
|
|
* You may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at:
|
|
*
|
|
* http://www.st.com/software_license_agreement_liberty_v2
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*
|
|
******************************************************************************
|
|
*/
|
|
|
|
#ifndef SCROLLBAR_H
|
|
#define SCROLLBAR_H
|
|
|
|
#include "WM.h"
|
|
#include "DIALOG_Intern.h" /* Req. for Create indirect data structure */
|
|
#include "WIDGET.h"
|
|
|
|
#if GUI_WINSUPPORT
|
|
|
|
#if defined(__cplusplus)
|
|
extern "C" { /* Make sure we have C-declarations in C++ programs */
|
|
#endif
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Defines
|
|
*
|
|
**********************************************************************
|
|
*/
|
|
#define SCROLLBAR_CI_THUMB 0
|
|
#define SCROLLBAR_CI_SHAFT 1
|
|
#define SCROLLBAR_CI_ARROW 2
|
|
|
|
/*********************************************************************
|
|
*
|
|
* States
|
|
*/
|
|
#define SCROLLBAR_STATE_PRESSED WIDGET_STATE_USER0
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Create / Status flags
|
|
*/
|
|
#define SCROLLBAR_CF_VERTICAL WIDGET_CF_VERTICAL
|
|
#define SCROLLBAR_CF_FOCUSSABLE WIDGET_STATE_FOCUSSABLE
|
|
|
|
/************************************************************
|
|
*
|
|
* Skinning property indices
|
|
*/
|
|
#define SCROLLBAR_SKINFLEX_PI_PRESSED 0
|
|
#define SCROLLBAR_SKINFLEX_PI_UNPRESSED 1
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Public Types
|
|
*
|
|
**********************************************************************
|
|
*/
|
|
typedef WM_HMEM SCROLLBAR_Handle;
|
|
|
|
typedef struct {
|
|
GUI_COLOR aColorFrame[3];
|
|
GUI_COLOR aColorUpper[2];
|
|
GUI_COLOR aColorLower[2];
|
|
GUI_COLOR aColorShaft[2];
|
|
GUI_COLOR ColorArrow;
|
|
GUI_COLOR ColorGrasp;
|
|
} SCROLLBAR_SKINFLEX_PROPS;
|
|
|
|
typedef struct {
|
|
int IsVertical;
|
|
int State;
|
|
} SCROLLBAR_SKINFLEX_INFO;
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Create functions
|
|
*
|
|
**********************************************************************
|
|
*/
|
|
SCROLLBAR_Handle SCROLLBAR_Create (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int Id, int WinFlags, int SpecialFlags);
|
|
SCROLLBAR_Handle SCROLLBAR_CreateAttached(WM_HWIN hParent, int SpecialFlags);
|
|
SCROLLBAR_Handle SCROLLBAR_CreateEx (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int ExFlags, int Id);
|
|
SCROLLBAR_Handle SCROLLBAR_CreateUser (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int ExFlags, int Id, int NumExtraBytes);
|
|
SCROLLBAR_Handle SCROLLBAR_CreateIndirect(const GUI_WIDGET_CREATE_INFO * pCreateInfo, WM_HWIN hWinParent, int x0, int y0, WM_CALLBACK * cb);
|
|
|
|
/*********************************************************************
|
|
*
|
|
* The callback ...
|
|
*
|
|
* Do not call it directly ! It is only to be used from within an
|
|
* overwritten callback.
|
|
*/
|
|
void SCROLLBAR_Callback(WM_MESSAGE * pMsg);
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Member functions
|
|
*
|
|
**********************************************************************
|
|
*/
|
|
|
|
/* Methods changing properties */
|
|
|
|
void SCROLLBAR_AddValue (SCROLLBAR_Handle hObj, int Add);
|
|
void SCROLLBAR_Dec (SCROLLBAR_Handle hObj);
|
|
void SCROLLBAR_Inc (SCROLLBAR_Handle hObj);
|
|
int SCROLLBAR_GetUserData(SCROLLBAR_Handle hObj, void * pDest, int NumBytes);
|
|
GUI_COLOR SCROLLBAR_SetColor (SCROLLBAR_Handle hObj, int Index, GUI_COLOR Color);
|
|
void SCROLLBAR_SetNumItems(SCROLLBAR_Handle hObj, int NumItems);
|
|
void SCROLLBAR_SetPageSize(SCROLLBAR_Handle hObj, int PageSize);
|
|
void SCROLLBAR_SetValue (SCROLLBAR_Handle hObj, int v);
|
|
int SCROLLBAR_SetWidth (SCROLLBAR_Handle hObj, int Width);
|
|
void SCROLLBAR_SetState (SCROLLBAR_Handle hObj, const WM_SCROLL_STATE* pState);
|
|
int SCROLLBAR_SetUserData(SCROLLBAR_Handle hObj, const void * pSrc, int NumBytes);
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Member functions: Skinning
|
|
*
|
|
**********************************************************************
|
|
*/
|
|
void SCROLLBAR_GetSkinFlexProps (SCROLLBAR_SKINFLEX_PROPS * pProps, int Index);
|
|
void SCROLLBAR_SetSkinClassic (SCROLLBAR_Handle hObj);
|
|
void SCROLLBAR_SetSkin (SCROLLBAR_Handle hObj, WIDGET_DRAW_ITEM_FUNC * pfDrawSkin);
|
|
int SCROLLBAR_DrawSkinFlex (const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo);
|
|
void SCROLLBAR_SetSkinFlexProps (const SCROLLBAR_SKINFLEX_PROPS * pProps, int Index);
|
|
void SCROLLBAR_SetDefaultSkinClassic(void);
|
|
WIDGET_DRAW_ITEM_FUNC * SCROLLBAR_SetDefaultSkin(WIDGET_DRAW_ITEM_FUNC * pfDrawSkin);
|
|
|
|
#define SCROLLBAR_SKIN_FLEX SCROLLBAR_DrawSkinFlex
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Managing default values
|
|
*
|
|
**********************************************************************
|
|
*/
|
|
int SCROLLBAR_GetDefaultWidth(void);
|
|
GUI_COLOR SCROLLBAR_SetDefaultColor(GUI_COLOR Color, unsigned int Index); /* Not yet documented */
|
|
int SCROLLBAR_SetDefaultWidth(int DefaultWidth);
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Global functions
|
|
*
|
|
**********************************************************************
|
|
*/
|
|
int SCROLLBAR_GetThumbSizeMin(void);
|
|
int SCROLLBAR_SetThumbSizeMin(int ThumbSizeMin);
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Query state
|
|
*
|
|
**********************************************************************
|
|
*/
|
|
int SCROLLBAR_GetNumItems(SCROLLBAR_Handle hObj);
|
|
int SCROLLBAR_GetPageSize(SCROLLBAR_Handle hObj);
|
|
int SCROLLBAR_GetValue (SCROLLBAR_Handle hObj);
|
|
|
|
/*********************************************************************
|
|
*
|
|
* Macros for compatibility
|
|
*
|
|
**********************************************************************
|
|
*/
|
|
#define SCROLLBAR_BKCOLOR0_DEFAULT SCROLLBAR_COLOR_ARROW_DEFAULT
|
|
#define SCROLLBAR_BKCOLOR1_DEFAULT SCROLLBAR_COLOR_SHAFT_DEFAULT
|
|
#define SCROLLBAR_COLOR0_DEFAULT SCROLLBAR_COLOR_THUMB_DEFAULT
|
|
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif // GUI_WINSUPPORT
|
|
#endif // SCROLLBAR_H
|
|
|
|
/*************************** End of file ****************************/
|