Module cCJCommandBarSystem.pkg

cCJCommandBarSystem.pkg (view source)
• import declarations
  • Windows.pkg (view source)
  • cRegistry.pkg (view source)
  • cCJCommandBars.pkg (view source)
    loads CodeJock class
• cCJIdleHandler : cIdleHandler
  idle timer used for updates.
  • OnIdle()
• IntegerghoCommandBars
• cCJCommandBarSystem : cCJCommandBars
  • Construct_Object()
    Inherited from cCJCommandBars
    • IntegerhoTimer
    • IntegerhoMain
    • IntegerpeRestoreLayout
      do we save/restore command bars and if so how
    • IntegerpiLayoutBuild
      This allows developers to control when a load layout should not be used because it is out of date. Just keep incrementing this value when you change something that is not compatible
    • StringpsLayoutSection
      Name used to save a store commandbars. Can be changed to create custom setups.
    • BooleanpbMDIMenu
      if true this expects client area and a panel. Auto assigned
    • HandlephoStatusBar
      assigned automatically
    • IntegerpePrivateVisualTheme
    • BooleanpbPrivateEnableCustomization
    • BooleanpbPrivateAltDragCustomization
    • IntegerpePrivateAnimation
    • BooleanpbPrivateLargeIcons
    • BooleanpbPrivateShowTextBelowIcons
    • BooleanpbPrivateAlwaysShowFullMenus
    • BooleanpbPrivateShowFullAfterDelay
    • BooleanpbPrivateOfficeStyleDisabledIcons
    • BooleanpbPrivateIconsWithShadow
    • BooleanpbPrivateToolBarScreenTips
    • BooleanpbPrivateShowPopupBarToolTips
    • BooleanpbPrivateToolBarAccelTips
    • BooleanpbPrivateAutoHideUnusedPopups
    • BooleanpbPrivateShowExpandButtonAlways
    • BooleanpbPrivateSyncFloatingToolbars
    • BooleanpbPrivateFloatToolbarsByDoubleClick
    • BooleanpbCustomizeShowKeyboardPage
    • BooleanpbCustomizeShowOptionsPage
    • HandlephoPrivateActions
      these will not be exposed. Property Boolean pbShowIconsShadow // ???? Property Boolean pbGenerateDisabledcIcons // ???? Property Boolean pbUseFadedIcons Property Integer piExpandDelay Property Integer piExplandHoverDelay Property Integer peShowKbdCues Property Integer peUseKbdCues Property Integer piMaxPopupWidth Property Integer piIconsSize // folded?? Property Integer piLargeIconSize Property Integer piPopupIconSize
    • HandlephoPrivateDesignerControls
    • HandlephoPrivateKeyBindings
    • HandlephoPrivateOptions
    • BooleanpbPrivateTimerUpdate
    • Handle[]phoRegisteredActions
      array of all registered actions (i.e., actions that have a DF object and are COM instanciated)
    • Handle[]phoActiveUpdates
      array of actions that should actively updated via timer refresh
    • Integer[]piActionIdPool
      array of action IDs that can be reused. We do this because we cannot destroy actions
    • IntegerpiLastBarId
      last auto assigned BarId
    • IntegerpiLastImageId
      last auto assigned image ID
    • IntegerpiLastAssignedDesignTimeID
      used to determine of Load should occur. When the count changes in the the action IDs or barIds it is not safe to reload things.
    • IntegerpiLastAssignedDesignTimeBarID
    • HandlephoTimer
  • AssignMDIMenu()
    this will figure out if this is an MDI menu and assign the ghoCommandBars global variable if needed. We assume it is MDI if the main_panel_id is commandbars parent and it is MDI style
    • IntegerhoMain
    • IntegerhoParent
    • BooleanbIsMdi
  • BooleanIsMDIMenu()
    • BooleanbMDI
  • HandleClientAreaObject()
    returns the ClientArea DF object if this is an MDI style system.
    • BooleanbMDI
    • IntegerhoClientArea
  • SetComOptionsProperty(Handle hmPrivateProperty Handle hmCOMProperty Integer iValue)
    Generic Get and Set property that is used to get and set a DF/COM options property. can be used by any integer or boolean property
    • IntegerhoOptions
  • IntegerGetComOptionsProperty(Handle hmPrivateProperty Handle hmCOMProperty)
    • IntegerhoOptions
    • IntegeriValue
  • Set(Integer eValue)
    Inherited from cCJ_DCommandBars
    these are set in the cCJCommandBars object
  • IntegerpeVisualTheme()
    • IntegereValue
  • Set(Boolean bValue)
    Inherited from cCJ_DCommandBars
  • BooleanpbEnableCustomization()
    • BooleanbValue
  • Set(Integer eValue)
    Inherited from cCJ_DCommandBars
    these are set in the cCJCommandBars's Option object
  • IntegerpeAnimation()
    • IntegereValue
  • Set(Boolean bValue)
    Inherited from cCJ_DCommandBars
  • BooleanpbAlwaysShowFullMenus()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJ_DCommandBars
  • BooleanpbShowFullAfterDelay()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJ_DCommandBars
  • BooleanpbAutoHideUnusedPopups()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJ_DCommandBars
  • BooleanpbToolBarScreenTips()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJ_DCommandBars
  • BooleanpbShowPopupBarToolTips()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJ_DCommandBars
  • BooleanpbToolBarAccelTips()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJ_DCommandBars
  • BooleanpbShowExpandButtonAlways()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJ_DCommandBars
  • BooleanpbLargeIcons()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJ_DCommandBars
  • BooleanpbSyncFloatingToolbars()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJ_DCommandBars
  • BooleanpbFloatToolbarsByDoubleClick()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJ_DCommandBars
  • BooleanpbShowTextBelowIcons()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJ_DCommandBars
  • BooleanpbAltDragCustomization()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJ_DCommandBars
  • BooleanpbOfficeStyleDisabledIcons()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJ_DCommandBars
  • BooleanpbIconsWithShadow()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJ_DCommandBars
    • IntegerhoTimer
  • BooleanpbTimerUpdate()
    • BooleanbValue
  • HandleCommandBarSystemObject()
    returns the CommandBars object handle, which is this object. All menu objects within a command bar will get this via delegation. The exception is context menus (and children of context menus) which uses the global commandbars variable instead.
  • HandleActionsCollection()
    these are here to make life easier. These return a df-object attached to the following collecions and child objects. These are used enough that an easy access to them was provided.
    • IntegerhoPrivate
    • VariantvCom
  • HandleDesignerControlsCollection()
    • IntegerhoPrivate
    • VariantvCom
  • HandleKeyBindingsCollection()
    • IntegerhoPrivate
    • VariantvCom
  • HandleOptionsObject()
    • IntegerhoPrivate
    • VariantvCom
  • ReleaseComObject()
    when a commandbars is deactivated, this is called. save layout as needed release all of the action objects in the various arrays make sure that all DF objects are released. One oddity is that at this point the object is deactivated and this causes the statubar's visibleState to always be false. We correct for this in the statusbar's pbVisible
    • Integer[]hoObjects
    • Integer[]hoEmpty
    • IntegerhoTimer
    • IntegerhoObj
    • Integeri
    • IntegeriCount
    • VariantvTab
  • CreateCommandBars()
    This sets all of the commandbars properties and the options properties
    • IntegerhWND
    • IntegerhoClient
    • IntegerhoMain
    • IntegerhoOptions
    • IntegerhoImageManager
    • IntegerhoCommandBar
    • IntegerhoTimer
    • VariantvToolbarObject
    • VariantvImageManager
    • IntegereVisualTheme
    • IntegereAnimation
    • IntegeriLast
    • BooleanbMDIMEnu
    • BooleanbEnableCustomization
    • BooleanbAltDragCustomization
    • BooleanbLargeIcons
    • BooleanbShowTextBelowIcons
    • BooleanbAlwaysShowFullMenus
    • BooleanbShowFullAfterDelay
    • BooleanbToolBarScreenTips
    • BooleanbToolBarAccelTips
    • BooleanbShowPopupBarToolTips
    • BooleanbAutoHideUnusedPopups
    • BooleanbOfficeStyleDisabledIcons
    • BooleanbFloatToolbarsByDoubleClick
    • BooleanbSyncFloatingToolbars
    • BooleanbShowExpandButtonAlways
    • BooleanbIconsWithShadow
    • BooleanbTimer
  • Update()
    Perform an Update. This can be called manually or via the timer it send update to the Statusbar and to all active actions
    • Integer[]hoActions
    • IntegerhoStatusBar
    • Integeri
    • IntegeriActions
    • VariantvAction
  • UpdateAllActions()
    • Integer[]hoActions
    • Integeri
    • IntegeriActions
    • VariantvAction
  • IntegerLastAssignedId()
    • Integer[]iActionIdPool
    • IntegeriId
    • IntegeriCount
  • IntegerAssignID()
    auto assign an Id. Callend in end_construct_object if needed
    • Integer[]iActionIdPool
    • IntegeriId
    • IntegeriCount
  • ReleaseID(Integer iId)
    might be needed to maintain a pool of actions
    • Integer[]iActionIdPool
    • IntegeriCount
    • IntegeriIndex
  • IntegerAssignBarId()
    • IntegeriId
  • AddActiveAction(Handle hoAction)
    • Integer[]hoActiveActions
  • RegisterAction(Handle hoAction)
    • BooleanbActive
    • Integer[]hoActions
  • RemoveActiveAction(Handle hoAction)
    remove action from list of active actions.
    • Integer[]hoActiveActions
    • IntegeriIndex
    • Integeri
    • IntegeriCount
  • RemoveRegisteredAction(Handle hoAction)
    remove action from list of registered actions.
    • Integer[]hoActiveActions
    • BooleanbActive
    • IntegeriIndex
    • Integeri
    • IntegeriCount
  • IntegerAddImageType(Boolean bIsIcon String sImage Integer iId Integer eImageType)
    Adds an image to imagelist. Pass if bmp or icon, the image name and the Id and image type (normal, disabled, etc.) With Bitmaps this will first look for the resource then search for the file in the file path. With Icons it checks for the file first (explained below) return Image Id if success
    • IntegerhBitmap
    • VariantvImageManager
    • IntegerhoImageIcons
    • IntegeriVoid
    • BooleanbOk
    • StringsFileImage
  • IntegerAddImage(String sImage Integer iId Integer eImageType)
    Adds an image to imagelist. We assume that this is an icon unless the .bmp extension is passed. return True if success
    • BooleanbIsIcon
  • HandleCreateStateOptions(Integer eLayout)
    Create a StateOptions object and set it as needed. This is used to save and load settings. You could augment this to customize as needed.
    • IntegerhoStateOptions
    • VariantvStateOptions
  • HandleCreatePropExchangeObject()
    • IntegerhoPropExchange
    • IntegerhoGlobal
    • VariantvPropExchange
    • VariantvGlobal
  • ExchangeLayout(Handle hoExchange String sSection Integer eLayout)
    exchange the current commandbar layout with the prop exchange object. pass the exchange object and the section name to save this under. The exchange object contains information if this is a save or load (ComLoading). can be called by any exchange object allowing developers to save a commandbar structure as part of other information they may be saving and loading
    • VariantvSection
    • VariantvOptions
    • IntegerhoExchangePref
    • IntegerhoStatusBar
    • IntegerhoStateOptions
    • IntegeriLast
    • IntegeriLastBar
    • IntegeriStatusBarVisible
    • IntegeriBuild
    • IntegeriIDBuild
    • IntegeriIDCount
    • IntegeriIDBarCount
    • BooleanbLoad
    • BooleanbSerializeControls
  • BooleanLoadLayoutFromRegistry(Integer eLayout String sKey)
    saves and loads commands info to the registry. While this is private. It provides a good model for how to do this kind of thing.
    • IntegerhoExchange
    • BooleanbOk
    • StringsSection
    • StringsFullKey
  • SaveLayoutToRegistry(Integer eLayout String sKey)
    • IntegerhoExchange
    • IntegerhoRegistry
    • BooleanbOk
    • BooleanbExists
    • BooleanbVoid
    • StringsSection
    • StringsFullKey
    • StringsShortKey
  • BooleanLoadLayoutFromXML(Integer eLayout String sFileName)
    • IntegerhoExchange
    • StringsSection
    • BooleanbOk
  • SaveLayoutToXML(Integer eLayout String sFileName)
    • IntegerhoExchange
    • StringsSection
    • BooleanbOk
  • SaveEnvironment()
    Standard SaveEnvironment Behavior. This is called when the commandbar system is closed. It will save environment if: 1) application Object exists and pbPreserveEnvironment is true 2) peRestoreLayout is not rlNoSaveRestore This is good for augmentation if you wish to change the standard save
    • IntegereLayout
    • StringsKey
    • BooleanbPreserveEnvironment
  • LoadEnvironment()
    Standard LoadEnvironment Behavior. This is called when the commandbar system is created. It will load environment if: 1) application Object exists and pbPreserveEnvironment is true 2) peRestoreLayout is not rlNoSaveRestore This is good for augmentation if you wish to change the standard load.
    • IntegereLayout
    • StringsKey
    • BooleanbOk
    • BooleanbPreserveEnvironment
  • RestoreLayout()
    • VariantvToolBarObject
  • DockNextTo(Variant vBarToDock Variant vBarOnLeft)
    used to dock a commandbar, on the same row and to the right of another commandbar used by pbDockNextTo property in toolbars
    • IntegeriLeft
    • IntegeriTop
    • IntegeriRight
    • IntegeriBottom
    • IntegeriPosition
    • IntegerhoBarOnLeft
  • BooleanIs_Function(Integer iMsgId Integer hoObjId Boolean bDelegateFg)
    This only works if this command bar is placed inside of BasicPanel or if the command bar is in a modal dialog that is placed inside of a Panel
    • BooleanbOk
    • IntegerhoMain
  • BooleanDEOInformation(Handle ByRef hoServer Boolean ByRef bHasRecord Boolean ByRef bChanged Boolean ByRef bHasIndex)
    returns information about the Focus object. If it returns True its a DEO. If a DEO the server, hasRecord, changed and hasindex info will all be returned by ref. If false, these are all unchanged.
    • IntegerhoFocus
    • BooleanbISDeo
    • BooleanbIsControl
    • IntegeriFile
    • IntegeriField
  • ControlsInControl(Integer iId Handle hoControl Variant[] ByRef ArrayOfvControls)
    Find all controls within this control with the passed Id.
    • VariantvCommandBar
    • IntegerhoCommandBar
    • IntegereType
  • ControlsInCommandBar(Integer iId Handle hoCommandBar Variant[] ByRef ArrayOfvControls)
    Find all controls within this commandbar with the passed Id.
    • VariantvNewControl
    • VariantvNewControls
    • IntegerhoNewControl
    • IntegerhoNewControls
    • IntegeriControls
    • Integeri
    • IntegeriNewId
  • Variant[]FindControls(Integer iId)
    Find all controls within the commandbarsystem with the passed Id. This can be used to search for Ids within a popup menu item. You only need to use this is there is a chance that there will be more than one control with this id.
    • Variant[]ArrayOfvControls
    • VariantvCommandBar
    • IntegeriCommandBars
    • Integeri
    • IntegerhoCommandBar
  • PopupInit(Handle hoCommandBar Handle hoCommandBarControls)
    this sends update to the action of all of the child menu items. Note these are the children of visual control, not the children of the action. This is used to enable, disable all menu items, etc.
    • IntegerhoControl
    • IntegerhoAction
    • IntegerhoItem
    • VariantvAction
    • VariantvControl
    • Integeri
    • IntegeriCount
  • OnCreate()
    Inherited from cComActiveXControl
    make this private. Use OnCreateCommandBars for custom event
  • OnCreateCommandBars()
  • OnRelease()
  • OnUpdate()
  • OnComExecute(Variant llControl)
    Inherited from cCJ_DCommandBarsEvents
    • IntegerhoControl
    • IntegerhoAction
    • IntegerhoActionPointer
    • VariantvAction
  • OnUnhandledExecute(Variant llControl)
    this happens when the execute control either has no COM action or it has no DF action object. In such a case, we don't do anything other than call this method. Note that there may be a valid action but fo rsome reason the ComAction property did not get properly assigned by CJ. This seems to happen with the color selector object.
  • OnComControlSelected(Variant llControl)
    Inherited from cCJ_DCommandBarsEvents
    • IntegerhoControl
    • IntegerhoAction
    • IntegerhoActionPointer
    • VariantvAction
  • OnUnhandledControlSelected(Variant llControl)
  • OnComInitCommandsPopup(Variant llCommandBar)
    Inherited from cCJ_DCommandBarsEvents
    • IntegerhoCommandBar
    • IntegerhoAction
    • IntegerhoActionPointer
    • IntegerhoCommandBarControl
    • IntegerhoCommandBarControls
    • VariantvAction
    • VariantvCommandBarControl
    • VariantvCommandBarControls
    • IntegereType
  • OnUnhandledInitCommandsPopup(Variant llCommandBar)
  • OnComCustomization(Variant vCustomizeOptions)
    Inherited from cCJ_DCommandBarsEvents
    • IntegerhoCustomize
    • BooleanbShowKeyboardPage
    • BooleanbShowOptionsPage
