DOC: Incorrect Documentation for CToolBar::SetSizes()

ID: Q141444

The information in this article applies to:

The Microsoft Foundation Classes (MFC), included with:
- Microsoft Visual C++, 32-bit Editions, version 4.0

SUMMARY

The documentation provided with Visual C++ 4.0 incorrectly describes the parameter values for the SetSizes() member of the CToolBar class. The documentation indicates that the button size must be large enough to provide space for a three pixel border around the image. Stated another way, the width and height of the button must be at least six pixels larger than the width and height of the image displayed on that button.

The documentation should indicate that the button width must be at least seven pixels larger than the image width. If a margin of six pixels is used, the right-most button will be clipped. The button height need only exceed the image height by six pixels as noted in the documentation.

The documentation was corrected in Visual C++ 4.1.

MORE INFORMATION

The SetSizes() member of the CToolBar class is used to alter the size of toolbar buttons and their corresponding images. The prototype for this function is:


   void SetSizes( SIZE sizeButton, SIZE sizeImage );

According to the documentation provided with Visual C++ 4.0, the dimensions of sizeButton must be large enough to accommodate the image plus a three- pixel-wide button outline on each side of the image.

The documentation was correct for earlier versions of MFC. However with MFC 4.0, the dimensions for sizeButton must provide for at least seven extra pixels in the width of each button. This requirement is due to the use of the toolbar common control and is imposed by the common control rather than MFC.

Additional query words: 4.00 4.10

Keywords : kbdocfix kbMFC KbUIDesign kbVC
Version : 4.00
Platform : NT WINDOWS
Issue type :