Skip to content

Commit 659f767

Browse files
author
mtx48109
committed
format mfc reference pr11
1 parent 46e7436 commit 659f767

30 files changed

+4080
-4075
lines changed

docs/mfc/reference/cmfctoolbarmenubutton-class.md

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ class CMFCToolBarMenuButton : public CMFCToolBarButton
6161
|[CMFCToolBarMenuButton::OnChangeParentWnd](#onchangeparentwnd)|Called by the framework when the button is inserted into a new toolbar. (Overrides [CMFCToolBarButton::OnChangeParentWnd](cmfctoolbarbutton-class.md#onchangeparentwnd).)|
6262
|[CMFCToolBarMenuButton::OnClick](#onclick)|Called by the framework when the user clicks the mouse button. (Overrides [CMFCToolBarButton::OnClick](../../mfc/reference/cmfctoolbarbutton-class.md#onclick).)|
6363
|[CMFCToolBarMenuButton::OnClickMenuItem](#onclickmenuitem)|Called by the framework when the user selects an item in the pop-up menu.|
64-
|[CMFCToolBarMenuButton::OnContextHelp](#oncontexthelp)|Called by the framework when the parent toolbar handles a `WM_HELPHITTEST` message. (Overrides [CMFCToolBarButton::OnContextHelp](../../mfc/reference/cmfctoolbarbutton-class.md#oncontexthelp).)|
64+
|[CMFCToolBarMenuButton::OnContextHelp](#oncontexthelp)|Called by the framework when the parent toolbar handles a WM_HELPHITTEST message. (Overrides [CMFCToolBarButton::OnContextHelp](../../mfc/reference/cmfctoolbarbutton-class.md#oncontexthelp).)|
6565
|[CMFCToolBarMenuButton::OnDraw](#ondraw)|Called by the framework to draw the button by using the specified styles and options. (Overrides [CMFCToolBarButton::OnDraw](../../mfc/reference/cmfctoolbarbutton-class.md#ondraw).)|
6666
|[CMFCToolBarMenuButton::OnDrawOnCustomizeList](#ondrawoncustomizelist)|Called by the framework to draw the button in the **Commands** pane of the **Customize** dialog box. (Overrides [CMFCToolBarButton::OnDrawOnCustomizeList](../../mfc/reference/cmfctoolbarbutton-class.md#ondrawoncustomizelist).)|
6767
|[CMFCToolBarMenuButton::OpenPopupMenu](#openpopupmenu)|Called by the framework when the user opens the pop-up menu.|
@@ -123,26 +123,26 @@ CMFCToolBarMenuButton(
123123
```
124124

125125
### Parameters
126-
[in] `src`
126+
[in] *src*
127127
An existing `CMFCToolBarMenuButton` object to be copied into this `CMFCToolBarMenuButton` object.
128128

129-
[in] `uiID`
129+
[in] *uiID*
130130
The ID of the command to execute when a user clicks the button; or ( `UINT`)-1 for a menu button that does not directly execute a command.
131131

132-
[in] `hMenu`
132+
[in] *hMenu*
133133
A handle to a menu; or `NULL` if the button does not have a menu.
134134

135-
[in] `iImage`
136-
Index of the image for the button; or -1 if this button does not have an icon or uses the icon for the command specified by `uiID`. The index is the same for each `CMFCToolBarImages` object in your application.
135+
[in] *iImage*
136+
Index of the image for the button; or -1 if this button does not have an icon or uses the icon for the command specified by *uiID*. The index is the same for each `CMFCToolBarImages` object in your application.
137137

138-
[in] `lpszText`
138+
[in] *lpszText*
139139
The text of the toolbar menu button.
140140

141-
[in] `bUserButton`
142-
`TRUE` if the button displays a user-defined image; `FALSE` if the button displays a predefined image associated with the command specified by `uiID`.
141+
[in] *bUserButton*
142+
`TRUE` if the button displays a user-defined image; `FALSE` if the button displays a predefined image associated with the command specified by *uiID*.
143143

144144
### Remarks
145-
If `uiID` is a valid command ID, the button performs that command when the user clicks it. If `hMenu` is a valid menu handle, the button provides a drop-down menu when it appears in a toolbar or a submenu when it appears in a menu. If both `uiID` and `hMenu` are valid, the button is a split-button with a portion that will perform the command when the user clicks on it and a portion with a down arrow that will drop-down a menu when the user clicks on it. However, if `hMenu` is valid, a user will not be able to click the button to perform a command when the button is inserted into a menu.
145+
If *uiID* is a valid command ID, the button performs that command when the user clicks it. If *hMenu* is a valid menu handle, the button provides a drop-down menu when it appears in a toolbar or a submenu when it appears in a menu. If both *uiID* and *hMenu* are valid, the button is a split-button with a portion that will perform the command when the user clicks on it and a portion with a down arrow that will drop-down a menu when the user clicks on it. However, if *hMenu* is valid, a user will not be able to click the button to perform a command when the button is inserted into a menu.
146146

147147
### Example
148148
The following example demonstrates how to construct an object of the `CMFCToolBarMenuButton` class. This code snippet is part of the [Word Pad sample](../../visual-cpp-samples.md).
@@ -157,7 +157,7 @@ virtual BOOL CompareWith(const CMFCToolBarButton& other) const;
157157
```
158158

159159
### Parameters
160-
[in] `other`
160+
[in] *other*
161161

162162
### Return Value
163163

@@ -171,7 +171,7 @@ virtual void CopyFrom(const CMFCToolBarButton& src);
171171
```
172172

173173
### Parameters
174-
[in] `src`
174+
[in] *src*
175175

176176
### Remarks
177177

@@ -183,7 +183,7 @@ virtual void CreateFromMenu(HMENU hMenu);
183183
```
184184

185185
### Parameters
186-
[in] `hMenu`
186+
[in] *hMenu*
187187
A handle to a menu.
188188

189189
### Remarks
@@ -230,17 +230,17 @@ void DrawDocumentIcon(
230230
```
231231

232232
### Parameters
233-
[in] `pDC`
233+
[in] *pDC*
234234
A pointer to the device context.
235235

236-
[in] `rectImage`
236+
[in] *rectImage*
237237
Coordinates of the image bounding rectangle.
238238

239-
[in] `hIcon`
239+
[in] *hIcon*
240240
A handle to the icon.
241241

242242
### Remarks
243-
This method takes a document icon and draws it on the menu button, centered in the area specified by `rectImage`.
243+
This method takes a document icon and draws it on the menu button, centered in the area specified by *rectImage*.
244244

245245
## <a name="enablequickcustomize"></a> CMFCToolBarMenuButton::EnableQuickCustomize
246246

@@ -327,7 +327,7 @@ void GetImageRect(CRect& rectImage);
327327
```
328328

329329
### Parameters
330-
[out] `rectImage`
330+
[out] *rectImage*
331331
A reference to a `CRect` object that receives the coordinates of the image bounding rectangle.
332332

333333
## <a name="getpaletterows"></a> CMFCToolBarMenuButton::GetPaletteRows
@@ -463,9 +463,9 @@ virtual SIZE OnCalculateSize(
463463
```
464464

465465
### Parameters
466-
[in] `pDC`
467-
[in] `sizeDefault`
468-
[in] `bHorz`
466+
[in] *pDC*
467+
[in] *sizeDefault*
468+
[in] *bHorz*
469469

470470
### Return Value
471471

@@ -488,7 +488,7 @@ virtual void OnChangeParentWnd(CWnd* pWndParent);
488488
```
489489

490490
### Parameters
491-
[in] `pWndParent`
491+
[in] *pWndParent*
492492

493493
### Remarks
494494

@@ -502,8 +502,8 @@ virtual BOOL OnClick(
502502
```
503503

504504
### Parameters
505-
[in] `pWnd`
506-
[in] `bDelay`
505+
[in] *pWnd*
506+
[in] *bDelay*
507507

508508
### Return Value
509509

@@ -532,7 +532,7 @@ virtual BOOL OnContextHelp(CWnd* pWnd);
532532
```
533533

534534
### Parameters
535-
[in] `pWnd`
535+
[in] *pWnd*
536536

537537
### Return Value
538538

@@ -554,14 +554,14 @@ virtual void OnDraw(
554554
```
555555

556556
### Parameters
557-
[in] `pDC`
558-
[in] `rect`
559-
[in] `pImages`
560-
[in] `bHorz`
561-
[in] `bCustomizeMode`
562-
[in] `bHighlight`
563-
[in] `bDrawBorder`
564-
[in] `bGrayDisabledButtons`
557+
[in] *pDC*
558+
[in] *rect*
559+
[in] *pImages*
560+
[in] *bHorz*
561+
[in] *bCustomizeMode*
562+
[in] *bHighlight*
563+
[in] *bDrawBorder*
564+
[in] *bGrayDisabledButtons*
565565

566566
### Remarks
567567

@@ -576,9 +576,9 @@ virtual int OnDrawOnCustomizeList(
576576
```
577577

578578
### Parameters
579-
[in] `pDC`
580-
[in] `rect`
581-
[in] `bSelected`
579+
[in] *pDC*
580+
[in] *rect*
581+
[in] *bSelected*
582582

583583
### Return Value
584584

@@ -592,7 +592,7 @@ virtual BOOL OpenPopupMenu(CWnd* pWnd=NULL);
592592
```
593593

594594
### Parameters
595-
[in] `pWnd`
595+
[in] *pWnd*
596596
Specifies the window that receives the drop-down menu commands. It can be `NULL` only if the toolbar menu button has a parent window.
597597

598598
### Return Value
@@ -628,7 +628,7 @@ virtual void Serialize(CArchive& ar);
628628
```
629629

630630
### Parameters
631-
[in] `ar`
631+
[in] *ar*
632632

633633
### Remarks
634634

@@ -642,10 +642,10 @@ virtual BOOL SetACCData(
642642
```
643643

644644
### Parameters
645-
`pParent`
645+
*pParent*
646646
The parent window for the ribbon element.
647647

648-
`data`
648+
*data*
649649
The accessibility data for the ribbon element.
650650

651651
### Return Value
@@ -662,11 +662,11 @@ void SetMenuOnly(BOOL bMenuOnly);
662662
```
663663

664664
### Parameters
665-
[in] `bMenuOnly`
665+
[in] *bMenuOnly*
666666
`TRUE` to show this button as a menu button when it has both a valid command ID and a submenu, `FALSE` to show this button as a split button when it has both a valid command ID and a submenu.
667667

668668
### Remarks
669-
Typically, when a toolbar menu button has both a submenu and a command ID, the menu appears to be a split button that has a main button and an attached down arrow button. If you call this method and `bMenuOnly` is `TRUE`, the button instead appears to be a single menu button with a down arrow in the button. When the user clicks the arrow in either mode, the submenu opens, and when the user clicks the non-arrow part of the button in either mode the framework executes the command .
669+
Typically, when a toolbar menu button has both a submenu and a command ID, the menu appears to be a split button that has a main button and an attached down arrow button. If you call this method and *bMenuOnly* is `TRUE`, the button instead appears to be a single menu button with a down arrow in the button. When the user clicks the arrow in either mode, the submenu opens, and when the user clicks the non-arrow part of the button in either mode the framework executes the command .
670670

671671
## <a name="setmenupalettemode"></a> CMFCToolBarMenuButton::SetMenuPaletteMode
672672
Specifies whether the drop-down menu is in palette mode.
@@ -678,14 +678,14 @@ void SetMenuPaletteMode(
678678
```
679679

680680
### Parameters
681-
[in] `bMenuPaletteMode`
681+
[in] *bMenuPaletteMode*
682682
Specifies whether the drop-down menu is in palette mode.
683683

684-
[in] `nPaletteRows`
684+
[in] *nPaletteRows*
685685
Number of rows in palette.
686686

687687
### Remarks
688-
In the palette mode, all menu items are displayed as a multicolumn palette. You specify the number of rows by using `nPaletteRows`.
688+
In the palette mode, all menu items are displayed as a multicolumn palette. You specify the number of rows by using *nPaletteRows*.
689689

690690
## <a name="setmessagewnd"></a> CMFCToolBarMenuButton::SetMessageWnd
691691

@@ -695,7 +695,7 @@ void SetMessageWnd(CWnd* pWndMessage);
695695
```
696696

697697
### Parameters
698-
[in] `pWndMessage`
698+
[in] *pWndMessage*
699699

700700
### Remarks
701701

@@ -719,11 +719,11 @@ virtual void SetTearOff(UINT uiBarID);
719719
```
720720

721721
### Parameters
722-
[in] `uiBarID`
722+
[in] *uiBarID*
723723
Specifies a new tear-off bar ID.
724724

725725
### Remarks
726-
Call this method to specify the ID for the tear-off bar that is created when the user drags the menu button off of a menu bar. If the `uiBarID` parameter is 0, the user cannot tear off the menu button.
726+
Call this method to specify the ID for the tear-off bar that is created when the user drags the menu button off of a menu bar. If the *uiBarID* parameter is 0, the user cannot tear off the menu button.
727727

728728
Call [CWinAppEx::EnableTearOffMenus](../../mfc/reference/cwinappex-class.md#enabletearoffmenus) to enable the tear-off menu feature in your application.
729729

0 commit comments

Comments
 (0)