Module entitem.pkg

************************************************************************ Confidential Trade Secret. Copyright 1987-1992 Data Access Corporation, Miami FL, USA All Rights reserved DataFlex is a registered trademark of Data Access Corporation. $Source: k:\RCS\.\pkg\entitem.pkg,v $ $Revision: 1 $ $State: Exp $ $Author: james $ $Date: Apr 01 16:08:48 1997 $ $Locker: $ $Log: entitem.pkg,v $ Revision 2.1 1993/08/25 17:47:39 james Adding new main branch Revision 1.2 1993/04/28 00:20:34 james Initializing 3.04 source code. Revision 1.1 1992/09/08 14:43:04 james Initial revision Revision 1.4 92/06/17 23:57:36 lee added object_item_entry_exit property to disable item entry/exit messages during scroll. Revision 1.3 92/05/14 16:45:57 SWM Updated Copyright slug. Revision 1.2 92/03/09 19:01:29 james Added #CHKSUB directive to insure source only compiled with correct revision of compiler. Revision 1.1 91/10/23 10:20:28 elsa Initial revision ************************************************************************/ Augmentations: Entry 12/20/94 JJT - merged autoprompt support 03/17/95 - Findreq_Auto_prompt fixed to check for itm and not the current_item for data-file. Also, improved status checking logic. 08/29/95 JJT - Procedure Auto_prompt now only sets auto_prompt_check if the current mode is not auto_prompt_on. Otherwise ivalidates which turn these on get lost. 08/30/95 JJT - Prompt only resets auto_prompt_mode if we are returning to the same current_item (which is the normal case). 08/30/95 JJT - Fixed auto-prompt after image move with a messy fix creates a duplicate move_client_location here that adjusts prompt_entry_mode. This must mix in after entitem. 08/30/95 JJT - New public message Entry_Value. Returns numbers stripped of uneeded 0 decimals and decimal point. ************************************************************************/ 2/26/2002 JJT - 8.2 clean up (indirect_file, local, self, etc.) ************************************************************************ File Name: EntItem.Inc Creation Date: January 1, 1991 Modified Date: May 23, 1991 Author(s): Steven A. Lowe This module defines the routines and properties required to support the use of entry-items, collected in the abstract class Entry_Item_Mixin. This file should be USEd prior to and IMPORTed within the scope of the class definition by any user-interface (esp. data-entry) class which must support entry-items. This file is used by ENTRYFRM.PKG and WIDELIST.PKG. ************************************************************************/

entitem.pkg (view source)
• import declarations
  • VdfBase.pkg (view source)