• cCJCommandBarMixin : Mixin
  • Define_cCJCommandBarMixin()
    • IntegerpiBarID
    • BooleanpbDockNextTo
    • IntegerpeBarPosition
    • BooleanpbEnableDocking
    • BooleanpbHideWrap
    • IntegerpeStretched
    • BooleanpbPrivateCloseable
    • BooleanpbPrivateCustomizable
    • BooleanpbPrivateEnableAnimation
    • BooleanpbPrivateShowExpandButton
    • StringpsPrivateTitle
    • BooleanpbPrivateVisible
    • IntegerpiPrivateWidth
    • BooleanpbPrivateGripper
  • SetComProperty(Handle hmPrivateProperty Handle hmCOMProperty Integer iValue)
    Generic Get and Set property that is used to get and set a DF/COM property. can be used by any integer or boolean property
  • IntegerGetComProperty(Handle hmPrivateProperty Handle hmCOMProperty)
    • IntegeriValue
  • Set(Boolean bValue)
  • BooleanpbCloseable()
    • BooleanbValue
  • Set(Boolean bValue)
  • BooleanpbCustomizable()
    • BooleanbValue
  • Set(Boolean bValue)
  • BooleanpbEnableAnimation()
    • BooleanbValue
  • Set(Boolean bValue)
  • BooleanpbShowExpandButton()
    • BooleanbValue
  • Set(Boolean bValue)
  • BooleanpbVisible()
    • BooleanbValue
  • Set(Integer iValue)
  • IntegerpiWidth()
    • IntegeriValue
  • Set(Boolean bValue)
  • BooleanpbGripper()
    • BooleanbValue
  • Set(String sValue)
  • StringpsTitle()
    • StringsValue
  • InitComInstance()
    This may not be needed if we can treat commandbar objects as static // use this to find the Commandbar COM control and attach this object to it. // If a COM object cannot be found, this is an error and and error is declared. Procedure AttachComObject Handle hoCommandBars Variant vCommandBar Integer iBarId i iBars iComBarId Get CommandBarSystemObject to hoCommandBars Get piBarID to iBarId Get ComCount of hoCommandBars to iBars For i from 1 to iBars Get ComItem of hoCommandBars i to vCommandBar Set pvComObject to vCommandBar Get ComBarID to iComBarId If (iBarId=iComBarId) Begin Procedure_Return End Loop Send ReleaseComObject Error DFERR_PROGRAM "Assert: AttachComObject failed to attach commandbar" End_Procedure
    • IntegerhoCommandBars
    • IntegerhoNextTo
    • VariantvCommandBar
    • VariantvNextTo
    • StringsTitle
    • IntegeriBarId
    • IntegeriWidth
    • IntegeriDockFgs
    • IntegeriBars
    • IntegereBarPosition
    • IntegereNextToPosition
    • IntegereNextToType
    • IntegeriDockingFlags
    • IntegereStretched
    • BooleanbCloseable
    • BooleanbCustomizable
    • BooleanbEnableAnimation
    • BooleanbShowExpandButton
    • BooleanbVisible
    • BooleanbEnableDocking
    • BooleanbHideWrap
    • BooleanbGripper
    • BooleanbDockNextTo
    • BooleanbNextToVisible
  • OnCreate()
    This is called when the commandbar is created and is bound to the commandbar object.
  • End_Construct_Object()
    • IntegeriID
    • IntegerhoCommandBars
