Module Dftab_mx.pkg

************************************************************************ Confidential Trade Secret. Copyright (c) 1997 Data Access Corporation, Miami Florida as an unpublished work. All rights reserved. DataFlex is a registered trademark of Data Access Corporation. ************************************************************************ ************************************************************************ $File name : Dftab_mx.pkg $File title : Tab mixin support for tab page and tab dialog Notice : $Author(s) : John Tuohy $Rev History 1/28/98 JJT Added rgb color support JJT 9/4/97 Removed kEnter on_key. This is now handled by container panel. JJT ??/??/9? File created ************************************************************************ DfTab_mx.pkg - tab dialog mixin class and non deo tab dialog classes Defines: Tab_Dialog_Mixin is a Mixin // mixin for tab dialog Tab_page_Mixin is a Mixin // mixin for tab page Skip_Button_Mode = 0 SBM_NEVER = 1 SBM_ALWAYS = 2 SBM_SMART ** dflt Pointer_Only_State = T/F ** F = dflt Events: Events can be keyboard or Mouse events t->t - Tab button to tab button navigation o->ot - Non-tab to tab w/ old page navigation o->nt - Non-tab to tab w/ new page navigation Mouse Kbd t->t o->ot o->nt t->t o->ot o->nt +------------------------------------------------+ skp=always /p=F ¦ B ¦ B ¦ B ¦¦ D ¦ D ¦ D ¦ +-------+-------+-------++-------+-------+-------¦ skp=always /p=t ¦ (D) ¦ D ¦ D ¦¦ (D) ¦ D ¦ D ¦ +-------+-------+-------++-------+-------+-------¦ skp=never /p=F ¦ B ¦ B ¦ B ¦¦ B ¦ B ¦ B ¦ +-------+-------+-------++-------+-------+-------¦ skp=never /p=T ¦ (D) ¦ D ¦ D ¦¦ (B) ¦ B ¦ B ¦ +-------+-------+-------++-------+-------+-------¦ skp=smart /P=F ¦ B ¦ B ¦ D ¦¦ B ¦ B ¦ D ¦ +-------+-------+-------++-------+-------+-------¦ skp=smart /P=T ¦ (B) ¦ D ¦ D ¦¦ (B) ¦ D ¦ D ¦ +------------------------------------------------+ Use Windows Dftab_mx.pkg - tab dialog mixin class and non deo tab dialog classes

Dftab_mx.pkg (view source)
• import declarations
  • VdfBase.pkg (view source)
  • cImageList.pkg (view source)
    provide image-list support for tabpages
