Professional User Interface Suite, Copyright FOSS Software Inc. Help Published with Permission.

Properties

m_bEnableIconOptionsForIconlessCommands Turns on the icon customization features in the customize mode for commands without icons if it is true; does not allow icon customization otherwise. The default value is false.

Classes

~CExtCustomizeSite Destructor.
BarIsRegistered Returns true if the toolbar is registered as customizable.
BarReset Resets toolbar buttons and returns true if the operation completed successfully.
BarResetAsk Displays a message box with "Reset changes made to TOOLBAR-NAME toolbar?" and returns true if YES-button has been pressed.
BuildToolbarLists Fills lists of toolbar objects.
CancelCustomization Cancels the customize mode.
CategoryAppendAllCommands Adds the standard "All commands" category that contains all the commands registered in Command Manager.
CategoryAppendNewMenu Adds the standard "New Menu" category.
CategoryGetCount Retrieves the number of registered categories.
CategoryGetTreeAt Returns the command tree node which holds all the command items of a registered category by the specified index. Returns NULL if the nPos parameter is not valid.
CategoryGetTreeByName Returns the command tree node which holds all the command items of a registered category. Returns NULL if there is no category with the strCategoryName name.
CategoryMakeAllCmdsUnique Removes non-unique commands from all the registered categories.
CategoryMakeCmdsUnique Removes non-unique commands from the specified category.
CategoryMakeFromTree Inserts a new command category based on the specified command tree.
CategoryMakeFromTreeN Inserts new command categories based on the first level of the specified command tree.
CategoryRemove Removes a category.
CategoryRemoveAll Removes all the categories.
CategoryUpdate Registers a command category and adds commands out of the menu into it.
CExtCustomizeSite Constructor.
CustomizedNodeGet Returns a pointer to the command tree node which is currently customized or NULL if there is no customized node. The customized node is the command tree node which currently displays its context menu or the Button Editor dialog in the customize mode.
CustomizedNodeSet Sets/resets a new customized node and returns the flag indicating whether the operation succeded. The method should be called only when the Customize dialog is visible. The customized node is the command tree node which currently displays its context menu or the Button Editor dialog in the customize mode.
CustomizeStateLoad Loads the customizable UI state from the Windows registry, creates user-defined toolbars, and applies user-edited icons and styles to the corresponding UI command items.
CustomizeStateSave Saves the customizable UI state to the Windows registry.
CustomizeStateSerialize Serializes the customizable UI state.
DeleteAllUserBars Destroys all the user-defined bars.
DoDragCmdNode Performs drag-n-dropping for the command tree node specified with pNodeC. Returns a flag indicating whether the operation succeeded and the result is not empty (i.e. the OLE-returned code is not equal to DROPEFFECT_NONE). If customization is enabled without the __ECSF_COMMANDS flag set to on, the method immediately returns true.
DoFormCustomization Invokes the customize mode, displays the customization form and performs the message loop. Returns true if succeeded.
DraggedNodeGet Returns a pointer to the command tree node which is currently dragged by the user or NULL if there is no drag-n-drop operation performed at the moment.
DraggedNodeSet Sets/resets a pointer to the dragged node.
EnableCustomization Initializes the customization subsystem for all toolbars and menus in the specified window.
GetCustomizeFlags Returns the customization flags that are specified when calling the CExtCustomizeSite::EnableCustomization() method (i.e. the __ECSF_ constants).
GetCustomizeSite Searches the customize site for the specified window and returns the corresponding pointer or NULL.
GetCustomizeTopWnd Returns a pointer to the top customizable CWnd object or NULL if customization is not enabled at this site object.
GetSafeCustomizeFormHWND Returns a window handle of the displayed customize form in the customize mode. Returns NULL in other cases.
GetToolbarCmdNode Returns a pointer to the command tree node which describes toolbar buttons.
GetToolbarCustomizeInfo Retrieves customization information for the toolbar.
GetUserBar Returns a user-defined toolbar object by its dialog control identifier. Returns NULL if the specifed dialog control identifier is not a show/hide command of a user-defined toolbar or not registered in the command manager.
IsCustomizationInabled Returns true if CExtCustomizeSite::EnableCustomization() was called with non-zero customization flags.
IsCustomizeMode Returns true if the customization subsystem displays the customize form.
IsUserBarCommand Returns true if the command identifier is used as a show/hide command of the user-defined toolbar.
MenuInfoActiveGet Returns the object with menu information that is currently selected in the customization form. Method returns NULL if UI is not in the customize mode or there are no registered menus.
MenuInfoActiveSet Informs the customize site that a new document menu should be displayed in the menu bar.
MenuInfoAdd The method registers a menu in the object. All registered menus are used by the menu bar and listed in the combobox on the Toolbars page of the Customize dialog.
MenuInfoAddEmpty Registers an empty menu in the object. All registered menus are used by the menu bar and listed in the combobox on the Toolbars page of the Customize dialog.
MenuInfoFindForMenuBar Returns the registered object with menu information that should be currently used in menu bar. Returns NULL if there are no registered menus.
MenuInfoFindIndex Returns an index of the object with menu information or -1 if pCmdMenuInfoSearch does not specify a valid registered menu.
MenuInfoGetAt Returns a registered object with menu information specified with the nPos index. Returns NULL if nPos is not valid.
MenuInfoGetByName Returns a registered object with menu information by its name. Returns NULL if the registered menu with strName name does not exist.
MenuInfoGetCount Retrieves the number of registered menus.
MenuInfoGetDefault Returns the default object with menu information.
MenuInfoLoadAccelTable Uploads the accelerator table to the registered menu and returns true if the method succeeded.
MenuInfoRemove Removes registered objects with menu information and returns the number of removed items.
MenuInfoSetAccelTable Assigns the accelerator table to the registered menu and returns true if the method succeeded.
RedrawCommandItems Redraws all the visible specified with command identifier.
RegisterCommandDropTarget Registers the customizable window.
UnRegisterAllCommandDropTargets Unregisters all customizable windows, which were previously registered by calling CExtCustomizeSite::RegisterCommandDropTarget().
UnRegisterCommandDropTarget Unregisters the customizable window, which was previously registered by calling CExtCustomizeSite::RegisterCommandDropTarget().
UpdateAllCommandItems Invokes the MFC command update mechanism for all the customizable toolbars and menus.
UpdateCustomizationFormData Refreshes all the contents of the Customize dialog and returns true if succeeded.

