Skip to content

Commit bae1fd1

Browse files
author
mtx48109
committed
finished batch
1 parent b7b9f61 commit bae1fd1

29 files changed

Lines changed: 709 additions & 708 deletions

‎docs/mfc/reference/cbasepane-class.md‎

Lines changed: 108 additions & 108 deletions
Large diffs are not rendered by default.

‎docs/mfc/reference/cbasetabbedpane-class.md‎

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -106,23 +106,23 @@ virtual BOOL AddTab(
106106
```
107107

108108
### Parameters
109-
[in] [out] `pNewBar`
109+
[in] [out] *pNewBar*
110110
A pointer to the pane to add. This pointer may become invalid after you call this method. For more information, see the Remarks section.
111111

112-
[in] `bVisible`
112+
[in] *bVisible*
113113
`TRUE` to make the tab visible; otherwise, `FALSE`.
114114

115-
[in] `bSetActive`
115+
[in] *bSetActive*
116116
`TRUE` to make the tab the active tab; otherwise, `FALSE`.
117117

118-
[in] `bDetachable`
118+
[in] *bDetachable*
119119
`TRUE` to make the tab detachable; otherwise, `FALSE`.
120120

121121
### Return Value
122122
`TRUE` if the pane was successfully added as a tab and was not destroyed in the process. `FALSE` if the pane being added is an object of type `CBaseTabbedPane`. For more information, see the Remarks section.
123123

124124
### Remarks
125-
Call this method to add a pane as a new tab on a tabbed pane. If `pNewBar` points to an object of type `CBaseTabbedPane`, all its tabs are copied onto the tabbed pane and then `pNewBar` is destroyed. Thus, `pNewBar` becomes an invalid pointer and should not be used.
125+
Call this method to add a pane as a new tab on a tabbed pane. If *pNewBar* points to an object of type `CBaseTabbedPane`, all its tabs are copied onto the tabbed pane and then *pNewBar* is destroyed. Thus, *pNewBar* becomes an invalid pointer and should not be used.
126126

127127
## <a name="allowdestroyemptytabbedpane"></a> CBaseTabbedPane::AllowDestroyEmptyTabbedPane
128128
Specifies whether an empty tabbed pane can be destroyed.
@@ -145,7 +145,7 @@ virtual void ApplyRestoredTabInfo(BOOL bUseTabIndexes = FALSE);
145145
```
146146

147147
### Parameters
148-
[in] `bUseTabIndexes`
148+
[in] *bUseTabIndexes*
149149
This parameter is used internally by the framework.
150150

151151
### Remarks
@@ -182,7 +182,7 @@ virtual void ConvertToTabbedDocument(BOOL bActiveTabOnly = TRUE);
182182
```
183183

184184
### Parameters
185-
[in] `bActiveTabOnly`
185+
[in] *bActiveTabOnly*
186186
When you convert a tabbed pane, specify `TRUE` to convert only the active tab. Specify `FALSE` to convert all tabs in the pane.
187187

188188
## <a name="detachpane"></a> CBaseTabbedPane::DetachPane
@@ -195,14 +195,14 @@ virtual BOOL DetachPane(
195195
```
196196

197197
### Parameters
198-
[in] `pBar`
198+
[in] *pBar*
199199
Pointer to the pane to detach.
200200

201-
[in] `bHide`
201+
[in] *bHide*
202202
Boolean parameter that specifies whether the framework hides the pane after it is detached.
203203

204204
### Return Value
205-
`TRUE` if the framework successfully detaches the pane; `FALSE` if `pBar` is `NULL` or refers to a pane that is not in the tabbed pane.
205+
`TRUE` if the framework successfully detaches the pane; `FALSE` if *pBar* is `NULL` or refers to a pane that is not in the tabbed pane.
206206

207207
### Remarks
208208
The framework floats the detached pane if possible. For more information, see [CBasePane::CanFloat](../../mfc/reference/cbasepane-class.md#canfloat).
@@ -215,7 +215,7 @@ virtual void EnableSetCaptionTextToTabName(BOOL bEnable);
215215
```
216216

217217
### Parameters
218-
[in] `bEnable`
218+
[in] *bEnable*
219219
`TRUE` to synchronize the tabbed pane caption with the active tab caption; otherwise, `FALSE`.
220220

221221
## <a name="filldefaulttabsorderarray"></a> CBaseTabbedPane::FillDefaultTabsOrderArray
@@ -236,14 +236,14 @@ virtual CWnd* FindPaneByID(UINT uBarID);
236236
```
237237

238238
### Parameters
239-
[in] `uBarID`
239+
[in] *uBarID*
240240
Specifies the ID of the pane to find.
241241

242242
### Return Value
243243
A pointer to the pane if it was found; otherwise, `NULL`.
244244

245245
### Remarks
246-
This method compares all tabs in the pane and returns the one with the ID specified by the `uBarID` parameter.
246+
This method compares all tabs in the pane and returns the one with the ID specified by the *uBarID* parameter.
247247

248248
## <a name="findbarbytabnumber"></a> CBaseTabbedPane::FindBarByTabNumber
249249
Returns a pane that resides in a tab.
@@ -255,17 +255,17 @@ virtual CWnd* FindBarByTabNumber(
255255
```
256256

257257
### Parameters
258-
[in] `nTabNum`
258+
[in] *nTabNum*
259259
Specifies the zero-based index of the tab to retrieve.
260260

261-
[in] `bGetWrappedBar`
261+
[in] *bGetWrappedBar*
262262
`TRUE` to return the underlying (wrapped) window of the pane instead of the pane itself; otherwise `FALSE`. This only applies to panes derived from [CDockablePaneAdapter](../../mfc/reference/cdockablepaneadapter-class.md).
263263

264264
### Return Value
265265
If the pane is found, then a valid pointer to the pane being searched for is returned; otherwise, `NULL`.
266266

267267
### Remarks
268-
Call this method to retrieve the pane residing in the tab specified by the `nTabNum` parameter.
268+
Call this method to retrieve the pane residing in the tab specified by the *nTabNum* parameter.
269269

270270
## <a name="floattab"></a> CBaseTabbedPane::FloatTab
271271
Floats a pane, but only if the pane currently resides in a detachable tab.
@@ -279,16 +279,16 @@ virtual BOOL FloatTab(
279279
```
280280

281281
### Parameters
282-
[in] [out] `pBar`
282+
[in] [out] *pBar*
283283
A pointer to the pane to float.
284284

285-
[in] `nTabID`
285+
[in] *nTabID*
286286
Specifies the zero-based index of the tab to float.
287287

288-
[in] `dockMethod`
288+
[in] *dockMethod*
289289
Specifies the method to use to make the pane float. For more information, see the Remarks section.
290290

291-
[in] `bHide`
291+
[in] *bHide*
292292
`TRUE` to hide the pane before floating; otherwise, `FALSE`.
293293

294294
### Return Value
@@ -297,7 +297,7 @@ virtual BOOL FloatTab(
297297
### Remarks
298298
Call this method to float a pane that currently resides in a detachable tab.
299299

300-
If you want to detach a pane programmatically, specify `DM_SHOW` for the `dockMethod` parameter. If you want to float the pane in the same position where it floated previously, specify `DM_DBL_CLICK` as the `dockMethod` parameter.
300+
If you want to detach a pane programmatically, specify `DM_SHOW` for the *dockMethod* parameter. If you want to float the pane in the same position where it floated previously, specify `DM_DBL_CLICK` as the *dockMethod* parameter.
301301

302302
## <a name="getdefaulttabsorder"></a> CBaseTabbedPane::GetDefaultTabsOrder
303303
Returns the default order of tabs in the pane.
@@ -320,7 +320,7 @@ virtual CWnd* GetFirstVisibleTab(int& iTabNum);
320320
```
321321

322322
### Parameters
323-
[in] `iTabNum`
323+
[in] *iTabNum*
324324
A reference to an integer. This method writes the zero-based index of the first displayed tab to this parameter, or -1 if no displayed tab is found.
325325

326326
### Return Value
@@ -334,11 +334,11 @@ virtual void GetMinSize(CSize& size) const;
334334
```
335335

336336
### Parameters
337-
[out] `size`
337+
[out] *size*
338338
A `CSize` object that is filled with the minimum allowed size.
339339

340340
### Remarks
341-
If consistent handling of minimum pane sizes is active ( [CPane::m_bHandleMinSize](../../mfc/reference/cpane-class.md#m_bhandleminsize)), `size` is filled with the minimum allowed size for the active tab. Otherwise, `size` is filled with the return value of [CPane::GetMinSize](../../mfc/reference/cpane-class.md#getminsize).
341+
If consistent handling of minimum pane sizes is active ( [CPane::m_bHandleMinSize](../../mfc/reference/cpane-class.md#m_bhandleminsize)), *size* is filled with the minimum allowed size for the active tab. Otherwise, *size* is filled with the return value of [CPane::GetMinSize](../../mfc/reference/cpane-class.md#getminsize).
342342

343343
## <a name="getpaneicon"></a> CBaseTabbedPane::GetPaneIcon
344344
Retrieves the minimum allowed size for the pane.
@@ -348,11 +348,11 @@ virtual void GetMinSize(CSize& size) const;
348348
```
349349

350350
### Parameters
351-
[out] `size`
351+
[out] *size*
352352
A `CSize` object that is filled with the minimum allowed size.
353353

354354
### Remarks
355-
If consistent handling of minimum pane sizes is active ( [CPane::m_bHandleMinSize](../../mfc/reference/cpane-class.md#m_bhandleminsize)), `size` is filled with the minimum allowed size for the active tab. Otherwise, `size` is filled with the return value of [CPane::GetMinSize](../../mfc/reference/cpane-class.md#getminsize).
355+
If consistent handling of minimum pane sizes is active ( [CPane::m_bHandleMinSize](../../mfc/reference/cpane-class.md#m_bhandleminsize)), *size* is filled with the minimum allowed size for the active tab. Otherwise, *size* is filled with the return value of [CPane::GetMinSize](../../mfc/reference/cpane-class.md#getminsize).
356356

357357
## <a name="getpanelist"></a> CBaseTabbedPane::GetPaneList
358358
Returns a list of panes that are contained in the tabbed pane.
@@ -364,10 +364,10 @@ virtual void GetPaneList(
364364
```
365365

366366
### Parameters
367-
[out] `lst`
367+
[out] *lst*
368368
A `CObList` that is filled with the panes that are contained in the tabbed pane.
369369

370-
[in] `pRTCFilter`
370+
[in] *pRTCFilter*
371371
If it is not `NULL`, the returned list contains only panes that are of the specified runtime class.
372372

373373
## <a name="gettabarea"></a> CBaseTabbedPane::GetTabArea
@@ -380,10 +380,10 @@ virtual void GetTabArea(
380380
```
381381

382382
### Parameters
383-
[out] `rectTabAreaTop`
383+
[out] *rectTabAreaTop*
384384
Receives the screen coordinates of the upper tab area.
385385

386-
[out] `rectTabAreaBottom`
386+
[out] *rectTabAreaBottom*
387387
Receives the screen coordinates of the lower tab area.
388388

389389
### Remarks
@@ -456,14 +456,14 @@ virtual BOOL RemovePane(CWnd* pBar);
456456
```
457457

458458
### Parameters
459-
[in] [out] `pBar`
459+
[in] [out] *pBar*
460460
A pointer to the pane to remove from the tabbed pane.
461461

462462
### Return Value
463463
`TRUE` if the pane was successfully removed from the tabbed pane and if the tabbed pane is still valid. `FALSE` if the last pane has been removed from the tabbed pane and the tabbed pane is about to be destroyed. If the return value is `FALSE`, do not use the tabbed pane any more.
464464

465465
### Remarks
466-
Call this method to remove the pane specified by the `pBar` parameter from the tabbed pane.
466+
Call this method to remove the pane specified by the *pBar* parameter from the tabbed pane.
467467

468468
## <a name="setautodestroy"></a> CBaseTabbedPane::SetAutoDestroy
469469
Determines whether the tabbed control bar will be destroyed automatically.
@@ -473,7 +473,7 @@ void SetAutoDestroy(BOOL bAutoDestroy = TRUE);
473473
```
474474

475475
### Parameters
476-
[in] `bAutoDestroy`
476+
[in] *bAutoDestroy*
477477
`TRUE` if the tabbed pane was created dynamically and you are not controlling its lifetime; otherwise, `FALSE`.
478478

479479
### Remarks
@@ -491,23 +491,23 @@ virtual BOOL ShowTab(
491491
```
492492

493493
### Parameters
494-
[in] `pBar`
494+
[in] *pBar*
495495
A pointer to the pane to show or hide.
496496

497-
[in] `bShow`
497+
[in] *bShow*
498498
`TRUE` to show the pane; `FALSE` to hide the pane.
499499

500-
[in] `bDelay`
500+
[in] *bDelay*
501501
`TRUE` to delay the adjustment of the tab layout; otherwise, `FALSE`.
502502

503-
[in] `bActivate`
503+
[in] *bActivate*
504504
`TRUE` to make the tab the active tab; otherwise, `FALSE`.
505505

506506
### Return Value
507507
`TRUE` if the tab was either shown or hidden successfully; otherwise, `FALSE`.
508508

509509
### Remarks
510-
When you call this method, a pane is either shown or hidden, depending on the value of the `bShow` parameter. If you hide a tab and it is the last visible tab in the underlying tab window, the tabbed pane is hidden. If you show a tab when there were previously no tabs visible, the tabbed pane is shown.
510+
When you call this method, a pane is either shown or hidden, depending on the value of the *bShow* parameter. If you hide a tab and it is the last visible tab in the underlying tab window, the tabbed pane is hidden. If you show a tab when there were previously no tabs visible, the tabbed pane is shown.
511511

512512
## <a name="recalclayout"></a> CBaseTabbedPane::RecalcLayout
513513
Recalculates layout information for the pane.
@@ -533,16 +533,16 @@ virtual CMFCAutoHideToolBar* SetAutoHideMode(
533533
```
534534

535535
### Parameters
536-
[in] `bMode`
536+
[in] *bMode*
537537
`TRUE` to enable auto-hide mode; `FALSE` to enable regular docking mode.
538538

539-
[in] `dwAlignment`
539+
[in] *dwAlignment*
540540
Specifies the alignment of the auto-hide pane that is to be created. For a list of possible values, see [CPane::MoveByAlignment](../../mfc/reference/cpane-class.md#movebyalignment).
541541

542-
[in] [out] `pCurrAutoHideBar`
542+
[in] [out] *pCurrAutoHideBar*
543543
A pointer to the current auto-hide toolbar. Can be `NULL`.
544544

545-
[in] `bUseTimer`
545+
[in] *bUseTimer*
546546
Specifies whether to use the auto-hide effect when the user switches the pane to auto-hide mode, or to hide the pane immediately.
547547

548548
### Return Value

‎docs/mfc/reference/cbasetransition-class.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ BOOL AddToStoryboard(IUIAnimationStoryboard* pStoryboard);
9090
```
9191

9292
### Parameters
93-
`pStoryboard`
93+
*pStoryboard*
9494
A pointer to storyboard, which will animate the related variable.
9595

9696
### Return Value
@@ -107,7 +107,7 @@ BOOL AddToStoryboardAtKeyframes(IUIAnimationStoryboard* pStoryboard);
107107
```
108108

109109
### Parameters
110-
`pStoryboard`
110+
*pStoryboard*
111111
A pointer to storyboard, which will animate the related variable.
112112

113113
### Return Value
@@ -143,10 +143,10 @@ virtual BOOL Create(
143143
```
144144

145145
### Parameters
146-
`pLibrary`
146+
*pLibrary*
147147
A pointer to transition library, which creates standard transitions. It can be NULL for custom transitions.
148148

149-
`pFactory`
149+
*pFactory*
150150
A pointer to transition factory, which creates custom transitions. It can be NULL for standard transitions.
151151

152152
### Return Value
@@ -206,10 +206,10 @@ IUIAnimationTransition* GetTransition();
206206
```
207207

208208
### Parameters
209-
`pLibrary`
209+
*pLibrary*
210210
A pointer to transition library, which creates standard transitions. It can be NULL for custom transitions.
211211

212-
`pFactory`
212+
*pFactory*
213213
A pointer to transition factory, which creates custom transitions. It can be NULL for standard transitions.
214214

215215
### Return Value
@@ -296,10 +296,10 @@ void SetKeyframes(
296296
```
297297

298298
### Parameters
299-
`pStart`
299+
*pStart*
300300
A keyframe that specifies the beginning of the transition.
301301

302-
`pEnd`
302+
*pEnd*
303303
A keyframe that specifies the end of the transition.
304304

305305
### Remarks
@@ -313,7 +313,7 @@ void SetRelatedVariable(CAnimationVariable* pVariable);
313313
```
314314

315315
### Parameters
316-
`pVariable`
316+
*pVariable*
317317
A pointer to related animation variable.
318318

319319
### Remarks

0 commit comments

Comments
 (0)