• Tab_Dialog_Mixin : Mixin
  • Define_Tab_dialog_Mixin()
    • IntegerDefault_Tab
      from resetting to 0 each time they activated tab to start/return to. -1 means no default
    • IntegerSkip_Button_Mode
      How to handle keyboard navigation SBM_NEVER = don't skip tab in kbd navigation SBM_ALWAYS = skip tab in kbd navigation. SBM_SMART = Use windows logic. If not on a tab and the page is changed go to page else goto tab
    • IntegerPointer_Only_State
      If Skip_Button is NOT smart this determines if mouse navigation always give the tab the focus or never gives it the focus. If smart, use same logic as above
    • IntegerRotate_Mode
      tab pages use this as their default rotate mode
    • IntegerIn_Tab_Change_State
    • IntegerpbDeactivatePages
      setting this to true will make your tab pages work like they did in VDF6. When a page is hidden, it will be removed from the focus tree. Only do this if you need to to get an old app working properly.
    • IntegerpiOriginalClientSize
      this is used by tab pages to determine sizes for anchoring. It is used in conjunction with piLastClientSize in the tab page
    • IntegerpbResetPageOnActivate
      If entering via next navigation should we move to the Default_Tab tab page
    • IntegerPrivate.MultiLine_State
    • IntegerPrivate.TabWidth_Mode
    • Integerprivate_peTabPosition
    • Integerprivate_peTabStyle
    • Integerprivate_pbFlatSeparators
    • IntegerpbHotTrack
      design-time only
    • IntegerphoImageList
      should be set to a cImageList instance to display images on tab-page labels. Design-time only
  • integerClient_Area_State()
    This is a risky thing to do. Some of the packages (server.pkg) use client_area_state to figure out if the object is a client or a form. In order for internal activation of the tab items to work the real internal property client_area_state must be false. However, the external package standpoint client_area_state must be true. This seems to work because the internal client decisions (which uses the real client_area_state property) uses the internal property (it does not get the property by putting the message in the df message queue.
  • Set(String Val)
    Must Cancel. Values Are The Tab Items
  • OnResize()
  • Set(Integer cy Integer cx)
    • Integercxy
    • IntegeriPage
  • private_DoUpdateTabs()
    • IntegeriPage
    • IntegerhoPage
  • OnDisplay()
  • Page(Integer iState)
  • Set(Integer bMultiLine)
    • IntegerhWnd
    • IntegeriStyle
    • IntegeriVoid
  • IntegerMultiLine_State()
  • Set(Integer eTabPosition)
    • IntegerhWnd
    • IntegeriStyle
    • IntegeriVoid
    • IntegeriPage
    • IntegericPage
  • IntegerpeTabPosition()
  • Set(Integer eTabStyle)
    • IntegerhWnd
    • IntegeriStyle
    • IntegeriVoid
    • IntegeriPage
    • IntegericPage
  • IntegerpeTabStyle()
  • Set(Integer bButtons)
  • IntegerButtons_State()
  • Set(Integer bFlatSeparators)
  • IntegerpbFlatSeparators()
  • Set(Integer iMode)
    • IntegerhWnd
    • IntegeriStyle
    • IntegeriVoid
  • IntegerTabWidth_Mode()
  • IntegerNumberOfRows()
    • IntegerhWnd
  • integerAdd_Tab_item(String sLabel Integer tobjid)
    Add a tab page. Pass tab name and the page object Id. return the tab (item) number of the new page
    • IntegeriNumBtns
    • StringsTcItem
    • StringszText
    • IntegerlpsTcItem
    • IntegerlpszText
    • IntegerpVoid
  • Set(Integer item# Integer Obj#)
    Get/Set Tab_Page_Id identifies the page object associated with the tab item
  • integerTab_Page_Id(integer item#)
  • IntegerButton_Count()
    Button_Count: Number of tab buttons
  • integerCurrent_Tab()
    The tab that is the current "active" tab. If the tab page is defined and it is not active the current_tab returns -1. If -1 you can use item_count to find the tab that is rolled forward
    • Integerid
    • Integeritm
  • Mouse_Down(Integer iWindowNumber Integer iPosition)
    Replace current mouse behavior with out own. This give us more control over the switching behavior.
  • Mouse_Drag(Integer iWindowNumber Integer iPosition)
    cancelled to stop rotation of tab-pages
  • Request_Previous_Tab(integer Mode)
    No Param or 0 - Kbd Navigation 1 - Mouse Navigation 2 - Force to Button 3 - Force to Dialog
    • Integertab#
    • IntegerMde
    • IntegeroldTab#
  • Request_Next_Tab(integer Mode)
    • Integertab#
    • Integeroldtab#
    • IntegerMde
  • Request_Switch_To_Tab(Integer tab# integer PointerMode)
    PonterMode parameter (required): 0 - Keyboard Navigation 1 - Mouse Navigation 2 - Force to Button 3 - Force to Dialog
    • Integerrval
    • Integerfoc
    • Integerctb
    • IntegerSkipmode
  • integerTab_Change(Integer totab Integer PointerMode)
    PointerMode: 0 - button takes focus 1 - dialog takes focus 2 - no-one takes focus, just add to focus tree Rule: If the tab dialog object has the focus ; give the keep the focus in the dialog object. else if switching pages Give the focus to the new page else (tab dialog<>focus, same page) give the tab the focus
    • Integertabobj
    • Integerrval
    • Integerfromtab
    • Integerfromobj
    • Integertoobj
    • Integerfocobj
    • Integeroldst
    • IntegeriCnt
    • Stringxx
  • integerDeactivate_Tab(Integer tab# Integer tabpageobj)
    • Integerrval
  • DoHideTab(integer hPage integer bHide)
  • Request_Tab_Display(integer iTab)
    Display passed tab page. If no value (or -1) use default tab display = add to focus tree if needed, rotate up, do not activate
    • IntegeriTb
    • IntegerbFail
  • IntegerAdd_Focus(Handle hoParent)
    Augment to add the default tab page to the focus tree
    • Integerrval
  • integerActivate()
    Most tab navigation events are controlled by the class and activate messages are sent in the middle of these events. When this occurs the private property In_tab_change_state is true. In some cases of keyboard navigation from outside the object activate is called directly. This should never happen with no active tab page (because add_focus takes care of this). In such a case, we must decide if activate should keep the focus (the tab) or give it to the page. If smart mode or always mode go the tab button else go to button (normal activate behavior)
    • IntegeriTab
    • IntegeriDflt
    • IntegerbFail
  • Rebuild_Tab_Pointers()
    • IntegeriItm
    • IntegerhTabPg
    • IntegeriItems
  • Delete_Tab_Item(integer iTab)
    • IntegerhTabPg
    • IntegeriIc
    • IntegerbOld
  • set(integer iItem string sVal)
    • StringsTcItem
    • StringszText
    • IntegerlpsTcItem
    • IntegerlpszText
  • DoActivePage(handle hId)
    Private: this gets called to make sure that this page is active. Called during next/prior object id. For this to work the ID must be in the focus tree
  • handlePriorTabId()
    Return the Prior tab. Skip tab pages where the button is shadowed
    • IntegeriTab
    • IntegeriFirstTab
    • IntegerhId
  • handleNextTabId()
    Return the next tab. Skip tab pages where the button is shadowed
    • IntegeriTab
    • IntegeriFirstTab
    • IntegerhId
  • Next()
    augmented to create smarter next and previous behavior for tab buttons.
    • IntegeriItem
    • IntegereRotate
    • IntegerhId
  • Previous()
    • IntegeriItem
    • IntegereRotate
  • OnBeginningOfPanel(integer hoPanel)
    event called when Beginning_of_Panel is called by panel (usually view) by default, switch to the default tab (which is 0).
  • integerNext_Object_Id(integer fg)
    special for tab dialog. Note this must augment (and not replace) the next_object_id logic defined in standard_object_mixin, If descend (fg=0) we want to return the current tab page (it's the next object).
    • IntegerhId
    • IntegerrVal
• Tab_Page_Mixin : Mixin
  • Define_Tab_Page_Mixin()
    • Integerobj
    • Integermode
    • Integerclr
    • IntegerhoTD
    • integerTab_Button_Item
    • IntegerRotate_Mode
    • Integerprivate_piImageIndex
    • Integerprivate_pbHighlightTab
    • IntegerpbInsideActivate
      system maintained, prevents activation recursion
    • IntegerpbHidePage
      system maintained. Determines if tab page is explicitly hidden within this dialog
    • integerpiLastClientSize
      private: see GetContainerSize for docs on this
  • Page(Integer iState)
    • Integercxy
  • IntegerGetContainerClientSize()
    This needs to get the client size relative to the last time the object was un-paged. If an object has never been unpaged, you need to get the size of the orignal tab dialog (the first time it was paged). The first time a tab page is paged, the tab-dialog's original size is set in piOriginalClientSize. This is what you want to use for any tab page the FIRST time it is paged (since all of the sizes of its child objects are set relative to that size). Any time a tab page is unpaged, you want your new frame of reference to be the size of client at the time the page is being unpaged (because that's what all of the current size of the child objects are set to). So, anytime a tab page is removed (see remove_object) the size of the client is recorded in piLastClientSize. This property defaults to -1, which means that the object has never been paged (or resized) so you should use the original tab dialog size (see page).
    • IntegeriClientSize
  • integerActivate()
    • IntegerbFail
    • IntegeriTab
    • IntegeriCurTab
    • IntegerhId
  • integerContainerFocusWillNotChange()
    Private: needed by navigation (next_object_id). Normally this checks to see if the object is a container and if it contains the focus. If it does, navigation will keep looking for another object to give the focus. With tab-pages a focus change will occur because activate to a tab page means, try to go to the button. So we override the standard behavior here and force it to say the focus will change.
  • Set(Integer iItem String sValue)
    • Integerco
    • Integerid
  • integerOnChildWrapping(integer hoDest integer bDown)
    This is called anytime navigation (next_object_id & proir_object_id) would cause a "wrap" condition in a tab page. This function must return the object Id to naviagte to. Depending on the rotate_mode and skip_button_mode we need to return different target IDs.
    • IntegereRotate
    • IntegereSkip
    • IntegeriPage
    • IntegerhId
    • BooleanbHasFoc
  • Set(String Val)
    • Integeritm
  • stringTab_ToolTip_Value()
    • Integeritm
    • Stringrval
  • Set(Integer iState)
    • Integeritm
  • IntegerButton_Shadow_State()
    • Integeritm
    • IntegeriState
  • Activate_Area(Integer TakeFocusFg)
    override for desktop in val_mx which does not work well with tab pages. First make sure tab dialog has the focus (and that it worked) then if page is not active or it is hidden, make this the active page This is only sent during DEO validation and always sent via delegation
    • IntegeriTab
  • Rotate_Up()
    • Integeri
  • IntegerAdd_Focus(Handle hoParent)
    • IntegeriretVal
  • private_DoSetImage()
    • StringsTcItem
    • IntegerlpsTcItem
    • IntegeriPage
    • IntegeriImage
  • Set(Integer iIndex)
  • IntegerpiImageIndex()
  • Set(Integer bHighlight)
    • IntegerhwTabDialog
    • IntegeriPage
  • IntegerpbHighlightTab()
  • Set(String sLabel)
    • IntegeriPage
    • IntegerhWnd
    • IntegeriVoid
    • StringsTcItem
    • IntegerlpsTcItem
    • IntegerlpsLabel
  • DoHideTab(Integer bHide)
    This explicitly hides/unhides this tab page.
    • IntegerbHidden
  • DoImplicitTabHide(integer iState)
    augment to only broadcast change if not already hidden by this page
  • Remove_Object()
    reverse any effects of hiding a tab. When removed, restore page to original unhidden state. There were problems with dbGroups not enabling themselves because the check current_shadow_state when they are activated. Hidden states were getting in the way Also, keep track of current clientsize for future paging and anchoring
  • OnResize()
  • Set(Integer cy Integer cx)
    • Integercxy

References (2):

Field References (0):