• cCJAbstractCommandBar : cCJCommandBar
  • Construct_Object()
    Inherited from cCJCommandBar
  • VariantCreateCommandBar()
    Must be defined in a sub-class
  • CreateComInstance()
    • IntegerhoCommandBarControls
    • VariantvCommandBarControls
• cCJMenuBar : cCJAbstractCommandBar
  • Construct_object()
    Inherited from cCJAbstractCommandBar
  • VariantCreateCommandBar()
    Inherited from cCJAbstractCommandBar
    • VariantvCommandBar
    • IntegerhoCommandBars
    • IntegereBarPosition
• cCJToolbar : cCJAbstractCommandBar
  • VariantCreateCommandBar()
    Inherited from cCJAbstractCommandBar
    • VariantvCommandBar
    • IntegerhoCommandBars
    • IntegereBarPosition
• cCJTabToolBar : cCJComTabToolBar
  • Construct_Object()
    Inherited from cCJComTabToolBar
    • BooleanpbPrivateAllowReorder
  • Set(Boolean bValue)
    Inherited from cCJCommandBarMixin
  • BooleanpbAllowReorder()
    • BooleanbValue
  • VariantCreateCommandBar()
    • VariantvCommandBar
    • IntegerhoCommandBars
  • CreateComInstance()
    • IntegerhoCommandBarControls
    • VariantvCommandBarControls
    • BooleanbAllowReorder
  • VariantFindByCategory(String sName)
    • BooleanbAttached
    • BooleanbOk
    • IntegerhoItem
    • VariantvItem
    • Integeri
    • IntegeriCount
    • StringsCat
