src/pwclib/bars.cxx

   1 /*
   2  * bars.cxx
   3  *
   4  * Tool bar classes.
   5  *
   6  * Portable Windows Library
   7  *
   8  * Copyright (c) 1993-1998 Equivalence Pty. Ltd.
   9  *
  10  * The contents of this file are subject to the Mozilla Public License
  11  * Version 1.0 (the "License"); you may not use this file except in
  12  * compliance with the License. You may obtain a copy of the License at
  13  * http://www.mozilla.org/MPL/
  14  *
  15  * Software distributed under the License is distributed on an "AS IS"
  16  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
  17  * the License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * The Original Code is Portable Windows Library.
  21  *
  22  * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
  23  *
  24  * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
  25  * All Rights Reserved.
  26  *
  27  * Contributor(s): ______________________________________.
  28  *
  29  * $Log$
  30  * Revision 1.43  1998/12/20 09:14:39  robertj
  31  * Added pragma implementation for GNU compiler.
  32  *
  33  * Revision 1.42  1998/11/30 04:52:14  robertj
  34  * New directory structure
  35  *
  36  * Revision 1.41  1998/10/13 14:06:35  robertj
  37  * Complete rewrite of memory leak detection code.
  38  *
  39  * Revision 1.40  1998/09/23 06:29:35  robertj
  40  * Added open source copyright license.
  41  *
  42  * Revision 1.39  1996/07/15 10:34:03  robertj
  43  * Fixed uninitialised variable.
  44  *
  45  * Revision 1.38  1996/06/10 11:28:27  robertj
  46  * Changes for better C++ compatibility.
  47  *
  48  * Revision 1.37  1996/04/30 12:33:48  robertj
  49  * Changed "inPixels" boolean to enum for three coordinate systems.
  50  *
  51  * Revision 1.36  1995/10/14 15:06:56  robertj
  52  * Fixed bug in changing fonts on status bar.
  53  *
  54  * Revision 1.35  1995/08/12 22:32:43  robertj
  55  * Fixed setting of foreground/background colours with adjusted DrawBevelledRect().
  56  *
  57  * Revision 1.34  1995/07/31 12:13:01  robertj
  58  * Added balloon help string to toolbar button codes.
  59  *
  60  * Revision 1.33  1995/06/04 12:38:24  robertj
  61  * Redesign to add vertical tool bars and control wrapping.
  62  *
  63  * Revision 1.32  1995/04/25 11:28:13  robertj
  64  * Fixed Borland compiler warnings.
  65  *
  66  * Revision 1.31  1995/04/03 11:21:31  robertj
  67  * Fixed SetSectionText.
  68  *
  69  * Revision 1.30  1995/04/02 09:27:26  robertj
  70  * Added "balloon" help.
  71  *
  72  * Revision 1.29  1995/03/22 13:50:58  robertj
  73  * Split SetText() to separate function for SetSectionText() to guarentee that
  74  *     the parameters can be resolved.
  75  *
  76  * Revision 1.28  1995/02/19  04:19:19  robertj
  77  * Added dynamically linked command processing.
  78  *
  79  * Revision 1.27  1995/01/21  05:20:54  robertj
  80  * Allowed callback functions on button bar buttons.
  81  * Made disabled icon default to enabled icon.
  82  *
  83  * Revision 1.26  1995/01/18  09:04:23  robertj
  84  * Added initialiser arrays for button bar and status bar.
  85  *
  86  * Revision 1.25  1995/01/15  04:53:08  robertj
  87  * Fixed problems with stdarg and PString parameter on GNU compiler.
  88  *
  89  * Revision 1.24  1995/01/10  11:44:12  robertj
  90  * Removed PString parameter in stdarg function for GNU C++ compatibility.
  91  *
  92  * Revision 1.23  1995/01/06  10:43:55  robertj
  93  * Changed PRealFont usage from pointer to reference.
  94  *
  95  * Revision 1.22  1994/12/14  11:17:14  robertj
  96  * Changed PDIMENSION to be unsigned causing untold number of changes.
  97  *
  98  * Revision 1.21  1994/11/28  23:30:21  robertj
  99  * Added Update() call whenever a status bar section text is changed.
 100  *
 101  * Revision 1.21  1994/11/28  12:44:37  robertj
 102  * Added Update() after a change of status bar text to guarentee that it is visible at
 103  *   the time of setting. But only if the string changes!
 104  *
 105  * Revision 1.20  1994/10/30  11:47:10  robertj
 106  * Changed mechanism for doing notification callback functions.
 107  *
 108  * Revision 1.19  1994/08/21  23:43:02  robertj
 109  * Changed parameter before variable argument list to NOT be a reference.
 110  *
 111  * Revision 1.18  1994/08/15  07:02:42  robertj
 112  * Optimised status bar with transparent text display.
 113  *
 114  * Revision 1.17  1994/08/01  03:41:24  robertj
 115  * Use of PNEW instead of new for heap debugging. Need undef for Unix end.
 116  *
 117  * Revision 1.16  1994/07/27  05:58:07  robertj
 118  * Synchronisation.
 119  *
 120  * Revision 1.15  1994/06/25  11:55:15  robertj
 121  * Unix version synchronisation.
 122  *
 123  * Revision 1.14  1994/04/20  12:17:44  robertj
 124  * assert changes
 125  *
 126  * Revision 1.13  1994/04/01  14:00:00  robertj
 127  * Fixed SetDimensions change bug
 128  * ..
 129  *
 130  * Revision 1.12  1994/03/07  07:47:00  robertj
 131  * Major upgrade
 132  *
 133  * Revision 1.11  1994/01/15  02:52:02  robertj
 134  * Mac compatibilty changes (no nested classes).
 135  *
 136  * Revision 1.10  1994/01/13  03:36:48  robertj
 137  * Created intermediate class PInteractorLayout for dialog-ish windows.
 138  *
 139  * Revision 1.9  1994/01/03  10:17:10  robertj
 140  * Changed IsAncestor mechanism.
 141  * ..
 142  *
 143  * Revision 1.8  1993/12/31  06:49:35  robertj
 144  * Added PImgIcon class.
 145  *
 146  * Revision 1.7  1993/12/04  05:21:59  robertj
 147  * Moved code from pwlib.inl
 148  *
 149  * Revision 1.6  1993/12/01  16:09:05  robertj
 150  * Windows NT port.
 151  *
 152  * Revision 1.5  1993/11/20  17:26:28  robertj
 153  * Change of button picture from PImage to PPixels
 154  *
 155  * Revision 1.4  1993/08/27  18:17:47  robertj
 156  * Fixed bars code to use the new canvas function for drawing bevelled areas.
 157  *
 158  * Revision 1.3  1993/08/21  17:09:50  robertj
 159  * Added checking of enabled menu in button bar selections.
 160  * Fixed problem with G++ compatibility in temprary string object creation.
 161  *
 162  * Revision 1.2  1993/08/21  01:50:33  robertj
 163  * Made Clone() function optional, default will assert if called.
 164  *
 165  * Revision 1.1  1993/08/21  01:07:35  robertj
 166  * Initial revision
 167  *
 168  */
 169
 170 #ifdef __GNUC__
 171 #pragma implementation "toolbars.h"
 172 #endif
 173
 174 #include <pwlib.h>
 175 #include <pwclib/toolbars.h>
 176
 177 #define new PNEW
 178
 179
 180 //////////////////////////////////////////////////////////////////////////////
 181 // PToolBar
 182
 183 PToolBar::PToolBar(PInteractor * parent, BOOL vertical, BOOL autoWrap)
 184   : PInteractorLayout(parent),
 185     positionDown(vertical),
 186     wrapControls(autoWrap)
 187 {
 188   margin = owner->GetBorderSize()*3;
 189   if (positionDown)
 190     margin.SetHeight(margin.Height()*2);
 191   else
 192     margin.SetWidth(margin.Width()*2);
 193   SetForegroundColour(owner->GetButtonFgColour());
 194   SetBackgroundColour(owner->GetButtonBkColour());
 195 }
 196
 197
 198 void PToolBar::OnRedraw(PCanvas & canvas)
 199 {
 200   canvas.SetMappingRect(canvas.GetViewportRect());
 201   PRect bounds = canvas.GetDrawingBounds();
 202   canvas.DrawBevelledRect(bounds, TRUE, FALSE);
 203 }
 204
 205
 206 PBalloon * PToolBar::OnBalloonHelp()
 207 {
 208   return owner->DoBalloonHelp(NULL, 2);
 209 }
 210
 211
 212 void PToolBar::AddControl(PControl * control,
 213                                     PDIMENSION gapSize, PDIMENSION elasticity)
 214 {
 215   item.Append(new BarItem(PAssertNULL(control), gapSize, elasticity));
 216
 217   PDim myDim = GetDimensions(PixelCoords);
 218   PDim ctlDim = control->GetDimensions(PixelCoords);
 219
 220   ctlDim += margin*2;
 221
 222   if (ctlDim.Width() > myDim.Width())
 223     myDim.SetWidth(ctlDim.Width());
 224
 225   if (ctlDim.Height() > myDim.Height())
 226     myDim.SetHeight(ctlDim.Height());
 227
 228   SetDimensions(myDim.Width(), myDim.Height(), PixelCoords);
 229 }
 230
 231
 232 void PToolBar::_SetDimensions(PDIMENSION width, PDIMENSION height,
 233                               CoordinateSystem coords)
 234 {
 235   PInteractorLayout::_SetDimensions(width, height, coords);
 236   DoControlGeometry();
 237 }
 238
 239
 240 void PToolBar::DoControlGeometry()
 241 {
 242   PDim myDim = GetDimensions(PixelCoords);
 243   PDIMENSION barSize = positionDown ? myDim.Height() : myDim.Width();
 244   PDIMENSION marginSize = positionDown ? margin.Height() : margin.Width();
 245
 246   PDIMENSION maxSize = 0;
 247   PDIMENSION fixedSize = 0;
 248   PDIMENSION propTotal = 0;
 249   PINDEX i;
 250   for (i = 0; i < item.GetSize(); i++) {
 251     PDim ctlDim = item[i].control->GetDimensions(PixelCoords);
 252     if (item[i].elasticity > 0)
 253       propTotal += item[i].elasticity;
 254     else
 255       fixedSize += positionDown ? ctlDim.Height() : ctlDim.Width();
 256     fixedSize += item[i].gapSize*marginSize;
 257     if (positionDown) {
 258       if (maxSize < ctlDim.Width())
 259         maxSize = ctlDim.Width();
 260     }
 261     else {
 262       if (maxSize < ctlDim.Height())
 263         maxSize = ctlDim.Height();
 264     }
 265   }
 266
 267   PDIMENSION elasticUnit = 0;
 268   if (propTotal > 0) {
 269     elasticUnit = (barSize - fixedSize - marginSize*2)/propTotal;
 270     if (elasticUnit < 10)
 271       elasticUnit = 10;
 272   }
 273
 274   PPoint ctlPos = margin;
 275   for (i = 0; i < item.GetSize(); i++) {
 276     PDim ctlDim = item[i].control->GetDimensions(PixelCoords);
 277
 278     if (item[i].elasticity > 0) {
 279       if (positionDown)
 280         ctlDim.SetHeight(item[i].elasticity*elasticUnit);
 281       else
 282         ctlDim.SetWidth(item[i].elasticity*elasticUnit);
 283       item[i].control->SetDimensions(ctlDim, PixelCoords);
 284     }
 285
 286     if (wrapControls) {
 287       if (positionDown) {
 288         if (ctlPos.Y() + ctlDim.Height() > myDim.Height()) {
 289           ctlPos.SetX(maxSize + margin.Width());
 290           ctlPos.SetY(margin.Height());
 291         }
 292       }
 293       else {
 294         if (ctlPos.X() + ctlDim.Width() > myDim.Width()) {
 295           ctlPos.SetX(margin.Width());
 296           ctlPos.SetY(maxSize + margin.Height());
 297         }
 298       }
 299     }
 300
 301     item[i].control->SetPosition(ctlPos, TopLeftPixels, TopLeftPixels);
 302
 303     if (positionDown)
 304       ctlPos.SetY(ctlPos.Y() + ctlDim.Height() + item[i].gapSize*marginSize);
 305     else
 306       ctlPos.SetX(ctlPos.X() + ctlDim.Width() + item[i].gapSize*marginSize);
 307   }
 308 }
 309
 310
 311 //////////////////////////////////////////////////////////////////////////////
 312 // PButtonBar
 313
 314 PButtonBar::PButtonBar(PInteractor *parent,
 315              const ButtonID *IDs, PINDEX numIDs, BOOL vertical, BOOL autoWrap)
 316   : PToolBar(parent, vertical, autoWrap)
 317 {
 318   AddButtons(IDs, numIDs);
 319 }
 320
 321
 322 void PButtonBar::AddButtons(const ButtonID * IDs, PINDEX numIDs)
 323 {
 324   // Calculate the maximum button size so far in bar.
 325   PDIMENSION max_x = 0;
 326   PDIMENSION max_y = 0;
 327   PINDEX i;
 328   for (i = 0; i < GetNumChildren(); i++) {
 329     if (children[i].IsDescendant(PImageButton::Class())) {
 330       PDim dim = children[i].GetDimensions(PixelCoords);
 331       if (max_x < dim.Width())
 332         max_x = dim.Width();
 333       if (max_y < dim.Height())
 334         max_y = dim.Height();
 335     }
 336   }
 337
 338   // Add in the new buttons, increasing the maximum size
 339   for (i = 0; i < numIDs; i++) {
 340     if (IDs[i].commandName != NULL || IDs[i].menuItem != 0) {
 341       PRESOURCE_ID img1 = IDs[i].enabledImage;
 342       if (img1 == 0)
 343         img1 = IDs[i].menuItem;
 344       PRESOURCE_ID img2 = IDs[i].disabledImage;
 345       if (img2 == 0)
 346         img2 = img1;
 347
 348       PPushButton * button;
 349       if (img1 != 0)
 350         button = new PImageButton(this, PImgIcon(img1), PImgIcon(img2));
 351       else
 352         button = new PImageButton(this);
 353
 354       button->SetControlID(IDs[i].menuItem);
 355
 356       if (IDs[i].commandName != NULL)
 357         button->SetNotifier(PCREATE_COMMAND(IDs[i].commandName), TRUE);
 358
 359       PRESOURCE_ID help = IDs[i].balloonHelp;
 360       if (help == 0)
 361         help = IDs[i].menuItem;
 362       if (help != 0) {
 363         PResourceString str(help);
 364         button->SetBalloonHelp(str);
 365       }
 366
 367       button->Show();
 368
 369       PDim dim = button->GetDimensions(PixelCoords);
 370       if (max_x < dim.Width())
 371         max_x = dim.Width();
 372       if (max_y < dim.Height())
 373         max_y = dim.Height();
 374     }
 375   }
 376
 377   for (i = 0; i < numIDs; i++) {
 378     if (IDs[i].commandName != NULL || IDs[i].menuItem != 0) {
 379       PControl * button = GetControl(IDs[i].menuItem);
 380       PAssertNULL(button)->SetDimensions(max_x, max_y, PixelCoords);
 381       int gaps = 1;
 382       while (i+gaps < numIDs &&
 383                 (IDs[i+gaps].commandName == NULL && IDs[i+gaps].menuItem == 0))
 384         gaps++;
 385       AddControl(button, gaps-1);
 386     }
 387   }
 388 }
 389
 390
 391 void PButtonBar::OnControlNotify(PControl & control, int code)
 392 {
 393   PInteractorLayout::OnControlNotify(control, code);
 394
 395   if (control.GetNotifier().IsNULL()) {
 396     PInteractor * p = parent;
 397     while (p->GetParent() != NULL)
 398       p = p->GetParent();
 399     PTopLevelWindow * mainWindow = (PTopLevelWindow *)p;
 400     mainWindow->OnMenuStartSelect();
 401     PRootMenu * menu = mainWindow->GetMenu();
 402     if (menu != NULL) {
 403       PMenuItem * item = menu->GetItemFromKey(control.GetControlID());
 404       if (item != NULL && item->IsEnabled())
 405         mainWindow->OnMenuItemSelect(*item);
 406     }
 407   }
 408 }
 409
 410
 411
 412 //////////////////////////////////////////////////////////////////////////////
 413 // PStatusBar
 414
 415 PStatusBar::PStatusBar(PInteractor * parent, PINDEX numSections)
 416   : PToolBar(parent)
 417 {
 418   PDIMENSION width =
 419        parent->GetDimensions(PixelCoords).Width()/numSections - margin.Width();
 420   PDIMENSION height = font.GetHeight(TRUE) + margin.Height();
 421   for (PINDEX i = 0; i < numSections; i++) {
 422     Section * s = new Section(this);
 423     s->SetDimensions(width, height, PixelCoords);
 424     AddControl(s, i < numSections-1, 1);
 425   }
 426 }
 427
 428
 429 void PStatusBar::SetFont(const PFont & newFont, BOOL toChildren)
 430 {
 431   PToolBar::SetFont(newFont, toChildren);
 432
 433   PDIMENSION height = font.GetHeight(TRUE) + margin.Height();
 434   for (PINDEX i = 0; i < item.GetSize(); i++)
 435     item[i].control->SetDimensions(1, height, PixelCoords);
 436
 437   DoControlGeometry();
 438
 439   height += margin.Height()*2;
 440   SetDimensions(GetDimensions(ScreenCoords).Width(), height, PixelCoords);
 441 }
 442
 443
 444 void PStatusBar::SetText(const PString & str)
 445 {
 446   SetSectionText(0, str);
 447 }
 448
 449
 450 void PStatusBar::SetText(PRESOURCE_ID resId, ...)
 451 {
 452   va_list args;
 453   va_start(args, resId);
 454   PString str;
 455   PResourceString fmt(resId);
 456   str.vsprintf(fmt, args);
 457   SetSectionText(0, str);
 458 }
 459
 460
 461 void PStatusBar::SetText(const char * fmt, ...)
 462 {
 463   va_list args;
 464   va_start(args, fmt);
 465   PString str;
 466   str.vsprintf(fmt, args);
 467   SetSectionText(0, str);
 468 }
 469
 470
 471 void PStatusBar::SetSectionText(PINDEX section, const PString & str)
 472 {
 473   Section & s = GetSection(section);
 474   if (s.GetName() != str) {
 475     s.SetName(str);
 476     s.Update();
 477   }
 478 }
 479
 480
 481 void PStatusBar::SetSectionText(PINDEX section, PRESOURCE_ID resId, ...)
 482 {
 483   va_list args;
 484   va_start(args, resId);
 485   PResourceString fmt(resId);
 486   SetSectionText(section, pvsprintf(fmt, args));
 487 }
 488
 489
 490 void PStatusBar::SetSectionText(PINDEX section, const char * fmt, ...)
 491 {
 492   va_list args;
 493   va_start(args, fmt);
 494   SetSectionText(section, pvsprintf(fmt, args));
 495 }
 496
 497
 498 void PStatusBar::SetSectionAlignment(PINDEX section,
 499                                               PCanvas::DrawStringOptions align)
 500 {
 501   GetSection(section).SetAlignment(align);
 502 }
 503
 504
 505 void PStatusBar::SetSectionWidth(PINDEX section, const PString & longestString)
 506 {
 507   SetSectionWidth(section,
 508                        PDrawCanvas(this).MeasureString(longestString).Width());
 509 }
 510
 511
 512 void PStatusBar::SetSectionWidth(PINDEX section,
 513                                   const PRESOURCE_ID * strIDs, PINDEX nStrings)
 514 {
 515   PDrawCanvas canvas(this);
 516   PDIMENSION max = 0;
 517   for (PINDEX i = 0; i < nStrings; i++) {
 518     PDIMENSION width=canvas.MeasureString(PResourceString(strIDs[i])).Width();
 519     if (max < width)
 520       max = width;
 521   }
 522   SetSectionWidth(section, max);
 523 }
 524
 525
 526 void PStatusBar::SetSectionWidth(PINDEX section, int width)
 527 {
 528   Section & s = GetSection(section);
 529
 530   if (width > 0)
 531     s.SetDimensions(width, s.GetDimensions(LocalCoords).Height(), LocalCoords);
 532
 533   item[section].elasticity = width < 0 ? -width : 0;
 534
 535   SetDimensions(GetDimensions(LocalCoords), LocalCoords);
 536 }
 537
 538
 539 PStatusBar::Section & PStatusBar::GetSection(PINDEX section) const
 540 {
 541   PInteractor & s = *item[section].control;
 542   PAssert(s.IsDescendant(Section::Class()), PInvalidParameter);
 543   return (Section &)s;
 544 }
 545
 546
 547 PStatusBar::Section::Section(PInteractor * parent)
 548   : PStaticText(parent)
 549 {
 550   SetBackgroundColour(owner->GetButtonBkColour());
 551   Show();
 552 }
 553
 554
 555 void PStatusBar::Section::OnRedraw(PCanvas & canvas)
 556 {
 557   canvas.SetMappingRect(canvas.GetViewportRect());
 558   PRect bounds = canvas.GetDrawingBounds();
 559   canvas.DrawBevelledRect(bounds, FALSE, FALSE);
 560   bounds.Inflate(-1, -1);
 561   canvas.SetTextFgColour(owner->GetButtonFgColour());
 562   canvas.SetTextBkColour(PColour(0,0,0,0));
 563   canvas.DrawString(bounds, GetName(), alignment);
 564 }
 565
 566
 567 // End Of File ///////////////////////////////////////////////////////////////