• Entry_Item_Mixin : mixin
  • define_entry_item()
    Description This procedure defines kPrompt and kZoom accelerator keys for this object. Assumptions/Preconditions This procedure should only be invoked from the Construct_Object procedure of a class definition. Exceptions None. Notes None.
    • integerobject_item_entry_exit
    • integerAuto_prompt_State
      (JJT) Added for auto-prompt support (from autoprmpt.pkg) Auto_Prompt_State: If true, autoprompt if iPrompt message exists and field is blank. If False Auto_prompt must be asked for (Msg_Auto_prompt).
    • IntegerPrompt_Entry_Mode
      Prompt_Entry_Mode AUTO_PROMPT_READY = Allow autoPrompt. (idle position) AUTO_PROMPT_CHECK = AutoPrompt if blank field AUTO_PROMPT_ON = Do AutoPrompt on the next entry AUTO_PROMPT_OFF = Do NOT AutoPrompt the next enxtry. (internal)
  • Zoom()
    Description This procedure activates the zoom-objct, if any, for the current entry-item. Assumptions/Preconditions This object (or one of its ancestor classes) implements a zoom_object function to return a valid object id (for a user-interface object understanding the PopUp message), or 0. Exceptions If the zoom-object is 0, no action is taken. Notes None.
    • Integerobj#
  • Prompt()
    Description This procedure activates the prompt-objct, if any, for the current entry-item. Assumptions/Preconditions This object (or one of its ancestor classes) implements a prompt_object function to return a valid object id (for a user-interface object understanding the PopUp message), or 0. Exceptions If the prompt-object is 0, no action is taken. Notes None.
    • Integerobj#
    • IntegerItm
  • integerItem_Entry(integer msg# integer item#)
    Description This function invokes the message given by msg#, passing the specified item# as the only argument to the message. The value returned by execution of the message is returned; non-zero means that entry to the specified item# should be denied. Assumptions/Preconditions The msg# argument must be either a valid message id or 0. The item# argument must be a valid entry-item index (between 0 and Item_Count-1). Exceptions If the specified msg# is 0, no action is taken. Notes This function is invoked by the Item_Change procedure, among others.
    • IntegerretVal
  • integerItem_Exit(integer msg# integer item#)
    Description This function invokes the message given by msg#, passing the specified item# as the only argument to the message. The value returned by execution of the message is returned; non-zero means that exit from the specified item# should be denied. Assumptions/Preconditions The msg# argument must be either a valid message id or 0. The item# argument must be a valid entry-item index (between 0 and Item_Count-1). Exceptions If the specified msg# is 0, no action is taken. Notes This function is invoked by the Item_Change procedure, among others.
    • IntegerretVal
  • integerItem_Validate(integer msg# integer item#)
    Description This function invokes the message given by msg#, passing the specified item# as the only argument to the message. The value returned by execution of the message is returned; non-zero means that the data entered in the specified item# is invalid, and that the cursor should stay on the specified item#. Assumptions/Preconditions The msg# argument must be either a valid message id or 0. The item# argument must be a valid entry-item index (between 0 and Item_Count-1). Exceptions If the specified msg# is 0, no action is taken. Notes This function is invoked by the Item_Change procedure, among others.
    • IntegerretVal
  • IntegerExec_Entry(Integer item#)
    Description This function invokes the entry-message for the specified item#, and returns the result; non-zero means that entry to the specified item# should be denied. Assumptions/Preconditions The item# argument must be a valid entry-item index (between 0 and Item_Count-1), or the sentinel value CURRENT. Exceptions None. Notes This function is used to force execution of an item's entry-msg.
    • Integerretval
    • IntegercurItem
    • IntegerentMsg
  • IntegerExec_Exit(Integer item#)
    Description This function invokes the exit-message for the specified item#, and returns the result; non-zero means that exit from the specified item# should be denied. Assumptions/Preconditions The item# argument must be a valid entry-item index (between 0 and Item_Count-1), or the sentinel value CURRENT. Exceptions None. Notes This function is used to force execution of an item's exit-msg.
    • Integerretval
    • IntegercurItem
    • IntegerexitMsg
  • integerExec_Validate(integer item#)
    Description This function invokes the validate-message for the specified item#, and returns the result; non-zero means that the data entered in the specified item# is invalid, and that the cursor should stay on the specified item#. Assumptions/Preconditions The item# argument must be a valid entry-item index (between 0 and Item_Count-1), or the sentinel value CURRENT. Exceptions If the specified item# uses the AUTOFIND option, an entry_autofind is performed. Notes This function is used to force execution of an item's validate-msg.
    • Integerretval
    • IntegercurItem
    • IntegervalMsg
    • Integerchgd
    • IntegerautoFlag
    • IntegerautoGEFlag
  • Auto_Prompt(Integer Itm#)
    *********************JJT The following was added for auto_prompt support. In addition, some properties in the define_entry_item and Prompt was changed. This tells the next entry statement to execute an auto-prompt. Right now there is a bug in the iEntry mechanism that causes the the iEntry to not always get called. When this happens we lose the auto_prompt (this often happens if your auto-prompt is in the first item). The work-around for now is that the ENTRY function makes an check. If the iEntry message is MSG_AUTO_PROMPT it will do the auto- prompt for you. This means that the one line here is not really required. However, when iEntry is fixed - it WILL be needed. This also shows how you can use this statement in other iEntry messages
  • IntegerTest_for_Auto_prompt(Integer Itm#)
    Function: Test_for_Auto_Prompt Test if an auto-prompt should be executed. This is only called by the entry function. It should Return TRUE if an autoprompt is required. This checks to see if the item is blank. This was designed for augmentation.
  • IntegerEntry()
    • IntegerRetval
    • IntegerPmode
    • IntegerItm#
    • IntegerAuto_state
  • Integerrequired_Auto_Prompt(Integer Itm#)
    useful validate function. If you set iValidate to this message you'll get an error when you attempt save and a prompt when you attempt to move.
  • IntegerFindreq_Auto_Prompt(Integer Itm#)
    03/17/95 - Fixed bug where datafile was not for Itm#. Fixed logic to better handle autofind (where a record exists but it was not auto-found.
    • Integerserver#
    • IntegerErr#
    • IntegerFile#
    • IntegerField#
    • IntegerTyp
    • IntegerDummy
    • IntegeriStat
    • StringItm_val
    • StringFileVal
  • stringEntry_Value(integer Itm#)
    This is lifted from clmovemx.pkg. It shuts off auto_prompting. If this is not done you get an auto-prompt after move. This is only required because the entry function handles msg_auto_prompt directly because the ientry hook is not always reliable. When that is fixed, we could also remove this code. For this to work the entitem package MUST be mixed in after the clmove mixin package. Used in entry_form and wide_list procedure Move_Client_Location integer yoff integer xoff // new line of code Set Prompt_Entry_Mode to AUTO_PROMPT_OFF // been there, done that //.....direct from clmovemx // if allowed do the move....else delegate if (Allow_Move_State(self)) ; send Move_Location yoff xoff Else Delegate Send Move_Client_Location yoff xoff end_procedure Public Message Just like Value except this will strip .0000 from numeric items which allows for comparison with data fields. Only works if item is associated with a file.field
    • IntegerFile#
    • IntegerField#
    • IntegerType#
    • IntegerDummy#
    • StringVal

References (3):

Field References (0):