• cCJTabControlItem : cCJComTabControlItem
  • Construct_Object()
    Inherited from cCJComTabControlItem
    • StringpsCategory
    • StringpsToolTip
    • StringpsImage
  • CreateComInstance(Handle hoTabToolBar)
    This may not be needed if we can treat commandbar objects as static // attach this object to its appropriate COM object. Procedure AttachComObject Variant vCat String sName Get psCategory to sName Delegate Get FindByCategory sName to vCat If (IsNullComObject(vCat)) Begin Error DFERR_PROGRAM "Assert: AttachComObject failed to attach tabcontrolitem" End Else Begin Set pvComObject to vCat End End_Procedure
    • IntegerhoCommandBars
    • IntegerhoCommandBarControls
    • IntegerhoControl
    • VariantvCommandBarControls
    • VariantvTab
    • VariantvControl
    • StringsCategory
    • StringsTip
    • StringsImage
    • IntegeriCount
    • Integeri
    • IntegeriNewCount
    • IntegeriId
    • BooleanbOk
  • OnCreate()
• cCJContextMenu : cCJCommandBar
  • Construct_Object()
    Inherited from cCJCommandBar
    • BooleanpbEnableAnimation
    • BooleanpbControlDoubleGripper
    • BooleanpbControlPopupToolBar
    • HandlephoCommandBars
  • HandleCommandBarSystemObject()
    context menus use a differnt logic for finding the commandbars. Normally it will just attach to the global commandbars. However, a developer can choose attach this to a different commandbars by setting phoCommandBars.
    • IntegerhoCommandBars
  • VariantCreateCommandBar()
    • VariantvCommandBar
    • IntegerhoCommandBars
  • CreatePopupComInstance()
    • IntegerhoCommandBars
    • IntegerhoCommandBarControls
    • VariantvCommandBar
    • VariantvCommandBarControls
    • BooleanbEnableAnimation
    • BooleanbDoubleGripper
    • BooleanbPopupToolBar
  • Popup()
    • IntegerhoCommandBars
    • IntegeriLoc
    • IntegeriId
    • IntegeriRet
    • tWinPointPt
  • OnCreate()
  • OnPopupInit(Variant vCommandBarControl Handle hoCommandBarControls)
    before called, self and all items IsEnabled, IsChecked and IsVisible are called the first param is of no interest as it is this object which is already attached
