decframe.cpp

Go to the documentation of this file.

//----------------------------------------------------------------------------
// ObjectWindows
// Copyright (c) 1992, 1996 by Borland International, All Rights Reserved
//
/// \file
/// Implementation of class TDecoratedFrame
//----------------------------------------------------------------------------
#include <owl/pch.h>
 
#include <owl/decframe.h>
#include <owl/messageb.h>
#include <owl/tooltip.h>
#include <owl/controlb.h>
#include <owl/functor.h>
#include <owl/bardescr.h>
#include <algorithm>
 
#if defined(__BORLANDC__)
# pragma option -w-ccc // Disable "Condition is always true/false"
#endif
 
using namespace std;
 
namespace owl {
 
OWL_DIAGINFO;
DIAG_DECLARE_GROUP(OwlWin);   // diagnostic group for windows
DIAG_DECLARE_GROUP(OwlCmd);   // diagnostic group for commands
 
 
DEFINE_RESPONSE_TABLE2(TDecoratedFrame, TFrameWindow, TLayoutWindow)
  EV_WM_ENTERIDLE,
  EV_WM_MENUSELECT,
  EV_WM_SIZE,
END_RESPONSE_TABLE;
 
const uint  BLANK_HELP = UINT_MAX;
 
//
//
//
static TGadgetWindow* CreateToolBar(TWindow* wnd)
{
  return new TControlBar(wnd);
}
 
bool EvBarInserter(TDecoratedFrame& frame, TGadgetWindow& destWindow, TAbsLocation loc)
{
  if(frame.GetHandle())
    destWindow.Create();
  frame.Insert(destWindow, TDecoratedFrame::TLocation(loc));
  return true;
}
 
//
/// Constructs a TDecoratedFrame object with the specified parent window (parent),
/// window caption (title), and module ID. Sets TWindow::Attr.Title to the new
/// title. Passes a pointer to the client window if one is specified. By default set
/// to false, trackMenuSelection controls whether hint text appears at the bottom of
/// the window when a menu item is highlighted.
//
TDecoratedFrame::TDecoratedFrame(TWindow*        parent,
                                 LPCTSTR         title,
                                 TWindow*        clientWnd,
                                 bool            trackMenuSelection,
                                 TModule*        module)
:
  TLayoutWindow(parent, title, module)
{
  Init(parent, title, clientWnd, trackMenuSelection, module);
}
 
//
/// String-aware overload
//
TDecoratedFrame::TDecoratedFrame(TWindow* parent, const tstring& title, TWindow* client, bool trackMenuSelection, TModule* module)
  : TLayoutWindow(parent, title, module)
{
  Init(parent, title.c_str(), client, trackMenuSelection, module);
}
 
//
/// Initialization shared by the constructors
//
void TDecoratedFrame::Init(TWindow* parent, LPCTSTR title, TWindow* clientWnd, bool trackMenuSelection, TModule* module)
{
  // Initialize virtual bases, in case the derived-most used default ctor
  //
  TWindow::Init(parent, title, module);
  TFrameWindow::Init(clientWnd, false);
 
  TLayoutMetrics  metrics;
 
  TrackMenuSelection = trackMenuSelection;
  MenuItemId = 0;
  SettingClient   = false;
  BarCreatorFunct = new TGadgetWndFunctor;
  BarInserterFunct = new TBarInsertFunctor;
  SetBarCreator(TGadgetWnd_FUNCTOR(CreateToolBar));
  SetBarInserter(TBarInsert_FUNCTOR(EvBarInserter));
 
 
  if (!ClientWnd)
    ClientWnd = new TWindow(this, _T("\007"));  // create dummy placeholder
 
  if (ClientWnd->GetWindowAttr().Style & WS_BORDER) {
    metrics.X.SameAs(lmParent, lmLeft);
    metrics.Y.SameAs(lmParent, lmTop);
    metrics.Width.SameAs(lmParent, lmRight);
    metrics.Height.SameAs(lmParent, lmBottom);
  }
  else {
    metrics.X.Set(lmLeft, lmRightOf, lmParent, lmLeft);
    metrics.Y.Set(lmTop, lmBelow, lmParent, lmTop);
    metrics.Width.Set(lmRight, lmLeftOf, lmParent, lmRight);
    metrics.Height.Set(lmBottom, lmAbove, lmParent, lmBottom);
  }
 
  SetChildLayoutMetrics(*ClientWnd, metrics);
}
 
//
//
//
TDecoratedFrame::~TDecoratedFrame()
{
  delete BarCreatorFunct;
  delete BarInserterFunct;
}
//
//
//
void TDecoratedFrame::SetBarCreator(const TGadgetWndFunctor& funct)
{
  *BarCreatorFunct = funct;
}
//
//
void TDecoratedFrame::SetBarInserter(const TBarInsertFunctor& funct)
{
  *BarInserterFunct = funct;
}
//
/// Override SetupWindow in order to layout & position decorations
/// Calls TLayoutWindow::Layout to size and position the decoration.
//
void
TDecoratedFrame::SetupWindow()
{
  TFrameWindow::SetupWindow();
 
  // Size/position child windows. Don't wait until we get the WM_SIZE event
  // because by then the windows will have been displayed on the screen
  //
  TRect  clientRect = GetClientRect();
 
  ClientSize.cx = clientRect.right;
  ClientSize.cy = clientRect.bottom;
 
  if(IsFlagSet(wfMainWindow) && GetBarDescr())
    CreateBar();
   Layout();
}
 
//
//
//
void
TDecoratedFrame::CleanupWindow()
{
  TFrameWindow::CleanupWindow();
 
  if (!GetBarDescr())
    return;
  TGadgetWindow* toolBar = GetControlBar();
  if(toolBar) // already created
    ((TBarDescr*)GetBarDescr())->RemoveGadgets(*toolBar);
}
 
//
/// Overrides TFrameWindows virtual function. Sets the client window to the
/// specified window. Users are responsible for destroying the old client window if
/// they want to remove it.
//
/// Handle SetClientWindow() here to manage fixing up the layout metrics of
/// all the children before & after the client is changed.
//
TWindow*
TDecoratedFrame::SetClientWindow(TWindow* clientWnd)
{
  TLayoutMetrics metrics;
  GetChildLayoutMetrics(*ClientWnd, metrics);
  if (!clientWnd)
    clientWnd = new TWindow(this, _T("\007"));  // create dummy placeholder
 
  clientWnd->SetParent(this);
  SetChildLayoutMetrics(*clientWnd, metrics);
 
  TWindow* oldWnd = GetClientWindow();
 
  // Make sure that all child metrics that were based on the old client window
  // get updated to the new client
  //
  TWindow* first = GetFirstChild();
  if (first) {
    TWindow* child = first;
    do {
      if (GetChildLayoutMetrics(*child, metrics)) {
        if (metrics.X.RelWin == oldWnd)
          metrics.X.RelWin = clientWnd;
        if (metrics.Y.RelWin == oldWnd)
          metrics.Y.RelWin = clientWnd;
        if (metrics.Width.RelWin == oldWnd)
          metrics.Width.RelWin = clientWnd;
        if (metrics.Height.RelWin == oldWnd)
          metrics.Height.RelWin = clientWnd;
        SetChildLayoutMetrics(*child, metrics);
      }
      child = child->Next();
    } while (child != first);
  }
 
  // Now let the TFrameWindow set the client. Then delete the old client if it
  // was our temporary place holder. Set a flag while the client is being set
  // so that RemoveChild() below knows that we are taking care of things.
  //
  SettingClient = true;
  oldWnd = TFrameWindow::SetClientWindow(clientWnd);
  SettingClient = false;
 
  if (oldWnd->GetCaption() && oldWnd->GetCaption()[0] == 007) {
    oldWnd->Destroy();
    delete oldWnd;
    oldWnd = nullptr;
  }
 
  // Relayout the children to get the new client sized right
  //
  Layout();
 
  return oldWnd;
}
 
//
/// Makes sure that both bases get a chance to see the child removed. TWindow's will
/// be called twice, but the second call will be ignored. If the client is being
/// removed and the client is not currently being set, then this function calls
/// SetClientWindow to put in a placeholder.
//
void
TDecoratedFrame::RemoveChild(TWindow* child)
{
  if (child == ClientWnd && !SettingClient)
    SetClientWindow(nullptr);
  TFrameWindow::RemoveChild(child);
  TLayoutWindow::RemoveChild(child);
}
 
//
/// Give the decorations an opportunity to do pre-processing. Don't bother
/// checking the client window since it is typically in the focus chain and
/// will be given an opportunity to do pre-processing
//
bool
TDecoratedFrame::PreProcessMsg(MSG& msg)
{
  TWindow*  firstChild = GetFirstChild();
 
  if (firstChild) {
    TWindow*  child = firstChild;
 
    do {
      if (child != ClientWnd && child->GetHandle() &&
         (child->GetWindowLong(GWL_STYLE) & WS_VISIBLE) &&
          child->PreProcessMsg(msg))
        return true;
 
      child = child->Next();
    } while (child != firstChild);
  }
 
  return TFrameWindow::PreProcessMsg(msg);
}
 
//
/// Retrieves the text specified by the resource id.
/// If hintType equals htToolTip, GetHintText first searches for
/// id in the menu strings. If the id cannot be found in the menu strings,
/// GetHintText looks for the id in the resource strings. If hintType equal
/// htStatus, GetHintText looks for the id in the module's resource strings.
//
tstring
TDecoratedFrame::GetHintText(uint id, THintText hintType) const
{
  if (id == static_cast<uint>(-1))
    return tstring();
 
  tchar buf[4096];
  const int size = COUNTOF(buf);
  if (hintType == htTooltip)
  {
    // For tooltips, we first look if the same id exists on the
    // window's menu and use the associated menu string.
    //
    if (::IsMenu(GetMenu()) &&
      TUser::GetMenuString(GetMenu(), id, &buf[0], size, MF_BYCOMMAND))
    {
      // Trim accelerator text e.g., '\tCtrl+X' (if any)
      //
      LPTSTR c = _tcschr(buf, _T('\t'));
      if (c)
        *c = 0;
 
      // Accelerator can be \b instead of \t (NOTE: \a in .rc make a \b
      // in res)
      //
      c = _tcschr(buf, _T('\b'));
      if (c)
        *c = 0;
 
      // Trim trailing dots, e.g., '...' (if any)
      //
      int i;
      for (i = static_cast<int>(::_tcslen(buf)) - 1; i >= 0; i--)
        if (buf[i] == _T('.'))
          buf[i] = 0;
        else
          break;
 
#if defined(BI_DBCS_SUPPORT)
      // Trim trailing access key, e.g., '(&N)' (if any)
      //
      if (i >= 3 && buf[i-3] == '(' && buf[i-2] == '&' && buf[i] == ')')
        buf[i-3] = 0;
#endif
      // Eliminate '&' (just emliminate first one)
      //
      i = -1;
      while(buf[++i])
        if (buf[i] == _T('&')) {
          do {
            buf[i] = buf[i+1];
            i++;
          } while (buf[i]);
          break;
        }
      return tstring(&buf[0]);
    }
    else
    {
      // If the tip text cannot be retrieved from the menu, we then look
      // for a string resource - The resource is expected to contain a
      // longer status text followed by a '\n' and the tip text.
      //
      tchar resStr[256];
      int len = GetModule()->LoadString(id, resStr, 256);
      if (len == 0 && MergeModule != nullptr)
          len = MergeModule->LoadString(id, resStr, 256);
 
      WARNX(OwlWin, len == 0, 0,
          _T("TDecoratedFrame::GetHintText LoadString(")
          << *GetModule() << _T(",") << id << _T(") Failed"));
 
      LPTSTR pLF;
      if (len && (pLF = _tcschr(resStr, _T('\n'))) != nullptr)
      {
        return tstring(pLF + 1);
      }
    }
  }
 
  if (hintType == htStatus) {
    int numBytes = GetModule()->LoadString(id, buf, size);
    if (numBytes == 0 && MergeModule != nullptr)
        numBytes = MergeModule->LoadString(id, buf, size);
 
    WARNX(OwlWin, numBytes == 0, 0,
         _T("TDecoratedFrame::GetHintText LoadString(")
         << *GetModule() << _T(",") << id << _T(") Failed"));
 
    if (numBytes)
    {
      // Clear beyond the '\n' in case this string resource contains both
      // a status and a tooltip hint text.
      //
      LPTSTR pLF = _tcschr(buf, _T('\n'));
      if (pLF)
        *pLF = 0;
      return tstring(&buf[0]);
    }
  }
  return tstring();
}
 
 
//
/// Responds to user menu selection. If MenuItemId is blank, displays an empty help
/// message; otherwise, it displays a help message with the specified string ID. See
/// EvEnterIdle for a description of how the help message is loaded.
//
/// Handle WM_MENUSELECT to provide hint text in the status bar based on the
/// menu item id. Treat popup items seperatly and ask them for their ids.
//
void
TDecoratedFrame::EvMenuSelect(uint menuItemId, uint flags, HMENU hMenu)
{
  if (TrackMenuSelection) {
    if (flags == 0xFFFF && hMenu == nullptr) {  // Menu closing
      TMessageBar*  messageBar = TYPESAFE_DOWNCAST(ChildWithId(IDW_STATUSBAR),
                                                   TMessageBar);
      if (messageBar)
        messageBar->ClearHintText();
      MenuItemId = 0;
    }
    else if (flags & MF_POPUP) {
 
#if 0 // !BB
// !BB  TMenu popupMenu(hMenu);
// !BB  int   count = popupMenu.GetMenuItemCount();
// !BB  int   pos = 0;
// !BB  for (;pos < count && popupMenu.GetSubMenu(pos) != HMENU(menuItemId);
// !BB       pos++)
// !BB    ;
// !BB  MenuItemId = popupMenu.GetMenuItemID(pos);
    // !BB
    // !BB The above logic seems suspicious - The docs. seem to imply that
    // !BB if (flags & MF_POPUP) then popup = GetSubMenu(hMenu, menuItemId);
    // !BB I don't understand why we iterate through the menu when we have the
    // !BB index. i.e. menuItemId is then an index not an HMENU as used above.
    // !BB Also, there's no check to prevent the case where the for loop would
    // !BB break until 'pos == count'. CodeGuard points out that the
    // !BB eventual '::GetMenuItemID' call does indeed fail in these cases
    // !BB given that 'pos' is out of range.
    // !BB
#else
      // Retrieve id of popup menu
      //
      MenuItemId = TMenu(hMenu).GetMenuItemID(menuItemId);
#endif
    }
    else if (flags & (MF_SEPARATOR | MF_MENUBREAK | MF_MENUBARBREAK)
#if 0  // changed by Y.B 5/23/98
      || (menuItemId >= IDW_FIRSTMDICHILD && menuItemId < IDW_FIRSTMDICHILD+9)) {
#else
      ){
#endif
      MenuItemId = BLANK_HELP;  // display an empty help message
                                // could also restore bar at this point too
    }
    else {
      MenuItemId = menuItemId;  // display a help message with this string Id
    }
  }
}
 
//
/// Forward our size event to the layout window base, and not the frame base
//
void
TDecoratedFrame::EvSize(uint sizeType, const TSize& size)
{
  TLayoutWindow::EvSize(sizeType, size);
 
  // Since TFrameWindow::EvSize wasn't called, broadcast
  // relevant info to children explicitly.
  //
  TFrameWindow::BroadcastResizeToChildren(sizeType, size);
}
 
//
/// Responds to a window message that tells an application's main window that a
/// dialog box or a menu is entering an idle state. EvEnterIdle also handles
/// updating the status bar with the appropriate help message.
//
/// Handle WM_ENTERIDLE in order to display help hints on the messsage bar if
/// there is a hint pending & this frame has a message bar.
//
void
TDecoratedFrame::EvEnterIdle(uint source, HWND hDlg)
{
  if (source == MSGF_MENU && MenuItemId) {
    TMessageBar*  messageBar = TYPESAFE_DOWNCAST(ChildWithId(IDW_STATUSBAR),
                                                 TMessageBar);
    if (messageBar)
    {
      tstring hint;
      if (MenuItemId != BLANK_HELP)
        hint = GetHintText(MenuItemId, htStatus);
      messageBar->SetHintText(hint);
    }
    MenuItemId = 0;             // Don't repaint on subsequent EvEnterIdle's
  }
  TFrameWindow::EvEnterIdle(source, hDlg);
}
 
namespace {
 
//
// Get or set location codes stashed in the style long for a decoration
//
const uint32 locMask = 0x0F00;
const int    locShift = 8;
 
TDecoratedFrame::TLocation GetLocation_(TWindow& w)
{
  return TDecoratedFrame::TLocation(uint16((w.GetWindowAttr().Style & locMask) >> locShift));
}
 
void SetLocation_(TWindow& w, TDecoratedFrame::TLocation loc)
{
  w.GetWindowAttr().Style = (w.GetWindowAttr().Style & ~locMask) | (uint32(loc) << locShift);
}
 
} // namespace
 
//
/// Automates hiding and showing of decorations.
//
TResult
TDecoratedFrame::EvCommand(uint id, HWND hWndCtl, uint notifyCode)
{
  TRACEX(OwlCmd, 1, _T("TDecoratedFrame:EvCommand - id(") << id << _T("), ctl(") <<\
    static_cast<void*>(hWndCtl) << _T("), code(") << notifyCode  << _T(")"));
 
  // Check if it's a menu-style command (i.e. skip commands from Controls)
  //
  if (hWndCtl == nullptr) {
 
    // Does the command Id correspond to the Id of one of our children
    //
    TWindow*  decoration = ChildWithId(id);
 
    // If yes, toggle it's visibility
    //
    if (decoration) {
      bool visible = decoration->IsWindowVisible();
 
      // If it's visible, remove it's layout metrics - We'll 'Layout' below
      // and toggle the actual visibility of the child below.
      //
      if (visible) {
        RemoveChildLayoutMetrics(*decoration);
      }
      else {
 
        // Check if decoration wants to be against the frame's edge
        //
        bool insertAtEdge = decoration->IsFlagSet(wfInsertAtEdge);
 
        // We want to display this child window, first retrieve it's location
        //
        TLocation location = GetLocation_(*decoration);
 
        // Find the decoration it should be adjacent to.
        //
        struct TSiblingSearch
        {
          TWindow* Decoration;
          TDecoratedFrame::TLocation Location;
          TWindow* Sibling;
 
          TSiblingSearch(TWindow* d, TDecoratedFrame::TLocation loc)
            : Decoration(d), Sibling(nullptr), Location(loc)
          {}
        };
        TSiblingSearch search(decoration, location);
        if (insertAtEdge)
        {
          auto c = GetChildren();
          const auto i = std::find_if(c.begin(), c.end(), [&](TWindow& w)
            { return ((&w != search.Decoration) && (GetLocation_(w) == search.Location)); });
          search.Sibling = (i != c.end()) ? &(*i) : nullptr;
        }
        else
          for (auto& w : GetChildren())
          {
            if (&w == search.Decoration)
              break;
 
            if (GetLocation_(w) == search.Location && w.IsWindowVisible())
              search.Sibling = &w;
          }
 
        // Default to client window if we could not find the decoration's
        // potential neighbor.
        //
        if (!search.Sibling)
          search.Sibling = ClientWnd;
 
        // Insert at its desired location
        //
        switch (location) {
          case None:
            break;
          case Top:
            InsertAtTop(*decoration, search.Sibling);
            break;
 
          case Bottom:
            InsertAtBottom(*decoration, search.Sibling);
            break;
 
          case Left:
            InsertAtLeft(*decoration, search.Sibling);
            break;
 
          case Right:
            InsertAtRight(*decoration, search.Sibling);
            break;
 
    default: //JJH added empty default statement
      break;
        }
      }
 
      // Force the layout manager to compute new locations and shuffle
      // windows around
      //
      Layout();
 
      // Hide or display the decoration
      //
      decoration->ShowWindow(visible ? SW_HIDE : SW_SHOWNA);
      return 0;
    }
  }
 
  return TFrameWindow::EvCommand(id, hWndCtl, notifyCode);
}
 
//
// !CQ Auto-hide all docking areas? Give them IDW_s
//
/// Handles checking and unchecking of menu items that are associated with
/// decorations.
//
void
TDecoratedFrame::EvCommandEnable(TCommandEnabler& commandEnabler)
{
  // Provide default command text to TooltipEnablers
  //
  if (dynamic_cast<TTooltipEnabler*>(&commandEnabler))
  {
    tstring hint = GetHintText(commandEnabler.GetId(), htTooltip);
    if (hint.length() > 0)
    {
      commandEnabler.SetText(hint);
      return;
    }
  }
 
  TWindow* decoration = ChildWithId(commandEnabler.GetId());
  if (!decoration)
    TFrameWindow::EvCommandEnable(commandEnabler);
  else
  {
    commandEnabler.Enable();
    commandEnabler.SetCheck(decoration->IsWindowVisible() ?
      TCommandEnabler::Checked : TCommandEnabler::Unchecked);
  }
}
 
//
/// Insert a decoration window at the top of the client area, possibly above
/// another given decoration or the client
//
void
TDecoratedFrame::InsertAtTop(TWindow& decoration, TWindow* insertAbove)
{
  TLayoutMetrics   metrics;
  TWindow*         insertBelow;
 
  // Get the layout metrics for "insertAbove" (the window the decoration is
  // going to be inserted above)
  //
  GetChildLayoutMetrics(*insertAbove, metrics);
 
  insertBelow = metrics.Y.RelWin;
 
  // If "insertAbove" has a border then set its top edge to be the same as
  // the decoration's bottom edge; otherwise place its top edge below the
  // decoration's bottom edge
  //
  metrics.Y.Set(lmTop,
                insertAbove->GetWindowAttr().Style & WS_BORDER ? lmSameAs : lmBelow,
                &decoration, lmBottom);
  SetChildLayoutMetrics(*insertAbove, metrics);
 
  // Now set the layout metrics for the decoration so its top edge is the same
  // as or below the bottom edge of "insertBelow" (they overlap if WS_BORDER)
  // !CQ want to use lmBelow if no border!?
  //
  bool overlap = (decoration.GetWindowAttr().Style & WS_BORDER);
 
  metrics.Y.Set(lmTop, overlap ? lmSameAs : lmBelow,
                insertBelow, insertBelow ? lmBottom : lmTop);
 
  metrics.Height.AsIs(lmHeight);
  metrics.X.Set(lmLeft, overlap ? lmSameAs : lmRightOf, lmParent, lmLeft);
  metrics.Width.Set(lmRight, overlap ? lmSameAs : lmLeftOf, lmParent, lmRight);
 
  SetChildLayoutMetrics(decoration, metrics);
}
 
//
/// Insert a decoration window at the bottom of the client area, possibly below
/// another given decoration or the client
//
void
TDecoratedFrame::InsertAtBottom(TWindow& decoration, TWindow* insertBelow)
{
  TLayoutMetrics  metrics;
  TWindow*        insertAbove;
 
  // Get the layout metrics for "insertBelow"(the window the decoration is
  // going to be inserted below)
  //
  GetChildLayoutMetrics(*insertBelow, metrics);
 
  if (insertBelow == ClientWnd) {
    insertAbove = metrics.Height.RelWin;
 
    // If the client window has a border then set the client window's bottom
    // to be the same as the top edge of the decoration; otherwise set the
    // client window's bottom edge to be above the decoration's top edge
    //
    metrics.Height.Set(lmBottom,
                       ClientWnd->GetWindowAttr().Style & WS_BORDER ? lmSameAs : lmAbove,
                       &decoration, lmTop);
  }
  else {
    insertAbove = metrics.Y.RelWin;
 
    // Set the bottom edge of "insertBelow" to be the same as the top edge of
    // the decoration
    //
    metrics.Y.Set(lmBottom, lmSameAs, &decoration, lmTop);
  }
  SetChildLayoutMetrics(*insertBelow, metrics);
 
  // Now set the layout metrics for the decoration so its bottom edge is the
  // same as the top edge of "insertAbove"
  //
  bool overlap = (decoration.GetWindowAttr().Style & WS_BORDER);
 
  metrics.Y.Set(lmBottom, overlap ? lmSameAs : lmAbove, insertAbove,
                insertAbove ? lmTop : lmBottom);
 
  metrics.Height.AsIs(lmHeight);
  metrics.X.Set(lmLeft, overlap ? lmSameAs : lmRightOf, lmParent, lmLeft);
  metrics.Width.Set(lmRight, overlap ? lmSameAs : lmLeftOf, lmParent, lmRight);
 
  SetChildLayoutMetrics(decoration, metrics);
}
 
//
/// Insert a decoration window at the left of the client area, possibly to the
/// left of another given decoration or the client
//
void
TDecoratedFrame::InsertAtLeft(TWindow& decoration, TWindow* insertLeftOf)
{
  TLayoutMetrics  metrics;
  TWindow*        insertRightOf;
 
  // Get the layout metrics for "insertLeftOf"(the window the decoration is
  // going to be inserted to the left of)
  //
  GetChildLayoutMetrics(*insertLeftOf, metrics);
 
  insertRightOf = metrics.X.RelWin;
 
  // If "insertLeftOf" has a border then set its left edge to be the same as
  // the decoration's right edge; otherwise place its left edge one pixel to
  // the right of the decoration's right edge
  //
  metrics.X.Set(lmLeft,
                insertLeftOf->GetWindowAttr().Style & WS_BORDER ? lmSameAs : lmRightOf,
                &decoration, lmRight);
  SetChildLayoutMetrics(*insertLeftOf, metrics);
 
  // Now set the layout metrics for the decoration so it's left edge is the
  // same as the right edge of "insertRightOf"
  //
  bool overlap = (decoration.GetWindowAttr().Style & WS_BORDER);
 
  metrics.X.Set(lmLeft, overlap ? lmSameAs : lmRightOf, insertRightOf,
                insertRightOf ? lmRight : lmLeft);
 
  metrics.Width.AsIs(lmWidth);
 
  // If the client window & decoration both have or don't have borders then
  // place the decoration so its "y" and "bottom" are the same as the client
  // windows; otherwise place its "y" above/below the client window's "y" and
  // its "bottom" below/above the client window's "bottom" based on who's has
  // borders & who doesn't
  //
  // This way if there are top or bottom decorations they will be tiled
  // over/under the left/right decorations
  //
  if (ToBool(ClientWnd->GetWindowAttr().Style & WS_BORDER) == overlap) {
    metrics.Y.SameAs(ClientWnd, lmTop);
    metrics.Height.SameAs(ClientWnd, lmBottom);
  }
  else if (overlap) {
    metrics.Y.Set(lmTop, lmAbove, ClientWnd, lmTop);
    metrics.Height.Set(lmBottom, lmBelow, ClientWnd, lmBottom);
  }
  else {
    metrics.Y.Set(lmTop, lmBelow, ClientWnd, lmTop);
    metrics.Height.Set(lmBottom, lmAbove, ClientWnd, lmBottom);
  }
  SetChildLayoutMetrics(decoration, metrics);
}
 
//
/// Insert a decoration window at the right of the client area, possibly to the
/// right of another given decoration or the client
//
void
TDecoratedFrame::InsertAtRight(TWindow& decoration, TWindow* insertRightOf)
{
  TLayoutMetrics  metrics;
  TWindow*        insertLeftOf;
 
  // Get the layout metrics for "insertRightOf" (the window the decoration is
  // going to be inserted to the right of)
  //
  GetChildLayoutMetrics(*insertRightOf, metrics);
 
  if (insertRightOf == ClientWnd) {
    insertLeftOf = metrics.Width.RelWin;
 
    // If the client window has a border then set the client window's right
    // edge to be the same as the left edge of the decoration; otherwise set
    // the client window's right edge to be one pixel to the left of the
    // decoration's left edge
    //
    metrics.Width.Set(lmRight,
                      ClientWnd->GetWindowAttr().Style & WS_BORDER ? lmSameAs : lmLeftOf,
                      &decoration, lmLeft);
  }
  else {
    insertLeftOf = metrics.X.RelWin;
 
    // Set the right edge of "insertRightOf" to be the same as the left edge of
    // the decoration
    //
    metrics.X.Set(lmRight, lmSameAs, &decoration, lmLeft);
  }
  SetChildLayoutMetrics(*insertRightOf, metrics);
 
  // Now set the layout metrics for the decoration so its right edge is the
  // same as the left edge of "insertLeftOf"
  //
  bool overlap = (decoration.GetWindowAttr().Style & WS_BORDER);
 
  metrics.X.Set(lmRight, overlap ? lmSameAs : lmLeftOf, insertLeftOf,
                insertLeftOf ? lmLeft : lmRight);
 
  metrics.Width.AsIs(lmWidth);
 
  // If the client window & decoration both have or don't have borders then
  // place the decoration so its "y" and "bottom" are the same as the client
  // windows; otherwise place its "y" above/below the client window's "y" and
  // its "bottom" below/above the client window's "bottom" based on who's has
  // borders & who doesn't
  //
  // This way if there are top or bottom decorations they will be tiled
  // over/under the left/right decorations
  //
  if (ToBool(ClientWnd->GetWindowAttr().Style & WS_BORDER) == overlap) {
    metrics.Y.SameAs(ClientWnd, lmTop);
    metrics.Height.SameAs(ClientWnd, lmBottom);
  }
  else if (overlap) {
    metrics.Y.Set(lmTop, lmAbove, ClientWnd, lmTop);
    metrics.Height.Set(lmBottom, lmBelow, ClientWnd, lmBottom);
  }
  else {
    metrics.Y.Set(lmTop, lmBelow, ClientWnd, lmTop);
    metrics.Height.Set(lmBottom, lmAbove, ClientWnd, lmBottom);
  }
  SetChildLayoutMetrics(decoration, metrics);
}
 
//
/// Insert a decoration window into position at one of the four edges.
//
/// After you specify where the decoration should be placed, Insert adds it just
/// above, below, left, or right of the client window. This process is especially
/// important when there are multiple decorations. Insert looks at the decoration's
/// Attr.Style member and checks the WS_VISIBLE flag to tell whether the decoration
/// should initially be visible or hidden.
/// To position the decoration, Insert uses TLocation enum, which describes Top,
/// Left, Bottom, and Right positions where the decoration can be placed.
//
void
TDecoratedFrame::Insert(TWindow& decoration, TLocation location)
{
  // Store away location for remove/re-insetion
  //
  SetLocation_(decoration, location);
 
  // Make sure the decoration has clipsiblings style, since our rearranging
  // causes corners to overlap sometimes.
  //
  ModifyStyle(0, WS_CLIPSIBLINGS);//|WS_CLIPCHILDREN);///????
 
  // Parent to decframe and remove layoutmetrics in case it's a re-insert
  //
  decoration.SetParent(this);
  RemoveChildLayoutMetrics(decoration);
 
  // If the window should be visible, proceed with insertion.
  // NOTE: Should we check the 'wfInsertAtEdge' flag here? It mostly
  //       important when hiding/showing decorations [i.e. In EvCommand
  //       handler]. However, it would be nice to check for it and use
  //       something other than ClientWnd if necessary.
  //
  if (decoration.GetWindowAttr().Style & WS_VISIBLE) {
    switch (location) {
      case None:
        break;
      case Top:
        InsertAtTop(decoration, ClientWnd);
        break;
      case Bottom:
        InsertAtBottom(decoration, ClientWnd);
        break;
      case Left:
        InsertAtLeft(decoration, ClientWnd);
        break;
      case Right:
        InsertAtRight(decoration, ClientWnd);
        break;
      default: //JJH added empty default statement
  break;
    }
  }
}
 
//
/// Search for child with ID = IDW_TOOLBAR, and if found check that it is
/// GadgetWindow and return it;
//
TGadgetWindow*
TDecoratedFrame::GetControlBar()
{
  TWindow* wnd = ChildWithId(IDW_TOOLBAR);
  if (!wnd)
  {
    // Look for grand-child toolbar.
    //
    auto c = GetChildren();
    const auto i = find_if(c.begin(), c.end(), [](TWindow& w) { return w.ChildWithId(IDW_TOOLBAR); });
    if (i == c.end()) return nullptr;
    wnd = i->ChildWithId(IDW_TOOLBAR);
    CHECK(wnd);
  }
  TGadgetWindow* toolBar = TYPESAFE_DOWNCAST(wnd, TGadgetWindow);
  if(toolBar)
    return toolBar;
  return nullptr;
}
 
 
//
/// SetupWindow() call this function to create control bar, if it is MainWindow and
/// if BarDescriptor exist.
//
bool
TDecoratedFrame::CreateBar()
{
  TGadgetWindow* toolBar = GetControlBar();
  if(!toolBar){ // already created
    toolBar = (*GetBarCreator())(this);
    toolBar->GetWindowAttr().Id = IDW_TOOLBAR;
  }
  if(((TBarDescr*)GetBarDescr())->Create(*toolBar))
    return (*GetBarInserter())(*this, *toolBar, alTop);
  return false;
}
 
//
/// Merges the given bar descriptor with this frame's own bar descriptor and
/// displays the resulting control bar in this frame. See TBarDescr for a
/// description of control bar types that can be merged.
//
bool
TDecoratedFrame::MergeBar(const TBarDescr& childBarDescr)
{
  if (!GetHandle() || !GetBarDescr())
    return false;
  TGadgetWindow* toolBar = GetControlBar();
  if(toolBar) // already created
    ((TBarDescr*)GetBarDescr())->Merge(childBarDescr, *toolBar);
  return true;
}
 
//
/// Restores the default control bar of the frame window.
//
bool
TDecoratedFrame::RestoreBar()
{
  if (!GetHandle() || !GetBarDescr())
    return false;
  TGadgetWindow* toolBar = GetControlBar();
  if(toolBar) // already created
    ((TBarDescr*)GetBarDescr())->Restore(*toolBar);
  return true;
}
 
 
IMPLEMENT_STREAMABLE3(TDecoratedFrame, TFrameWindow, TLayoutWindow, TWindow);
 
#if OWL_PERSISTENT_STREAMS
 
//
//
//
void*
TDecoratedFrame::Streamer::Read(ipstream& is, uint32 /*version*/) const
{
  ReadVirtualBase((TFrameWindow*)GetObject(), is);
  ReadBaseObject((TLayoutWindow*)GetObject(), is);
  return GetObject();
}
 
//
//
//
void
TDecoratedFrame::Streamer::Write(opstream& os) const
{
  WriteVirtualBase((TFrameWindow*)GetObject(), os);
  WriteBaseObject((TLayoutWindow*)GetObject(), os);
}
 
#endif
 
} // OWL namespace