Overridables

OnBarStateChanged Called when either the position or state of the control bar is changed.
OnCanDragCustomizeCommand Called by the customize site when it needs to know whether the drag-n-drop operation is enabled for the specified command.
OnCanInsertCommandToAllCommandsCategory Called by the customize site when it needs to know whether the specified command can be inserted into the All Commands category of the Commands list-box on the Commands page of the Customize dialog.
OnCanInsertCommandToAnyCategory Called by the customize site when it needs to know whether the specified command can be inserted into the All Commands category of the Commands list-box on the Commands page of the Customize dialog.
OnChangedToolbarIconSizeOption Called when the "Large icons in toolbars" option on the Options page of the Customize dialog has been changed.
OnChooseCmdKeyInfo Called by the customize site when it needs to select a key shortcut for displaying in the command tooltip. This method is called for the commands with more than one key shortcut. The method returns an index of the key shortcut in the key set.
OnCmdNodeCreate Called by the Prof-UIS framework to create a new instance of the CExtCustomizeCmdTreeNode class. The base command identifier is a unique identifier for a node. The effective command identifier is used in the WPARAM parameter of WM_COMMAND messages.
OnCmdNodeInserted Notifies the customize site that the command tree has been changed.
OnCmdNodeResizeH Called by the Prof-UIS framework to perform resizing of the text/combo-box field. After resizing this method modifies the rcItem parameter with coordinates of the new text field area. The method tracks the message loop while the user is resizing the text field. It returns true if the resizing operation completed successfully.
OnColorItemChanged Informs the customize site about changing the color in the color popup menu that is displayed for the pNode command. The method returns true if it explicitly changes the color value of the command or false if it did not handle the color change event.
OnColorItemCustom Notifies the customize site about clicking on the Custom button of the color selection popup menu. The method returns true if it explicitly changes the color value of the command or false if it did not handle the color change event.
OnColorItemGenerateIcon Called by the Prof-UIS framework to generate a new icon handle for the color selection command.
OnColorItemGetBtnTextCustom Called by the Prof-UIS framework to get the text of the Default button in the color selection popup menu. The method returns true if it sucessfully saves the text in the sBtnText parameter.
OnColorItemGetBtnTextDefault Called by the Prof-UIS framework to get the text of the Default button in the color selection popup menu. The method returns true if it sucessfully saves the text in the sBtnText parameter.
OnColorItemValueGet Called by the Prof-UIS framework to get the color value of the command. The method returns true if it sets a valid color value in the clr variable. The CExtCustomizeSite::OnColorItemValueGet() and CExtCustomizeSite::OnColorItemValueSet() virtual methods provide client programs that use Prof-UIS with a universal way of color selection for multiply copies of color selection commands in toolbars and menus.
OnColorItemValueSet Called by the Prof-UIS framework to get the color value of the command. The CExtCustomizeSite::OnColorItemValueGet() and CExtCustomizeSite::OnColorItemValueSet() virtual methods provide client programs that use Prof-UIS with a universal way of color selection for multiply copies of color selection commands in toolbars and menus.
OnCreateCustomizeForm Called by the customize site to create the Customize dialog. The method returns a window handle of the newly created dialog or NULL if dialog creation failed.
OnCreateToolbarButton Called by the Prof-UIS framework to create a new toolbar button object. The method returns a valid newly created CExtBarButton-like object. This method provides client projects using Prof-UIS with the ability to create toolbar buttons of any kind for particular commands.
OnCustomizeModeEnter Called by the Prof-UIS framework to inform the customize site about entering the customize mode. Default implementation disables views and child windows of resizable bars to prevent unwanted user actions during customization.
OnCustomizeModeLeave Called by the Prof-UIS framework to inform the customize site about leaving the customize mode. Default implementation enables all the windows that were disabled in CExtCustomizeSite::OnCustomizeModeEnter().
OnCustomizeTreeNode Called to track the context menu of the command tree node specified in pNodeC in the customize mode. The method does not return until the popup menu or Button Editor dialog is visible. The method returns true if pNodeC or any of its child nodes has been changed.
OnFormatCmdAccelText Called by the Prof-UIS framework to get the text representation of the key shortcut.
OnGetCmdItemMinMaxSizeH Called by the Prof-UIS framework to measure the min/max width of a text/combo-box field.
OnHookWndMsg Called by the customize site to hook messages of the top customizable window. The method returns true if it completely processes message. Default implementation of this method in CExtCustomizeSite is the important part of the Prof-UIS customization subsystem. Any overriden method should call the basic implementation.
OnInsertToolbarCmdNode Called by the Prof-UIS customization subsystem to insert a new button into the toolbar.
OnPopupListBoxCalcItemExtraSizes Called by the Prof-UIS framework to measure outer margins of the lisbox item. The method returns the CSize object in which the measured values are stored.
OnPopupListBoxGetStyles Called by the Prof-UIS framework to get the list-box window styles for the dropped-down list box of the combo-box like command. The method returns true if it successfully modifies the dwListBoxStyles parameter.
OnPopupListBoxInitContent Called by the Prof-UIS framework to initialize the list-box content.
OnPopupListBoxItemDraw Called by the Prof-UIS framework to paint a single item in the list-box. The method returns true if succeded.
OnPopupListBoxItemMeasure Called by the Prof-UIS framework to measure a list-box item. The method returns true if succeeded.
OnPopupListBoxMeasureTrackSize Called by the Prof-UIS framework to measure the total size of the popup list-box.
OnPopupListBoxSelChange Notifies the customize site about selecting the item in the dropped-down list box of the combo-box like command. The method returns true if succeeded.
OnPopupListBoxSelEndCancel Notifies customize site about canceling item selection in the dropped list box of the combo-box like command. The method returns true if it handled the event.
OnPopupListBoxSelEndOK Notifies the customize site about slecting the final l in the dropped-down list box of the combo-box like command. The method returns true if it handled the event.
OnPopupUndoRedoFormatCaption Called by the customize site to format the text displayed in the caption of the undo/redo pop-up list.
OnRegisterAdditionalToolBars Called by the customize site (during initialization) to register additional toolbars and customizable windows.
OnRegisterToolBar Called by the customize site (during initialization) to register the specified toolbar as a command drop target.
OnTextFieldCreateDropPopup Called by the Prof-UIS framework to create a popup menu object which is used to display a dropped-down window of the combo-box-like text field.
OnTextFieldInplaceTextGet Called by the Prof-UIS framework to get the text for editing in the in-place activated edit control.
OnTextFieldInplaceTextSet Called by the Prof-UIS framework to filter the text input in the text fields.
OnTextFieldVerify Called by the Prof-UIS framework to verify the text input in the in-place active editor of a text field/combo-box field command. The method returns true if sTextNew text can be displayed in the text field.
OnTextFieldWndProcHook Called by the Prof-UIS framework to hook messages of the in-place active edit control of the text/combo-box field. The method returns true if it successfully processed the message.
OnUpdateAccelGlobalInfo Performs synchronization between MFC internal accelerator tables and information on command key shortcuts stored in the customize site.
OnUserBarCreate Called by the customize site to create a new dynamic toolbar. The method returns a pointer to the toolbar object that subclasses a valid window. The method returns NULL in case of error.
OnUserBarDelete Called by the customize site to destroy a user-defined toolbar.
OnUserBarRename Called by the customize site to rename a user-defined toolbar.

See Also

CExtCustomizeSite Overview | Hierarchy Chart