• cCJDesignerMenu : cObject
  used for the Customize dialog This provides a way to add controls to the config menu that are not defined elsewhere in the menu
  • Construct_Object()
  • CreateComInstance()
    Get the Controls Collection for the designer and call all children
    • IntegerhoCommandBarControls
• cCJAction : cCJCommandBarAction
  This creates an action object. It will normally not be directly instanciated but will be used as the superclass of the cCJMenuItem class.
  • Construct_Object()
    Inherited from cCJCommandBarAction
    • IntegerpiId
      normally auto assigned. It can be manually assigned.
    • BooleanpbPrivateActiveUpdate
      determins if this action should be updated by the timer. You only set this true if the checked state, enabled state or visible state will be changed by other actions within the program.
    • BooleanpbPrivateChecked
    • BooleanpbPrivateEnabled
    • BooleanpbPrivateVisible
    • StringpsPrivateCaption
    • StringpsPrivateCategory
    • StringpsPrivateDescriptionText
    • StringpsPrivateTooltipText
    • StringpsPrivateShortcutText
    • IntegerpiPrivateShortCutKey
    • StringpsImage
      These are just initial values, if the developer needs to dynamically change images they should use the ComIconId to select the item they need from the image list normally only psImage needs to be set
    • StringpsImageDisabled
    • StringpsImageHot
    • StringpsImageChecked
    • StringpsImagePressed
    • IntegerpiPrivateIconId
  • Set(Boolean bValue)
    Inherited from cCJICommandBarAction
  • BooleanpbChecked()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJICommandBarAction
  • BooleanpbEnabled()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJICommandBarAction
  • BooleanpbVisible()
    • BooleanbValue
  • Set(String sValue)
    Inherited from cCJICommandBarAction
  • StringpsCaption()
    • StringsValue
  • Set(String sValue)
    Inherited from cCJICommandBarAction
  • StringpsCategory()
    • StringsValue
  • Set(String sValue)
    Inherited from cCJICommandBarAction
  • StringpsDescription()
    • StringsValue
  • Set(String sValue)
    Inherited from cCJICommandBarAction
  • StringpsToolTip()
    • StringsValue
  • Set(String sValue)
    Inherited from cCJICommandBarAction
  • StringpsShortcut()
    • StringsValue
  • Set(Integer iExtra Integer iKey)
    Inherited from cCJICommandBarAction
  • IntegerpiShortCutKey()
    • IntegeriValue
  • BindKey(Integer iExtra Integer iKey)
    • IntegeriId
    • IntegerhoKeyBindings
    • IntegerhoCommandBars
  • Set(Boolean bValue)
    Inherited from cCJICommandBarAction
    • IntegerhoCommandBars
  • IntegerpbActiveUpdate()
    • BooleanbValue
  • Set(Integer iValue)
    Inherited from cCJICommandBarAction
    normally this is zero and not changed. When zero the imageId used will be the statusbarId and this is the ID that is used when the psImage method is used. Using psImage is preferred as it adds the icon and assigns it to the object. This can be used to change icons. Note 0=use StatusbarId
  • IntegerpiIconId()
    • IntegeriValue
  • BooleanIsVisible()
    For augmentation. Return true if the item should be visible
    • BooleanbBool
  • BooleanIsEnabled()
    For augmentation. Return true if the item should be enabled
    • BooleanbBool
  • BooleanIsChecked()
    For augmentation. Return true if the item should be checked
    • BooleanbBool
  • CreateComAction()
    • VariantvID
    • VariantvAction
    • IntegerhoCommandBars
    • IntegerhoActions
    • Integer[]hoActiveActions
    • StringsCaption
    • StringsToolTip
    • StringsDescriptionText
    • StringsCategory
    • StringsShortCutText
    • StringsIcon
    • StringsIconDisabled
    • StringsIconHot
    • StringsIconChecked
    • StringsIconPressed
    • IntegeriId
    • IntegeriShortCut
    • IntegeriIconId
    • IntegeriAssignedId
    • BooleanbVisible
    • BooleanbChecked
    • BooleanbEnabled
    • BooleanbOk
  • CreateComInstance()
    called during initial activation to set all default actions.
  • VariantFindFirstControl()
    find the first control that matches this action's ID. This searches the entire commandbar system and "first" is just the first one it happens to find.
    • VariantvControl
    • IntegeriId
    • IntegerhoCommandBars
    • IntegerhoCommandBar
  • DeleteAllControlsForAction()
    delete all com controls for this action
    • IntegerhoCommandBars
    • IntegerhoControl
    • VariantvControl
  • Variant[]FindAllControls()
    find all controls owned by this action anywhere in the commandbar system returns a variant array. This is only needed if you expect that there will be multiple hits such as could happen if you allow end user editing. This was created because there is no COM message to do this. This is pretty low level (like ComFindControl) and will not be used much.
    • Variant[]ArrayofvControls
    • IntegeriId
    • IntegerhoCommandBars
  • IntegerClassForControlType(Integer eType)
    Return the class for the passed control type. Good for augmentation
    • IntegeriClass
  • HandleCreateProxyControl(Variant vControl)
    Creates a DF object of the proper type and binds it to the COM object.
    • IntegerhoObj
    • IntegereType
    • IntegeriClass
  • HandleCreateFirstProxyControl()
    use this to find the COM control and return a DF object. You must call this if you don't already have the control pointer. You should only call this if you know that there will only be one control attached to the action. Make no assumption about what "First" means. It's the first one the COM control finds.
    • VariantvControl
    • IntegerhoControl
  • Destroy()
    when a manual destroy is sent we need to do some cleanup. If an active action, it must be removed from the active action array All menu controls for this action will be removed, wherever they are within the system The Action Id will be added back to the pool for reuse. This is needed because the com action is not destroyed (there is no interface for this).
    • IntegerhoCommandBars
    • IntegeriId
    • VariantvControl
  • ReleaseComObject()
    if the action is being released we must remove it from the action pool. This is needed for context menus which whose actions get created and released with each invocation. This will also happen when an object is destroyed. If the com object is created, destroy will send ReleaseComObject
    • IntegeriId
    • IntegerhoCommandBars
  • Execute(Variant vCommandBarControl)
    called when this action is selected. Only send OnExecute if the action is enabled.
    • BooleanbIsEnabled
    • VariantvObject
  • Update()
    Updates the action. Can be called by timer when active update or called when a menu pops up
  • OnUpdate()
    Event called to update the action
  • OnExecute(Variant vCommandBarControl)
    before this is called IsEnabled is called
  • OnSelected(Variant vCommandBarControl)
    when hover over
  • OnCreateAction()
    creation of action.
  • OnPopupInit(Variant vCommandBarControl Handle hoCommandBarControls)
    before called, self and all items IsEnabled, IsChecked and IsVisible are called
  • End_Construct_Object()
    • IntegeriID
    • IntegerhoCommandBars
