fc-magnetite: src/ui3/bmi/mmiBookUtils.h annotate

annotate src/ui3/bmi/mmiBookUtils.h @ 632:d968a3216ba0

new tangomdm build target TCS211/Magnetite built for target leonardo runs just fine on the Tango-based Caramel board, but a more proper tangomdm build target is preferable in order to better market these Tango modems to prospective commercial customers. The only differences are in GPIO and MCSI config: * MCSI is enabled in the tangomdm build config. * GPIO 1 is loudspeaker amplifier control on Leonardo, but on Tango platforms it can be used for anything. On Caramel boards this GPIO should be configured as an output driving high. * GPIO 2 needs to be configured as Calypso input on Leonardo, but on Tango platforms it can be used for anything. On Caramel boards this GPIO should be configured as an output, either high or low is OK.

author	Mychaela Falconia <falcon@freecalypso.org>
date	Sat, 04 Jan 2020 19:27:41 +0000
parents	6a4d9f47793e
children

rev	line source
420 e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	1 #ifndef _MMIBOOKUTILS_H_
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	2 #define _MMIBO0KUTILS_H_ 1
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	3
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	4 /*******************************************************************************
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	5
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	6 CONDAT (UK)
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	7
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	8 ********************************************************************************
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	9
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	10 This software product is the property of Condat (UK) Ltd and may not be
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	11 disclosed to any third party without the express permission of the owner.
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	12
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	13 ********************************************************************************
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	14
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	15 $Project name: Basic MMI
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	16 $Project code: BMI (6349)
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	17 $Module: PhoneBook
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	18 $File: MmiBookUtils.h
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	19 $Revision: 1.0
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	20
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	21 $Author: Condat(UK)
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	22 $Date: 25/10/00
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	23
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	24 ********************************************************************************
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	25
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	26 Description:
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	27
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	28 This module provides utility functions for the phone book.
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	29
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	30
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	31 ********************************************************************************
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	32
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	33 $History: MmiBookUtils.h
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	34
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	35 25/10/00 Original Condat(UK) BMI version.
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	36
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	37 $End
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	38
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	39 *******************************************************************************/
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	40
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	41
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	42 /* Include the phonebook types package, it will probably be
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	43 required to get the basic types which are shared by the
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	44 phonebook modules.
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	45 */
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	46 #include "MmiBookShared.h"
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	47 #include "mfw_phb.h"
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	48 /* SPR#1428 - SH - New Editor changes */
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	49 #ifndef NEW_EDITOR
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	50 #include "MmiEditor.h" //for editor size definitions
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	51 #endif
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	52 /* bookCurrentWindow
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	53
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	54 This returns the window handle associated with the current
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	55 MFW element
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	56 */
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	57 tBookMfwHnd bookCurrentWindow( void );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	58
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	59
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	60 /* bookDefaultCallBack
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	61
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	62 This is a simple call back function which is invoked when
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	63 a not implemented dialog is displayed. We don't want anyone
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	64 outside of this module using it so define it as static,
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	65 this will still be callable from the info dialogs as it
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	66 will use the reference we set up.
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	67 */
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	68 static tBookStatus bookDefaultCallBack( tBookMfwHnd win, UBYTE identifier, UBYTE reason );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	69
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	70
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	71 /* bookWindowData
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	72
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	73 This routine is designed to be invoked from within a menu
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	74 handler or call back function and will return a pointer to
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	75 the user data associated with the current MFW element.
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	76
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	77 The return value is a pointer to void, therefore the caller
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	78 is responsible for casting this to the correct type prior
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	79 to use.
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	80 */
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	81 void *bookWindowData( void );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	82
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	83
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	84 /* bookMenuSelectedNumber
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	85
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	86 This will return the currently selected entry in the phone
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	87 book, when the routine is being called from a menu handler
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	88 */
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	89 char *bookMenuSelectedNumber( void );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	90
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	91
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	92 /* bookNotImplemented
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	93
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	94 This will present an information dialog indicating the current
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	95 feature is still under development. This routine will use the
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	96 current MFW element to detect the handle of the parent window
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	97 if the incoming window handle is NULL.
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	98 */
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	99 tBookStatus bookNotImplemented( tBookMfwHnd ParentWindowHandle );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	100 tBookStatus bookMenuNotImplemented( tBookMfwMenu Menu, tBookMfwMenuItem Item );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	101
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	102
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	103
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	104
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	105 /* Utility function to determine if the phone book is
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	106 still in the loading state
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	107 */
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	108 int bookPhoneBookLoading( void );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	109
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	110
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	111
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	112 /* Utility functions just to throw a string onto the screen
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	113 primarily for debug purposes, the modal version will wait
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	114 for a user input before removing the message, the non-modal
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	115 will clear after three seconds
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	116 */
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	117 tBookStatus bookInfoDialog( char String1, char String2 );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	118 tBookStatus bookInfoDialogModal( char String, char String2 );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	119
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	120
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	121 /* SPR#1428 - SH - New Editor: No longer required */
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	122 #ifndef NEW_EDITOR
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	123 /* Set editing attributes
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	124 This constructs a edit attribute block from the provided
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	125 parameters
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	126 */
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	127 // GW - Changed colour from 8 bits (foreground) to 2x32bits fgd and bgd
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	128 void bookSetEditAttributes(
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	129 int editZone,
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	130 U32 colindex,
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	131 U8 font, U8 mode, U8 *controls,
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	132 char *text, U16 size,
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	133 MfwEdtAttr* attr);
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	134 #endif
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	135
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	136 /* Memory allocation and freeing functions
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	137
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	138 These routines provided guarded access to the malloc and free
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	139 routines used in the MMI application. The wrapper functions
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	140 provided here allow debugging and tracking information to be
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	141 easily derived, it also allows the memory allocation and
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	142 deallocation to be changed if required.
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	143
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	144 Note that the free routine takes a pointer to the pointer
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	145 to the memory being freed. This allows the actual pointer
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	146 value to be set to NULL as part of the free operation, this
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	147 helps protect against reusing the pointer after the memory
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	148 has been deallocated.
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	149
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	150 Sample usage:
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	151
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	152 tStructure *ptr;
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	153
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	154 if ( ( ptr = (tStructure *) bookMemAlloc( sizeof(tStructure) ) ) != NULL )
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	155 {
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	156 // use the allocated memory
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	157 //
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	158 ...
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	159
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	160 // free the memory
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	161 //
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	162 bookMemFree( &ptr );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	163 }
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	164 */
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	165 void *bookMemAlloc( long int NumBytes );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	166 void bookMemFree( void **Pointer );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	167
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	168
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	169
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	170 /* Name handling utility functions
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	171 */
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	172 UBYTE bookFindName( UBYTE number, tMmiPhbData *current );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	173 //UBYTE changeName( UBYTE book, T_MFW_PHB_ENTRY entry, T_MFW_PHB_STATUS currentStatus );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	174 //UBYTE deleteName( UBYTE book, UBYTE index, T_MFW_PHB_STATUS *currentStatus );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	175 //UBYTE addName( UBYTE book, T_MFW_PHB_ENTRY entry, T_MFW_PHB_STATUS currentStatus );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	176
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	177 /* File handling functions
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	178 */
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	179 void changeInFile( T_phbk *phbk );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	180 void deleteFromFile( T_phbk *phbk, UBYTE book );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	181 void storeInFile( T_phbk *phbk );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	182
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	183 /* SPR#1112 - SH - Internal phonebook use */
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	184 #ifdef INT_PHONEBOOK
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	185 void bookChangePB(T_MFW_HND win, UBYTE identifier, UBYTE reason);
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	186 UBYTE bookCopy( T_MFW_PHB_ENTRY entry, T_MFW_PHB_STATUS destStatus, T_MFW_PHB_STATUS *srcStatus, UBYTE move);
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	187 void bookCopySingle(T_MFW_HND win, UBYTE identifier, UBYTE reason);
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	188 void bookCopyMultiple(T_MFW_HND win, UBYTE move, UBYTE reason);
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	189 #endif
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	190
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	191 UBYTE bookGetCurrentStatus( T_MFW_PHB_STATUS *currentStatus );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	192 int bookEvent( MfwEvt e, void *para );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	193
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	194 /* Copy name in phonebook structure
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	195 */
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	196 void bookCopyPhbName( T_MFW_PHB_ENTRY* destEntry, T_MFW_PHB_ENTRY* srcEntry, int maxLen );
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	197
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	198
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	199 /*******************************************************************************
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	200
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	201 End of File
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	202
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	203 *******************************************************************************/
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	204
e8ddbb0837ed src/ui3: initial import of TCS3/LoCosto BMI & MFW code Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	205 #endif

FreeCalypso > hg > fc-magnetite

annotate src/ui3/bmi/mmiBookUtils.h @ 632:d968a3216ba0