开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > Windows编程 > 界面编程 > 对话框与窗口 > 查看源码
XTPRibbonBar.h
资源名称：Xtreme.ToolkitPro.v12.0.0.rar　[点击查看]
上传用户：szled88
上传日期：2015-04-09
资源大小：43957k
文件大小：36k
源码类别：

对话框与窗口

开发平台：

Visual C++

XTPRibbonBar.h：源码内容
  1. // XTPRibbonBar.h: interface for the CXTPRibbonBar class.
  2. //
  3. // This file is a part of the XTREME RIBBON MFC class library.
  4. // (c)1998-2008 Codejock Software, All Rights Reserved.
  5. //
  6. // THIS SOURCE FILE IS THE PROPERTY OF CODEJOCK SOFTWARE AND IS NOT TO BE
  7. // RE-DISTRIBUTED BY ANY MEANS WHATSOEVER WITHOUT THE EXPRESSED WRITTEN
  8. // CONSENT OF CODEJOCK SOFTWARE.
  9. //
  10. // THIS SOURCE CODE CAN ONLY BE USED UNDER THE TERMS AND CONDITIONS OUTLINED
  11. // IN THE XTREME TOOLKIT PRO LICENSE AGREEMENT. CODEJOCK SOFTWARE GRANTS TO
  12. // YOU (ONE SOFTWARE DEVELOPER) THE LIMITED RIGHT TO USE THIS SOFTWARE ON A
  13. // SINGLE COMPUTER.
  14. //
  15. // CONTACT INFORMATION:
  16. // support@codejock.com
  17. // http://www.codejock.com
  18. //
  19. /////////////////////////////////////////////////////////////////////////////
  21. //{{AFX_CODEJOCK_PRIVATE
  22. #if !defined(__XTPRIBBONBAR_H__)
  23. #define __XTPRIBBONBAR_H__
  24. //}}AFX_CODEJOCK_PRIVATE
  26. #if _MSC_VER > 1000
  27. #pragma once
  28. #endif // _MSC_VER > 1000
  31. class CXTPRibbonTheme;
  32. class CXTPRibbonQuickAccessControls;
  33. class CXTPRibbonTab;
  34. class CXTPRibbonControlTab;
  35. class CXTPTabPaintManager;
  36. class CXTPRibbonBar;
  37. class CXTPRibbonGroup;
  38. class CXTPOffice2007FrameHook;
  39. class CXTPRibbonTabContextHeaders;
  40. class CXTPRibbonGroups;
  42. #include "CommandBars/XTPControls.h"
  43. #include "CommandBars/XTPMenuBar.h"
  44. #include "CommandBars/XTPPopupBar.h"
  45. #include "XTPRibbonPopups.h"
  48. //===========================================================================
  49. // Summary:
  50. //     CXTPRibbonBar is a CXTPMenuBar derived class, It represents Ribbon control from Office 2007.
  51. // Example:
  52. //     The following code sample demonstrates how to create CXTPRibbonBar:
  53. // <code>
  54. // CXTPRibbonBar* pRibbonBar = (CXTPRibbonBar*)pCommandBars->Add(_T("The Ribbon"), xtpBarTop, RUNTIME_CLASS(CXTPRibbonBar));
  55. // </code>
  56. //===========================================================================
  57. class _XTP_EXT_CLASS CXTPRibbonBar : public CXTPMenuBar, public CXTPRibbonScrollableBar
  58. {
  59. private:
  60. class CControlCaptionButton;
  61. class CControlQuickAccessMorePopup;
  62. class CControlQuickAccessCommand;
  64. private:
  65. DECLARE_XTP_COMMANDBAR(CXTPRibbonBar)
  67. public:
  68. //-----------------------------------------------------------------------
  69. // Summary:
  70. //     Constructs a CXTPRibbonBar object
  71. //-----------------------------------------------------------------------
  72. CXTPRibbonBar();
  74. //-----------------------------------------------------------------------
  75. // Summary:
  76. //     Destroys a CXTPRibbonBar object, handles cleanup and deallocation
  77. //-----------------------------------------------------------------------
  78. virtual ~CXTPRibbonBar();
  80. public:
  81. //-----------------------------------------------------------------------
  82. // Summary:
  83. //     Cal this method to add new tab for ribbon bar
  84. // Parameters:
  85. //     lpszCaption - Caption of tab to be added
  86. //     nID         - Identifier of tab to be added
  87. // Returns:
  88. //     Pointer to new CXTPRibbonTab object
  89. // See Also: InsertTab
  90. //-----------------------------------------------------------------------
  91. CXTPRibbonTab* AddTab(LPCTSTR lpszCaption);
  92. CXTPRibbonTab* AddTab(int nID); // <combine CXTPRibbonBar::AddTab@LPCTSTR>
  94. //-----------------------------------------------------------------------
  95. // Summary:
  96. //     Cal this method to insert new tab for ribbon bar to specified position
  97. // Parameters:
  98. //     nItem       - Position to insert new tab
  99. //     lpszCaption - Caption of tab to be added
  100. //     nID         - Identifier of tab
  101. // Returns:
  102. //     Pointer to new CXTPRibbonTab object
  103. // See Also: AddTab
  104. //-----------------------------------------------------------------------
  105. CXTPRibbonTab* InsertTab(int nItem, int nID);
  106. CXTPRibbonTab* InsertTab(int nItem, LPCTSTR lpszCaption, int nID = 0); // <combine CXTPRibbonBar::InsertTab@int@int>
  108. //-----------------------------------------------------------------------
  109. // Summary:
  110. //     Cal this method to get current selected tab
  111. // Returns:
  112. //     Pointer to current selected CXTPRibbonTab object
  113. // See Also: SetCurSel
  114. //-----------------------------------------------------------------------
  115. CXTPRibbonTab* GetSelectedTab() const;
  117. //-----------------------------------------------------------------------
  118. // Summary:
  119. //     Cal this method to get tab in specified position
  120. // Parameters:
  121. //     nIndex - Index of tab to retrieve
  122. // Returns:
  123. //     Pointer to CXTPRibbonTab object in specified position
  124. // See Also: GetTabCount
  125. //-----------------------------------------------------------------------
  126. CXTPRibbonTab* GetTab(int nIndex) const;
  128. //-----------------------------------------------------------------------
  129. // Summary:
  130. //     Cal this method to find tab by its identifier
  131. // Parameters:
  132. //     nId - Identifier of tab to be found
  133. // Returns:
  134. //     Pointer to CXTPRibbonTab object with specified identifier
  135. // See Also: FindGroup
  136. //-----------------------------------------------------------------------
  137. CXTPRibbonTab* FindTab(int nId) const;
  139. //-----------------------------------------------------------------------
  140. // Summary:
  141. //     Cal this method to find group by its identifier
  142. // Parameters:
  143. //     nId - Identifier of group to be found
  144. // Returns:
  145. //     Pointer to CXTPRibbonGroup object with specified identifier
  146. // See Also: FindTab
  147. //-----------------------------------------------------------------------
  148. CXTPRibbonGroup* FindGroup(int nId) const;
  150. //-----------------------------------------------------------------------
  151. // Summary:
  152. //     Retrieves the number of tabs in the ribbon bar.
  153. // Returns:
  154. //     Number of tabs in the ribbon bar.
  155. // See Also: GetTab
  156. //-----------------------------------------------------------------------
  157. int GetTabCount() const;
  159. //-----------------------------------------------------------------------
  160. // Summary:
  161. //     Retrieves ribbon paint manager.
  162. // Returns:
  163. //     Pointer to CXTPRibbonTheme object
  164. // See Also: AddTab
  165. //-----------------------------------------------------------------------
  166. CXTPRibbonTheme* GetRibbonPaintManager() const;
  168. //-----------------------------------------------------------------------
  169. // Summary:
  170. //     Call this method to select tab.
  171. // Parameters:
  172. //     nIndex - Index of tab to be selected
  173. // See Also: GetSelectedTab
  174. //-----------------------------------------------------------------------
  175. void SetCurSel(int nIndex);
  177. //-----------------------------------------------------------------------
  178. // Summary:
  179. //     Call this function to get the size of the command bar button.
  180. // Returns:
  181. //     The width and height values of the command bar button.
  182. //-----------------------------------------------------------------------
  183. CSize GetButtonSize() const;
  185. //-----------------------------------------------------------------------
  186. // Summary:
  187. //     Call this method to get select tab index.
  188. // See Also: SetCurSel
  189. //-----------------------------------------------------------------------
  190. int GetCurSel() const;
  192. //-----------------------------------------------------------------------
  193. // Summary:
  194. //     Call this member to get a pointer to the tab paint manager.
  195. //     The tab paint manager is used to customize the appearance of
  196. //     CXTPTabManagerItem objects and the tab manager.  I.e. Tab colors,
  197. //     styles, etc...  This member must be overridden in
  198. //     derived classes.
  199. // Returns:
  200. //     Pointer to CXTPTabPaintManager that contains the visual elements
  201. //     of the tabs.
  202. //-----------------------------------------------------------------------
  203. CXTPTabPaintManager* GetTabPaintManager() const;
  205. //-----------------------------------------------------------------------
  206. // Summary:
  207. //     Call this method to get highlighted group
  208. // Returns:
  209. //     CXTPRibbonGroup object under mouse cursor
  210. // See Also: CXTPRibbonGroup
  211. //-----------------------------------------------------------------------
  212. CXTPRibbonGroup* GetHighlightedGroup() const;
  214. //-----------------------------------------------------------------------
  215. // Summary:
  216. //     Determines if groups part of ribbon bar is visible
  217. // Returns:
  218. //     TRUE if groups are visible
  219. // See Also: SetGroupsVisible
  220. //-----------------------------------------------------------------------
  221. BOOL IsGroupsVisible() const;
  223. //-----------------------------------------------------------------------
  224. // Summary:
  225. //     Determines if tabs part of ribbon bar is visible
  226. // Returns:
  227. //     TRUE if tabs are visible
  228. // See Also: SetTabsVisible
  229. //-----------------------------------------------------------------------
  230. BOOL IsTabsVisible() const;
  232. //-----------------------------------------------------------------------
  233. // Summary:
  234. //     Determines if ribbon bar is visible
  235. //-----------------------------------------------------------------------
  236. BOOL IsRibbonBarVisible() const;
  238. //-----------------------------------------------------------------------
  239. // Summary:
  240. //     Call this member function to show or hide the ribbon.
  241. // Parameters:
  242. //     bVisible - TRUE to show the ribbon; FALSE to hide.
  243. //-----------------------------------------------------------------------
  244. virtual void SetVisible(BOOL bVisible);
  246. //-----------------------------------------------------------------------
  247. // Summary:
  248. //     Call this method to hide/show groups part of ribbon bar
  249. // Parameters:
  250. //     bVisible - TRUE to show groups
  251. // See Also: IsGroupsVisible
  252. //-----------------------------------------------------------------------
  253. void SetGroupsVisible(BOOL bVisible);
  255. //-----------------------------------------------------------------------
  256. // Summary:
  257. //     Call this method to hide/show tabs part of ribbon bar
  258. // Parameters:
  259. //     bVisible - TRUE to show tabs
  260. // See Also: IsTabsVisible
  261. //-----------------------------------------------------------------------
  262. void SetTabsVisible(BOOL bVisible);
  264. //-----------------------------------------------------------------------
  265. // Summary:
  266. //     Call this method to get CXTPRibbonControlTab that represents ribbon tabs
  267. //-----------------------------------------------------------------------
  268. CXTPRibbonControlTab* GetControlTab() const;
  270. //-----------------------------------------------------------------------
  271. // Summary:
  272. //     Call this method to set minimum width before ribbon bar disappear
  273. // Parameters:
  274. //     nMinVisibleWidth - Minimum width.
  275. // Remarks:
  276. //     Default value is 250 pixels
  277. // See Also: GetMinimumVisibleWidth
  278. //-----------------------------------------------------------------------
  279. void SetMinimumVisibleWidth(int nMinVisibleWidth);
  281. //-----------------------------------------------------------------------
  282. // Summary:
  283. //     Call this method to get minimum width before ribbon bar disappear
  284. // Returns:
  285. //     Minimum width before ribbon bar disappear.
  286. // See Also: SetMinimumVisibleWidth
  287. //-----------------------------------------------------------------------
  288. int GetMinimumVisibleWidth() const;
  290. //-----------------------------------------------------------------------
  291. // Summary:
  292. //     Retrieves collection of Quick Access controls.
  293. // Returns:
  294. //     Pointer to CXTPRibbonQuickAccessControls contained Quick Access controls.
  295. //-----------------------------------------------------------------------
  296. CXTPRibbonQuickAccessControls* GetQuickAccessControls() const;
  298. //-----------------------------------------------------------------------
  299. // Summary:
  300. //     Call this method to add ribbon top-left system button.
  301. // Parameters:
  302. //     nID - Identifier of system button
  303. // See Also: GetSystemButton
  304. //-----------------------------------------------------------------------
  305. CXTPControlPopup* AddSystemButton(int nID = 0);
  307. //-----------------------------------------------------------------------
  308. // Summary:
  309. //     Call this method to get ribbon top-left system button.
  310. // See Also: AddSystemButton
  311. //-----------------------------------------------------------------------
  312. CXTPControlPopup* GetSystemButton() const;
  314. //-----------------------------------------------------------------------
  315. // Summary:
  316. //     Call this member function to determine if the CommandBar is a
  317. //     CXTPRibbonBar.
  318. // Returns:
  319. //     Returns TRUE if the CommandBar is a CXTPRibbonBar, otherwise FALSE
  320. // See Also: CXTPCommandBar, CXTPRibbonBar
  321. //-----------------------------------------------------------------------
  322. virtual BOOL IsRibbonBar() const;
  324. //-----------------------------------------------------------------------
  325. // Summary:
  326. //     Call this member to remove all tab
  327. // See Also: RemoveTab
  328. //-----------------------------------------------------------------------
  329. void RemoveAllTabs();
  331. //-----------------------------------------------------------------------
  332. // Summary:
  333. //     Call this member to remove single tab
  334. // Parameters:
  335. //     nIndex - Index of tab to remove
  336. // See Also: RemoveTab
  337. //-----------------------------------------------------------------------
  338. void RemoveTab(int nIndex);
  340. //-----------------------------------------------------------------------
  341. // Summary:
  342. //     Call this method to be sure control is visible on ribbon bar
  343. // Parameters:
  344. //     pControl - CXTPControl child that need to check
  345. //-----------------------------------------------------------------------
  346. virtual void EnsureVisible(CXTPControl* pControl);
  348. public:
  349. //-----------------------------------------------------------------------
  350. // Summary:
  351. //     Call this method to enable Office 2007 frame.
  352. // Parameters:
  353. //     bEnable - TRUE to enable Office 2007 frame; FLASE - to disable
  354. // See Also: IsFrameThemeEnabled
  355. //-----------------------------------------------------------------------
  356. void EnableFrameTheme(BOOL bEnable = TRUE);
  358. //-----------------------------------------------------------------------
  359. // Summary:
  360. //     Determines if Office 2007 frame enabled
  361. // See Also: IsFrameThemeEnabled
  362. //-----------------------------------------------------------------------
  363. BOOL IsFrameThemeEnabled() const;
  365. //-----------------------------------------------------------------------
  366. // Summary:
  367. //     Call this method to show Quick Access controls below ribbon bar
  368. // Parameters:
  369. //     bBelow - TRUE to show below ribbon; FALSE - above.
  370. // See Also: IsQuickAccessBelowRibbon
  371. //-----------------------------------------------------------------------
  372. void ShowQuickAccessBelowRibbon(BOOL bBelow = TRUE);
  374. //-----------------------------------------------------------------------
  375. // Summary:
  376. //     Determine if Quick Access controls located below ribbon bar
  377. // See Also: ShowQuickAccessBelowRibbon
  378. //-----------------------------------------------------------------------
  379. BOOL IsQuickAccessBelowRibbon() const;
  381. //-----------------------------------------------------------------------
  382. // Summary:
  383. //     Call this method to show/hide quick access
  384. // Parameters:
  385. //     bShow - TRUE to show quick access; FALSE to hide
  386. // See Also: IsQuickAccessVisible, ShowQuickAccessBelowRibbon
  387. //-----------------------------------------------------------------------
  388. void ShowQuickAccess(BOOL bShow = TRUE);
  390. //-----------------------------------------------------------------------
  391. // Summary:
  392. //     Determines if quick access is visible
  393. // Returns:
  394. //     TRUE if quick access is visible
  395. // See Also: ShowQuickAccess
  396. //-----------------------------------------------------------------------
  397. BOOL IsQuickAccessVisible() const;
  399. //-----------------------------------------------------------------------
  400. // Summary:
  401. //     Call this method to allow same controls for quick access
  402. // Parameters:
  403. //     bAllow - TRUE to allow add same controls for quick access
  404. // See Also: IsAllowQuickAccessDuplicates, ShowQuickAccessBelowRibbon
  405. //-----------------------------------------------------------------------
  406. void AllowQuickAccessDuplicates(BOOL bAllow);
  408. //-----------------------------------------------------------------------
  409. // Summary:
  410. //     Call this method to allow customization for quick access
  411. // Parameters:
  412. //     bAllow - TRUE to allow customization for quick access
  413. // See Also: IsAllowQuickAccessDuplicates, ShowQuickAccessBelowRibbon
  414. //-----------------------------------------------------------------------
  415. void AllowQuickAccessCustomization(BOOL bAllow);
  417. //-----------------------------------------------------------------------
  418. // Summary:
  419. //     Determines if user can add 2 or more same controls to quick access
  420. // Returns: TRUE if duplicates allowed
  421. // See Also: AllowQuickAccessDuplicates
  422. //-----------------------------------------------------------------------
  423. BOOL IsAllowQuickAccessDuplicates() const;
  425. //-----------------------------------------------------------------------
  426. // Summary:
  427. //     Call this method to select next or previous tab
  428. // Parameters:
  429. //     bNext - TRUE to select next
  430. //-----------------------------------------------------------------------
  431. void SelectNextTab(BOOL bNext);
  433. //-----------------------------------------------------------------------
  434. // Summary:
  435. //     Call this method to minimize Ribbon Bar
  436. // Parameters:
  437. //     bMinimized - TRUE to minimize Ribbon Bar.
  438. //-----------------------------------------------------------------------
  439. virtual void SetRibbonMinimized(BOOL bMinimized);
  441. //-----------------------------------------------------------------------
  442. // Summary:
  443. //     Determines if ribbon bar is minimized
  444. //-----------------------------------------------------------------------
  445. BOOL IsRibbonMinimized() const;
  447. //-----------------------------------------------------------------------
  448. // Summary:
  449. //     Call this method to disable minimize feature of Ribbon Bar
  450. // Parameters:
  451. //     bAllow - TRUE to allow minimize ribbon bar; FALSE to forbid
  452. //-----------------------------------------------------------------------
  453. void AllowMinimize(BOOL bAllow);
  455. public:
  457. //-----------------------------------------------------------------------
  458. // Summary:
  459. //     When switching tabs, RebuildControls first deletes all the controls
  460. //     from the old tab groups.  Then controls are added to the tab groups
  461. //     of the tab to be selected.  Finally, the new tab is selected.
  462. // Parameters:
  463. //     pSelected - Tab to be selected.
  464. // See Also: CXTPRibbonControlTab::SetSelectedItem, CXTPRibbonTab::GetGroups
  465. //-----------------------------------------------------------------------
  466. void RebuildControls(CXTPRibbonTab* pSelected);
  468. //-----------------------------------------------------------------------
  469. // Summary:
  470. //     Gets the bounding rectangle for the ribbon tabs.
  471. // Returns:
  472. //     Bounding rectangle for the ribbon tabs.
  473. // See Also: CXTPRibbonThemeOffice2007Theme::FillRibbonBar
  474. //-----------------------------------------------------------------------
  475. CRect GetTabControlRect() const;
  477. //-----------------------------------------------------------------------
  478. // Summary:
  479. //     Gets the bounding rectangle for the ribbon caption.
  480. // Returns:
  481. //     Bounding rectangle for the ribbon caption.
  482. // See Also: GetCaptionTextRect, GetQuickAccessRect, GetTabControlRect
  483. //-----------------------------------------------------------------------
  484. CRect GetCaptionRect() const;
  486. //-----------------------------------------------------------------------
  487. // Summary:
  488. //     Gets the bounding rectangle for the ribbon caption text.
  489. // Returns:
  490. //     Bounding rectangle for the ribbon caption text.
  491. // See Also: GetCaptionRect, GetQuickAccessRect, GetTabControlRect
  492. //-----------------------------------------------------------------------
  493. CRect GetCaptionTextRect() const;
  495. //-----------------------------------------------------------------------
  496. // Summary:
  497. //     Gets the bounding rectangle for the ribbon Quick Access controls.
  498. // Returns:
  499. //     Bounding rectangle for the ribbon  Quick Access controls.
  500. // See Also: GetCaptionRect, GetCaptionTextRect, GetTabControlRect
  501. //-----------------------------------------------------------------------
  502. CRect GetQuickAccessRect() const;
  504. //-----------------------------------------------------------------------
  505. // Summary:
  506. //     This member function determines which ribbon group,
  507. //     if any, is at a specified position.
  508. // Parameters:
  509. //     point  - A CPoint that contains the coordinates of the point to test.
  510. // Returns:
  511. //      The CXTPRibbonGroup that is at the specified point, if no group is
  512. //      at the point, then NULL is returned.
  513. //-----------------------------------------------------------------------
  514. CXTPRibbonGroup* HitTestGroup(CPoint point) const;
  516. //-----------------------------------------------------------------------
  517. // Summary:
  518. //     This method retrieves tabs area height
  519. // See Also: GetGroupsHeight
  520. //-----------------------------------------------------------------------
  521. virtual int GetTabsHeight() const;
  523. //-----------------------------------------------------------------------
  524. // Summary:
  525. //     This method retrieves Quick Access area height
  526. // See Also: GetGroupsHeight, GetTabsHeight
  527. //-----------------------------------------------------------------------
  528. int GetQuickAccessHeight() const;
  530. //-----------------------------------------------------------------------
  531. // Summary:
  532. //     Calculates Quick Access area height
  533. //-----------------------------------------------------------------------
  534. int CalcQuickAccessHeight();
  536. //-----------------------------------------------------------------------
  537. // Summary:
  538. //     This method retrieves group area height;
  539. // See Also: GetTabsHeight
  540. //-----------------------------------------------------------------------
  541. virtual int GetGroupsHeight();
  543. //-----------------------------------------------------------------------
  544. // Summary:
  545. //     Retrieves Groups bounding rectangle
  546. //-----------------------------------------------------------------------
  547. CRect GetGroupsRect() const;
  549. //-----------------------------------------------------------------------
  550. // Summary:
  551. //     This method calculates groups height using GetLargeIconSize method and height of captions
  552. // Returns: Height of ribbon groups
  553. // See Also: GetGroupsHeight
  554. //-----------------------------------------------------------------------
  555. virtual int CalcGroupsHeight();
  557. //-----------------------------------------------------------------------
  558. // Summary:
  559. //     Call this method to set height of the ribbon groups
  560. // Parameters:
  561. //     nHeight - Height of groups to set
  562. // See Also: GetTabsHeight
  563. //-----------------------------------------------------------------------
  564. void SetGroupsHeight(int nHeight);
  566. //-----------------------------------------------------------------------
  567. // Summary:
  568. //     Call this member to get caption height of ribbon bar
  569. // Returns: Caption height in pixels
  570. // See Also: CalcGroupsHeight
  571. //-----------------------------------------------------------------------
  572. int GetCaptionHeight() const;
  574. //-----------------------------------------------------------------------
  575. // Summary:
  576. //     This method retrieves Context Headers collection;
  577. // Returns:
  578. //     Pointer to CXTPRibbonTabContextHeaders class contained
  579. //     CXTPRibbonTabContextHeader collection
  580. // See Also: CXTPRibbonTabContextHeader
  581. //-----------------------------------------------------------------------
  582. CXTPRibbonTabContextHeaders* GetContextHeaders() const;
  584. //-----------------------------------------------------------------------
  585. // Summary:
  586. //     Determines if control belongs to quick access controls.
  587. // Parameters:
  588. //     pControl - Control to test
  589. // Returns:
  590. //     TRUE if control located in quick access area.
  591. //-----------------------------------------------------------------------
  592. BOOL IsQuickAccessControl(CXTPControl* pControl) const;
  594. //-----------------------------------------------------------------------
  595. // Summary:
  596. //     Determines if control can be added to quick access controls.
  597. // Parameters:
  598. //     pControl - Control to test
  599. // Returns:
  600. //     TRUE if control can be added in quick access area.
  601. //-----------------------------------------------------------------------
  602. virtual BOOL IsAllowQuickAccessControl(CXTPControl* pControl);
  604. //-----------------------------------------------------------------------
  605. // Summary:
  606. //     This method is called to draw the command bar in the given context.
  607. // Parameters:
  608. //     pDC - Pointer to a valid device context
  609. //     rcClipBox - The rectangular area of the control that is invalid
  610. //-----------------------------------------------------------------------
  611. virtual void DrawCommandBar(CDC* pDC, CRect rcClipBox);
  613. //-----------------------------------------------------------------------
  614. // Summary:
  615. //     Returns CXTPOffice2007FrameHook hook window used to skin frame.
  616. // See Also: EnableFrameTheme
  617. //-----------------------------------------------------------------------
  618. CXTPOffice2007FrameHook* GetFrameHook() const;
  620. //-----------------------------------------------------------------------
  621. // Summary:
  622. //     Determines if Vista Glass Effect enabled for Ribbon Bar.
  623. //-----------------------------------------------------------------------
  624. BOOL IsDwmEnabled() const;
  626. //-----------------------------------------------------------------------
  627. // Summary:
  628. //     Call this method to set custom font height for ribbon bar
  629. // Parameters:
  630. //     nFontHeight - Font height to set
  631. //-----------------------------------------------------------------------
  632. void SetFontHeight(int nFontHeight);
  634. //-----------------------------------------------------------------------
  635. // Summary:
  636. //     Determines font height used for Ribbon Bar
  637. //-----------------------------------------------------------------------
  638. int GetFontHeight() const;
  640. //-----------------------------------------------------------------------
  641. // Summary:
  642. //     Determines if caption part of ribbon is visible
  643. //-----------------------------------------------------------------------
  644. BOOL IsCaptionVisible() const;
  646. //-----------------------------------------------------------------------
  647. // Summary:
  648. //     This method allow show/hide caption if frame theme is not enabled.
  649. // Parameters:
  650. //     bShowCaption - TRUE to show caption if frame theme is not enabled.
  651. //-----------------------------------------------------------------------
  652. void ShowCaptionAlways(BOOL bShowCaption);
  654. //-----------------------------------------------------------------------
  655. // Summary:
  656. //     Call this member function to get the size of a toolbar icon.
  657. // See Also:
  658. //     GetLargeIconSize
  659. //-----------------------------------------------------------------------
  660. virtual CSize GetIconSize() const;
  662. //-----------------------------------------------------------------------
  663. // Summary:
  664. //     Call this method to get pointer to quick access button
  665. // Returns:
  666. //     Pointer to quick access button
  667. //-----------------------------------------------------------------------
  668. CXTPControl* GetControlQuickAccess() const;
  670. BOOL IsKeyboardCuesVisible() const;
  672. protected:
  673. //-----------------------------------------------------------------------
  674. // Summary:
  675. //     This virtual method called when tab is about to be changed.
  676. // Parameters:
  677. //     pTab - Tab to be selected
  678. // Returns:
  679. //     returns TRUE to cancel tab changing, FALSE to allow.
  680. //-----------------------------------------------------------------------
  681. virtual BOOL OnTabChanging(CXTPRibbonTab* pTab);
  683. //-----------------------------------------------------------------------
  684. // Summary:
  685. //     This virtual method called when current tab is changed.
  686. // Parameters:
  687. //     pTab - New selected tab
  688. //-----------------------------------------------------------------------
  689. virtual void OnTabChanged(CXTPRibbonTab* pTab);
  691. //{{AFX_CODEJOCK_PRIVATE
  692. protected:
  694. //-----------------------------------------------------------------------
  695. // Summary:
  696. //     This method is called to assign self identifiers for serialization process.
  697. // Parameters:
  698. //     nID             - Identifier to assign
  699. //     pCommandBarList - List of CommandBars.
  700. //     pParam          - Address of a XTP_COMMANDBARS_PROPEXCHANGE_PARAM structure.
  701. //-----------------------------------------------------------------------
  702. void GenerateCommandBarList(DWORD& nID, CXTPCommandBarList* pCommandBarList, XTP_COMMANDBARS_PROPEXCHANGE_PARAM* pParam);
  704. //-----------------------------------------------------------------------
  705. // Summary:
  706. //     This method is called in serialization process.to restore popups from list of command bars.
  707. // Parameters:
  708. //     pCommandBarList - List of CommandBars.
  709. //-----------------------------------------------------------------------
  710. void RestoreCommandBarList(CXTPCommandBarList* pCommandBarList);
  712. void DoPropExchange(CXTPPropExchange* pPX);
  713. void Copy(CXTPCommandBar* pCommandBar, BOOL bRecursive = FALSE);
  714. virtual CXTPPopupBar* CreateContextMenu(CXTPControl* pSelectedControl);
  715. virtual CXTPPopupBar* CreateMoreQuickAccessContextMenu();
  716. virtual BOOL ShouldSerializeBar();
  717. virtual void MergeToolBar(CXTPCommandBar* pCommandBar, BOOL bSilent);
  718. int HitTestCaption(CPoint point) const;
  719. void RepositionCaptionButtons();
  720. void RepositionContextHeaders();
  721. void AddCaptionButton(int nId, BOOL bAdd, BOOL bEnabled, CRect& rcCaption);
  722. BOOL ShrinkContextHeaders(int nLeft, int nRight);
  723. void ShowContextMenu(CPoint point, CXTPControl* pSelectedControl);
  724. virtual void CreateKeyboardTips();
  725. virtual void OnKeyboardTip(CXTPCommandBarKeyboardTip* pTip);
  726. virtual void OnCustomizeDrop(CXTPControl* pDataObject, DROPEFFECT& dropEffect, CPoint ptDrop, CPoint ptDrag);
  727. void RefreshSysButtons();
  728. virtual BOOL ProcessSpecialKey(XTPSpecialKey key);
  730. protected:
  732. public:
  733. virtual CSize CalcDockingLayout(int nLength, DWORD dwMode, int nWidth = 0);
  734. void Reposition(int cx, int cy);
  735. void RepositionGroups(CDC* pDC, CRect rcGroups);
  736. virtual BOOL PreviewAccel(UINT chAccel);
  737. virtual BOOL SetTrackingMode(int bMode, BOOL bSelectFirst = TRUE, BOOL bKeyboard = FALSE);
  738. int OnHookMessage(HWND /*hWnd*/, UINT nMessage, WPARAM& wParam, LPARAM& lParam, LRESULT& /*lResult*/);
  739. void OnRemoved();
  740. void OnGroupsScroll(BOOL bScrollLeft);
  741. int GetRibbonTopBorder() const;
  743. //}}AFX_CODEJOCK_PRIVATE
  745. protected:
  746. //{{AFX_CODEJOCK_PRIVATE
  747. DECLARE_MESSAGE_MAP()
  748. //{{AFX_VIRTUAL(CXTPRibbonBar)
  749. //}}AFX_VIRTUAL
  751. //{{AFX_MSG(CXTPRibbonBar)
  752. afx_msg void OnMouseLeave();
  753. afx_msg void OnMouseMove(UINT nFlags, CPoint point);
  754. afx_msg INT_PTR OnToolHitTest(CPoint point, TOOLINFO* pTI) const;
  755. afx_msg void OnSysColorChange();
  756. afx_msg void OnLButtonDown(UINT nFlags, CPoint point);
  757. afx_msg void OnRButtonUp(UINT nFlags, CPoint point);
  758. void OnPopupRButtonUp(CXTPCommandBar* pCommandBar, CPoint point);
  759. afx_msg void OnLButtonDblClk(UINT nFlags, CPoint point);
  760. afx_msg int OnCreate(LPCREATESTRUCT lpCreateStruct);
  761. afx_msg BOOL OnSetCursor(CWnd* pWnd, UINT nHitTest, UINT message);
  762. afx_msg void OnShowWindow(BOOL bShow, UINT nStatus);
  763. afx_msg void OnRButtonDown(UINT nFlags, CPoint point);
  764. afx_msg void OnCustomizePlaceQuickAccess(UINT nCommand);
  765. afx_msg LRESULT OnCustomizeCommand(WPARAM wParam, LPARAM lParam);
  766. afx_msg LRESULT OnNcHitTest(CPoint point);
  768. //}}AFX_MSG
  769. //}}AFX_CODEJOCK_PRIVATE
  771. protected:
  773. protected:
  774. CRect m_rcTabControl;           // Bounding rectangle of Tabs
  775. CRect m_rcGroups;               // Groups bounding rectangle
  776. CRect m_rcCaption;              // Caption bounding rectangle
  777. CRect m_rcCaptionText;          // Caption text bounding rectangle
  778. CRect m_rcHeader;               // Header bounding rectangle
  779. CRect m_rcQuickAccess;          // Quick access bounding rectangle
  781. BOOL m_bRibbonBarVisible;       // TRUE if ribbon bar visible
  782. BOOL m_bGroupsVisible;          // TRUE if groups is visible
  783. BOOL m_bTabsVisible;            // TRUE if tabs are visible
  784. BOOL m_bShowQuickAccessBelow;   // TRUE to show quick access controls below ribbon bar
  785. BOOL m_bShowQuickAccess;        // TRUE to show quick access
  786. BOOL m_bAllowQuickAccessDuplicates;         // TRUE to allow quick access duplicates
  787. BOOL m_bAllowQuickAccessCustomization;      // TRUE to allow quick access customization
  788. BOOL m_bGroupReducedChanged;    // Some group appear in resize handler
  789. int m_nQuickAccessHeight;           // Quick Access height
  790. BOOL m_bAllowMinimize;          // TRUE to allow minimize ribbon
  792. CXTPRibbonQuickAccessControls* m_pQuickAccessControls;      // Quick AccessControls (not used now)
  793. CXTPRibbonControlTab* m_pControlTab;        // Control tab pointer
  794. CXTPControl* m_pControlQuickAccess;         // Quick Access menu control
  795. CXTPControl* m_pControlQuickAccessMore;     // Quick Access more control
  796. CXTPControlPopup* m_pControlSystemButton;          // System button control
  797. BOOL m_bMinimizeOnDblClick;
  798. int m_nMinVisibleWidth;                     // Minimum width before ribbon bar disappears
  800. CXTPOffice2007FrameHook* m_pFrameHook;      // Office 2007 Frame hook
  802. CXTPRibbonTabContextHeaders* m_pContextHeaders;     // Context header collection
  803. int m_nGroupsHeight;            // Custom groups height
  805. BOOL m_bMinimized;              // TRUE if Ribbon currently minimized
  806. BOOL m_bShowCaptionAlways;      // TRUE to show caption even if EnableFrameTheme was not called.
  807. CString m_strCaptionText;       // Caption text
  809. private:
  810. friend class CXTPRibbonControlTab;
  811. friend class CXTPRibbonBarControlQuickAccessPopup;
  812. friend class CControlQuickAccessMorePopup;
  813. friend class CXTPRibbonGroup;
  814. friend class CXTPRibbonControls;
  815. friend class CXTPRibbonGroups;
  816. friend class CXTPRibbonTabPopupToolBar;
  817. };
  820. AFX_INLINE CRect CXTPRibbonBar::GetTabControlRect() const {
  821. return m_rcTabControl;
  822. }
  823. AFX_INLINE CXTPRibbonGroup* CXTPRibbonBar::GetHighlightedGroup() const {
  824. return m_pHighlightedGroup;
  825. }
  826. AFX_INLINE CXTPRibbonGroup* CXTPRibbonScrollableBar::GetHighlightedGroup() const {
  827. return m_pHighlightedGroup;
  828. }
  829. AFX_INLINE CXTPRibbonControlTab* CXTPRibbonBar::GetControlTab() const {
  830. return m_pControlTab;
  831. }
  832. AFX_INLINE void CXTPRibbonBar::SetMinimumVisibleWidth(int nMinVisibleWidth) {
  833. m_nMinVisibleWidth = nMinVisibleWidth;
  834. }
  835. AFX_INLINE int CXTPRibbonBar::GetMinimumVisibleWidth() const {
  836. return m_nMinVisibleWidth;
  837. }
  838. AFX_INLINE CRect CXTPRibbonBar::GetCaptionRect() const {
  839. return m_rcCaption;
  840. }
  841. AFX_INLINE CRect CXTPRibbonBar::GetCaptionTextRect() const {
  842. return m_rcCaptionText;
  843. }
  844. AFX_INLINE CRect CXTPRibbonBar::GetQuickAccessRect() const {
  845. return m_rcQuickAccess;
  846. }
  847. AFX_INLINE CXTPRibbonQuickAccessControls* CXTPRibbonBar::GetQuickAccessControls() const {
  848. return m_pQuickAccessControls;
  849. }
  850. AFX_INLINE CXTPControlPopup* CXTPRibbonBar::GetSystemButton() const {
  851. return m_pControlSystemButton;
  852. }
  853. AFX_INLINE BOOL CXTPRibbonBar::IsRibbonBarVisible() const {
  854. return m_bVisible && m_bRibbonBarVisible;
  855. }
  856. AFX_INLINE CXTPRibbonTabContextHeaders* CXTPRibbonBar::GetContextHeaders() const {
  857. return m_pContextHeaders;
  858. }
  859. AFX_INLINE BOOL CXTPRibbonBar::IsRibbonBar() const {
  860. return TRUE;
  861. }
  862. AFX_INLINE void CXTPRibbonBar::ShowQuickAccess(BOOL bShow) {
  863. m_bShowQuickAccess = bShow;
  864. OnRecalcLayout();
  865. }
  866. AFX_INLINE BOOL CXTPRibbonBar::IsQuickAccessVisible() const {
  867. return m_bShowQuickAccess;
  868. }
  869. AFX_INLINE void CXTPRibbonBar::AllowQuickAccessDuplicates(BOOL bAllow) {
  870. m_bAllowQuickAccessDuplicates = bAllow;
  871. }
  872. AFX_INLINE void CXTPRibbonBar::AllowQuickAccessCustomization(BOOL bAllow) {
  873. m_bAllowQuickAccessCustomization = bAllow;
  874. }
  875. AFX_INLINE BOOL CXTPRibbonBar::IsAllowQuickAccessDuplicates() const {
  876. return m_bAllowQuickAccessDuplicates;
  877. }
  878. AFX_INLINE void CXTPRibbonBar::SetGroupsHeight(int nHeight) {
  879. m_nGroupsHeight = nHeight;
  880. }
  881. AFX_INLINE CXTPOffice2007FrameHook* CXTPRibbonBar::GetFrameHook() const {
  882. return m_pFrameHook;
  883. }
  884. AFX_INLINE void CXTPRibbonBar::AllowMinimize(BOOL bAllow) {
  885. m_bAllowMinimize = bAllow;
  886. }
  887. AFX_INLINE CRect CXTPRibbonBar::GetGroupsRect() const {
  888. return m_rcGroups;
  889. }
  890. AFX_INLINE void CXTPRibbonBar::ShowCaptionAlways(BOOL bShowCaption) {
  891. m_bShowCaptionAlways = bShowCaption;
  892. }
  893. AFX_INLINE CXTPControl* CXTPRibbonBar::GetControlQuickAccess() const {
  894. return m_pControlQuickAccess;
  895. }
  897. #endif // !defined(__XTPRIBBONBAR_H__)