• cCJMenuItem : cCJAction
  can be used by all controls. Menu, toolbar and popups.
  • Construct_Object()
    Inherited from cCJAction
    • IntegerpeControlType
      note that these properties are design time and initalize time only properties
    • IntegerpeControlStyle
    • BooleanpbControlBeginGroup
    • BooleanpbControlCloseSubMenu
    • BooleanpbControlFlagRightAlign
    • BooleanpbControlFlagLeftPopup
    • BooleanpbControlFlagNoMovable
    • BooleanpbControlFlagControlStretched
    • BooleanpbControlFlagShowPopupBarToolTip
    • BooleanpbControlFlagWrapRow
    • BooleanpbControlDoubleGripper
    • BooleanpbControlPopupToolBar
    • BooleanpbAddToDesignerMenu
    • IntegerphoAction
      Used to redirect an action to a different object.
    • BooleanpbInCreateTempInstance
  • BooleanIsPopup()
    returns true if the control is a popup type - i.e., it will have child menu items. Good for Augmentation
    • IntegereType
  • CreateComInstance(Handle hoControls)
    Inherited from cCJAction
    must create action and then the visual control
    • VariantvNewControl
    • VariantvNewControls
    • VariantvCommandBar
    • IntegerhoNewControl
    • IntegerhoNewControls
    • IntegerhoCommandBar
    • IntegerhoAction
    • IntegerhoDesignerControls
    • IntegeriId
    • BooleanbPopup
  • AssignAction()
    handle action for this menu-item. If the item is the action, make sure a com instance is created if this is not the action, attach to the action which should be created lots of assertions if there is a problem
    • IntegerhoAction
    • IntegeriId
  • VariantAddDynamicControl(Handle hoControls)
    • VariantvNewControl
    • VariantvCommandBar
    • VariantvNewControls
    • BooleanbOldTemp
    • BooleanbPopup
    • IntegerhoNewControl
    • IntegerhoCommandBar
    • IntegerhoNewControls
  • VariantCreateCommandBarControl(Handle hoControls Integer eType Integer iId Boolean bInCreateTempInstance)
    used to actually create the desired control and add it to the passed commandbars
    • VariantvControl
  • VariantCreateComControl(Handle hoControls)
    create the menu item control. Return a DataFlex object for this control This assumes that an action ID exiss and that a com action object is created.
    • IntegerhoObj
    • IntegerhoCommandBar
    • IntegerhoCommandBars
    • VariantvControl
    • VariantvCommandbar
    • IntegeriId
    • IntegereType
    • IntegereStyle
    • IntegereFlags
    • IntegeriClass
    • BooleanbPopup
    • BooleanbBegin
    • BooleanbClose
    • BooleanbDoubleGripper
    • BooleanbPopupToolBar
    • BooleanbFlagStretch
    • BooleanbFlagLeftPopup
    • BooleanbFlagNoMove
    • BooleanbFlagRightAlign
    • BooleanbFlagShowTip
    • BooleanbFlagWrap
    • BooleanbInCreateTempInstance
  • OnCreateControl(Handle hoObj)
