11.6 Using SECShortcutBar

The following topics describe how you can use SECShortcutBar in your projects.

1. In the class for the parent window, instantiate an SECShortcutBar object. For example:

   SECShortcutBar m_scBar;

2. During the creation of the parent frame, call the SECShortcutBar::Create() method to create the shortcut bar window. For example:

   m_scBar.Create(this, WS_CHILD | WS_VISIBLE | SEC_OBS_VERT | SEC_OBS_ANIMATESCROLL, IDC_SHORTCUTBAR);

Call the overloaded AddBar() method, which accepts a CWnd parameter. For example:

m_scBar.AddBar( &m_tabWnd, _T("3D Tab Wnd") );

Derive a class from SECBar and then override the Draw() method. For example:

class MyBar : public SECBar { //Required if you want to use your own bar objects //without deriving a new class from SECShortcutBar TOOLKIT_DECLARE_DYNCREATE(MyBar) public: MyBar(); protected: virtual void Draw( CDC& dc ); }; //After creating the SECShortcutBar but before adding //any bar objects, add this line. m_wndShorcutBar.SetBarClass( RUNTIME_CLASS(MyBar) ); //If you don't want to use your new bar class //for all the bars, you could do this CRuntimeClass* pOrigBarClass = m_wndShortcutBar.GetBarClass(); m_wndShortcutBar.SetBarClass( RUNTIME_CLASS(MyBar) ); // //Add as many bars of your new class as you want // //Prepare to add standard bars m_wndShortcutBar.SetBarClass( pOrigBarClass ); // //Add standard bars

---

For an SECListBar derivative, the call to SetBarClass()in the above code should be replaced with a call to SetListBarClass().

---

Use the SEC_OBS_BUTTONFEEDBACK style flag as a parameter for the Create() or ModifyBarStyles() methods. When this style is specified, the bar remains pressed, like a button, giving the user additional feedback on which bar was clicked. For example:

m_scBar.ModifyBarStyle( 0, SEC_OBS_BUTTONFEEDBACK);

See Section 11.3 for more style flags and their descriptions.

1. Use the SEC_OBS_CONTEXTMENU style as a parameter for the Create() or ModifyBarStyles() methods. For example:

   m_scBar.ModifyBarStyle( 0, SEC_OBS_CONTEXTMENU);

2. Associate a context menu with the shortcut bar by calling the SetBarMenu() method.

   //Grab the zoom menu CMenu * pPopupMenu = AfxGetApp()->m_pMainWnd ->GetMenu()->GetSubMenu(3); ASSERT(pPopupMenu != NULL); m_scBar.SetBarMenu(pPopupMenu);

   ---

   The context menu specified here does not appear when an SECShortcutListCtrl window is right clicked. The SECShortcutListCtrl has its own context menu that is displayed when a right click occurs.

   ---

See Section 11.3 for more style flags and their descriptions.

Use the SEC_OBS_BUTTONFOCUS style flag as a parameter for the Create() or ModifyBarStyles() methods. For example:

m_scBar.ModifyBarStyle( 0, SEC_OBS_BUTTONFOCUS);

See Section 11.3 for more style flags and their descriptions.

1. Use the SEC_OBS_ANIMATESCROLL style flag as a parameter for the Create() or ModifyBarStyles() methods. For example:

   m_scBar.ModifyBarStyle( 0, SEC_OBS_ANIMATESCROLL);

2. To control the scrolling behavior further, call the SetAnimationSpeed() and SetAnimationStep() methods.

See Section 11.3 for more style flags and their descriptions.

1. In your parent window class (frame window, dialog, or other), add the ON_NOTIFY_RANGE macro to your message map macro list using the SEC_NM_ITEMCLICKED notification message. For example:

   ON_NOTIFY_RANGE( SEC_NM_ITEMCLICKED, SEC_IDW_BARCLIENT_FIRST, SEC_IDW_BARCLIENT_LAST, OnListBarClicked )

2. Override SECShortcutBar::OnListBarClicked(). The prototype looks like this.

   afx_msg void OnListBarClicked( UINT nID, NMHDR* pNMHDR, LRESULT* pResult );

See Section 11.4 for more information on notification messages.

When the user clicks an icon, it generates an SEC_NM_ITEMCLICKED notification. Typically, you would add a message map entry like the following to your listbar's parent window (frame window, dialog).

ON_NOTIFY_RANGE( SEC_NM_ITEMCLICKED, SEC_IDW_BARCLIENT_FIRST, SEC_IDW_BARCLIENT_LAST, OnListBarClicked )

The prototype for OnListBarClicked() is as follows:

afx_msg void OnListBarClicked( UINT nID, NMHDR* pNMHDR, LRESULT* pResult );

The following is an example handler.

void CMainFrame::OnListBarClicked( UINT nID, NMHDR* pNMHDR, LRESULT* pResult ) { ASSERT( pNMHDR->idFrom == nID ); ASSERT( nID >= SEC_IDW_BARCLIENT_FIRST ); ASSERT( nID <= SEC_IDW_BARCLIENT_LAST ); // Get the item clicked and display it SEC_SCNMHDR* pSCNMHDR=(SEC_SCNMHDR *)pNMHDR; TCHAR szMsg[80]; SECListBar* pListBar = (SECListBar*)&(m_scListBar.GetActiveBar()); SECShortcutListCtrl* pCtrl = pListBar->GetListCtrl(); CString strLab = pCtrl->GetItemText( pSCNMHDR->iSelItem,0); wsprintf(szMsg,_T("You clicked icon number %d\n Item Label: %s\n"), pSCNMHDR->iSelItem, strLab); AfxMessageBox(szMsg); // Apply focus back to the listbar such that // the hot-tracked state is properly cleaned // up from the recent activation change. ::SetFocus(pNMHDR->hwndFrom); }

Call the SetAlignStyle() method. For example:

//Change the SECShortcutBar to horizontal alignment m_wndShortcutBar.SetAlignStyle( SEC_OBS_HORZ ); //change back to vertical m_wndShortcutBar.SetAlignStyle( SEC_OBS_VERT );

1. Derive a new class from CSplitterWnd. In the derived splitter class, introduce a handler for the WM_MOUSEWHEEL message and remove the call to the base CSplitterWnd handler. Return FALSE instead. For example:

   BOOL CMySplitterWnd::OnMouseWheel(UINT nFlags, short zDelta, CPoint pt) { //Do not call the base class handler. // Return false instead. return FALSE; }

2. Create a splitter window using the run-time class SECShortcutBar to create the shortcut bar as a child of the splitter window. For example:

   // 1 row, 3 cols m_splitter.CreateStatic( this, 1, 3 ); m_splitter.CreateView( 0, 0, RUNTIME_CLASS(SECShortcutBar), CSize(0,0), pContext );

3. Retrieve a pointer to the shortcut bar from the splitter window. For example:

   //m_pShortcutBar is a pointer to SECShortcutBar m_pShortcutBar = (SECShortcutBar*)m_wndSplitterWindow.GetPane(0,0); ASSERT_VALID(m_pShortcutBar);

4. Use the AddBar() method to add bars to the shortcut bar. See Section 11.6.2 and Section 11.6.3.

Copyright © Rogue Wave Software, Inc. All Rights Reserved.

The Rogue Wave name and logo, and Stingray, are registered trademarks of Rogue Wave Software. All other trademarks are the property of their respective owners.
Provide feedback to Rogue Wave about its documentation.