• cCJStatusBar : cCJComStatusBar
  • Construct_Object()
    Inherited from cCJComStatusBar
    • BooleanbMDI
    • IntegerhoCommandBars
    • BooleanpbPrivateDrawDisabledText
    • StringpsPrivateIdleText
    • BooleanpbPrivateVisible
    • IntegerpiStatusBarId
    • IntegerphoViewPane
  • Set(Boolean bValue)
    Inherited from cCJIStatusBar
  • BooleanpbDrawDisabledText()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJIStatusBar
  • BooleanpbVisible()
    • BooleanbValue
  • Set(String sValue)
    Inherited from cCJIStatusBar
  • StringpsIdleText()
    • StringsValue
  • CreateComInstance()
    • IntegerhoCommandBars
    • VariantvStatusBar
    • StringsTitle
    • IntegeriBarId
    • IntegeriWidth
    • IntegeriDockFgs
    • BooleanbDrawDisabledText
    • BooleanbVisible
    • BooleanbMDI
    • StringsIdleText
  • Show_Status_Help(String sStatusHelp)
    display "main" status help. Usually provided from DD.
  • Show_View_Name(String sName)
    show the view name in the pane if a phoViewPane exists
    • IntegerhoPane
  • Exit_Menu()
    legacy from old status bar
  • Handle[]PaneObjects()
    returns an array of all pane objects (these are the DF objects, if additional COM panes were created they are not here)
    • Integer[]hoPanes
  • HandleFindPaneObject(Variant vPane)
    Find the DF object for the passed COM object. Returns 0 if none found
    • IntegerhoPane
    • Integer[]hoPanes
    • Integeri
    • IntegeriPanes
    • IntegeriId
  • IntegerPaneTextWidth(String sText)
    this returns the width, in pixels, needed to display a string.
    • IntegerhWnd
    • IntegerhDC
    • Integercx
    • IntegerbOK
    • IntegerlpsText
    • IntegerlpsPoint
    • StringsPoint
  • Update()
  • OnUpdate()
  • OnCreate()
  • OnComPaneClick(Variant llPane)
    Inherited from cCJIStatusBarEvents
    • IntegerhoPane
  • OnComPaneDblClick(Variant llPane)
    Inherited from cCJIStatusBarEvents
    • IntegerhoPane
• cCJStatusBarPane : cCJComStatusBarPane
  • Construct_Object()
    Inherited from cComAutomationObject
    • IntegerpePrivateAlignment
    • IntegerpiPrivateBackGroundColor
    • IntegerpiPrivateTextColor
    • StringpsPrivateText
    • StringpsPrivateTooltip
    • BooleanpbPrivateVisible
    • IntegerpiPrivateWidth
    • IntegerpbPrivateStyleNoBorders
    • IntegerpbPrivateStyleDisabled
    • IntegerpbPrivateStyleStretch
    • IntegerpiPrivateIconId
    • StringpsImage
    • IntegerpiId
  • Set(Boolean bValue)
    Inherited from cCJComStatusBarPane
  • BooleanpbVisible()
    • BooleanbValue
  • Set(Integer iValue)
    Inherited from cCJComStatusBarPane
  • IntegerpiBackgroundColor()
    • IntegeriValue
  • Set(Integer iValue)
    Inherited from cCJComStatusBarPane
  • IntegerpiTextColor()
    • IntegeriValue
  • Set(Integer iValue)
    Inherited from cCJComStatusBarPane
  • IntegerpiWidth()
    • IntegeriValue
  • Set(Integer eValue)
    Inherited from cCJComStatusBarPane
  • IntegerpeAlignment()
    • IntegereValue
  • SetPaneStyle(Integer iMask Boolean bValue Handle hmMessage)
    • IntegereValue
  • BooleanGetPaneStyle(Integer iMask Handle hmMessage)
    • IntegereValue
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJComStatusBarPane
  • BooleanpbStyleNoBorders()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJComStatusBarPane
  • BooleanpbStyleDisabled()
    • BooleanbValue
  • Set(Boolean bValue)
    Inherited from cCJComStatusBarPane
  • BooleanpbStyleStretch()
    • BooleanbValue
  • Set(String sValue)
    Inherited from cCJComStatusBarPane
  • StringpsText()
    • StringsValue
  • Set(String sValue)
    Inherited from cCJComStatusBarPane
  • StringpsToolTip()
    • StringsValue
  • Set(Integer iValue)
    Inherited from cCJComStatusBarPane
    normally this is zero and not changed. When zero the imageId used will be the statusbarId and this is the ID that is used when the psImage method is used. Using psImage is preferred as it adds the icon and assigns it to the object. This can be used to change icons. Note 0=use StatusbarId
  • IntegerpiIconId()
    • IntegeriValue
  • CreateComInstance(Handle hoStatusBar)
    • VariantvStatusBarPane
    • StringsImage
    • StringsText
    • StringsToolTip
    • IntegeriWidth
    • IntegereAlignment
    • IntegereStyle
    • IntegeriBackGroundColor
    • IntegeriTextColor
    • IntegeriId
    • IntegeriIconId
    • IntegeriNewIconid
    • BooleanbVisible
    • BooleanbOk
    • BooleanbStyleStretch
    • BooleanbStyleDisabled
    • BooleanbStyleNoBorders
    • IntegerhoCommandBars
  • RegisterStatusPaneObject(Handle[] ByRef hoPanes)
  • IntegerAssignStatusBarID()
    auto assign an Id for the status bar. Called in end_construct_object if needed
    • IntegeriId
  • OnCreate()
  • OnClick()
  • OnDblClick()
  • End_Construct_Object()
    • IntegeriID

References (9):

Field References (0):