framewin.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
// ObjectWindows
// Copyright (c) 1992, 1996 by Borland International, All Rights Reserved
//
/// \file
/// Definition of class TFrameWindow.
//----------------------------------------------------------------------------
 
#if !defined(OWL_FRAMEWIN_H)
#define OWL_FRAMEWIN_H
 
#include <owl/private/defs.h>
#if defined(BI_HAS_PRAGMA_ONCE)
# pragma once
#endif
 
#include <owl/window.h>
#include <owl/menu.h>
#include <memory>
 
namespace owl {
 
#include <owl/preclass.h>
 
//
// MDI window IDs
//
const unsigned int IDW_MDICLIENT     = 32000;  ///< ID of MDI client window
const unsigned int IDW_FIRSTMDICHILD = 32001;  ///< child window IDs, 32 max to 32032
 
/// \addtogroup enabler
/// @{
/// \class TMenuItemEnabler
// ~~~~~ ~~~~~~~~~~~~~~~~
/// Derived from TCommandEnabler, TMenuItemEnabler is a command enabler for menu
/// items. The functions in this class modify the text, check state, and appearance
/// of a menu item.
//
class _OWLCLASS TMenuItemEnabler : public TCommandEnabler {
  public:
    TMenuItemEnabler(HMENU hMenu, uint id, HWND hWndReceiver, int position);
 
    // Override member functions of TCommandEnabler
    //
    void    Enable(bool enable);
    void    SetText(LPCTSTR text);
    using TCommandEnabler::SetText; ///< String-aware overload
    void    SetCheck(int check);
 
    // Menu specific member functions
    //
    HMENU   GetMenu();
    int     GetPosition();
 
  protected_data:
 
/// The menu that holds the item being enabled or disabled.
    HMENU   HMenu;
 
/// The position of the menu item.
    int     Position;
};
class _OWLCLASS TMenuItemEnabler : public TCommandEnabler {…};
/// @}
 
/// \addtogroup frame
/// @{
 
class _OWLCLASS TBarDescr;
//
/// \class TFrameWindow
// ~~~~~ ~~~~~~~~~~~~
/// Derived from TWindow, TFrameWindow controls such window-specific behavior as
/// keyboard navigation and command processing for client windows. For example, when
/// a window is reactivated, TFrameWindow is responsible for restoring a window's
/// input focus and for adding menu bar and icon support. TFrameWindow is a
/// streamable class.
///
/// In terms of window areas, the frame area consists of the border, system menus,
/// toolbars and status bars whereas the client area excludes these areas. Although
/// frame windows can support a client window, the frame window remains separate
/// from the client window so that you can change the client window without
/// affecting the frame window.
///
/// ObjectWindows uses this frame and client structure for both TFrameWindow and
/// TMDIChild classes. Both these classes can hold a client class. Having a separate
/// class for the client area of the window adds more flexibility to your program.
/// For example, this separate client area, which might be a dialog box, can be
/// moved into another frame window, either a main window or an MDI child window.
///
/// TFrameWindow adds the notion of a client window, keyboard navigation, and special
/// processing for commands (see member function EvCommand() )
///
/// See TFloatingFrame for a description of a floating frame with the same default
/// functionality as a frame window.
//
class _OWLCLASS TFrameWindow : virtual public TWindow {
  public:
    TFrameWindow(TWindow*        parent,
                      LPCTSTR title = nullptr,
                      TWindow*        clientWnd = nullptr,
                 bool            shrinkToClient = false,
                      TModule*        module = nullptr);
 
    TFrameWindow(
      TWindow* parent,
      const tstring& title,
        TWindow* client = nullptr,
      bool shrinkToClient = false,
        TModule* = nullptr);
 
    TFrameWindow(
      TWindow* parent,
      const tstring& title,
      std::unique_ptr<TWindow> client = nullptr,
      bool shrinkToClient = false,
        TModule* = nullptr);
 
     TFrameWindow(HWND hWnd, TModule* module = nullptr);
   ~TFrameWindow() override;
 
    // Menubar manipulating functions
    //
    virtual bool    AssignMenu(TResId menuResId);
    virtual bool    SetMenu(HMENU newMenu);
 
    void            SetMenuDescr(const TMenuDescr& menuDescr);
    const TMenuDescr* GetMenuDescr() const;
    virtual bool    MergeMenu(const TMenuDescr& childMenuDescr);
    bool            RestoreMenu();
 
    void            SetBarDescr(TBarDescr* barDescr, TAutoDelete = AutoDelete);
    const TBarDescr* GetBarDescr() const;
    virtual bool    MergeBar(const TBarDescr& childBarDescr);
    virtual bool    RestoreBar();
 
    TModule*        GetMergeModule();
 
    HICON           GetIcon() const;
    HICON           GetIconSm() const;
    bool            SetIcon(TModule* iconModule, TResId iconResId);
    bool            SetIconSm(TModule* iconModule, TResId iconResIdSm);
 
    // Client and child window manipulation
    //
    virtual TWindow* GetClientWindow();
    virtual TWindow* SetClientWindow(TWindow* clientWnd);
    auto SetClientWindow(std::unique_ptr<TWindow>) -> std::unique_ptr<TWindow>;
    void RemoveChild(TWindow*) override;
    virtual HWND    GetCommandTarget();
 
    // Sets flag indicating that the receiver has requested "keyboard
    // handling" (translation of keyboard input into control selections)
    //
    bool            GetKeyboardHandling() const;
    void            SetKeyboardHandling(bool kh=true);
    void            EnableKBHandler();
 
    // Override virtual functions defined by TWindow
    //
    auto PreProcessMsg(MSG&) -> bool override;
    auto IdleAction(long idleCount) -> bool override;
    auto HoldFocusHWnd(HWND hWndLose, HWND hWndGain) -> bool override;
    auto SetDocTitle(LPCTSTR docname, int index) -> bool override;
    using TWindow::SetDocTitle; ///< String-aware overload
 
  protected:
    // Constructor & subsequent initializer for use with virtual derivations
    // Immediate derivitives must call Init() before constructions are done.
    //
    TFrameWindow();
    void            Init(TWindow* clientWnd, bool shrinkToClient);
 
    // The event handler functions that are virtual, and not dispatched thru
    // response tables
    //
    // Extra processing for commands: starts with the focus window and gives
    // it and its parent windows an opportunity to handle the command.
    //
    auto EvCommand(uint id, HWND hWndCtl, uint notifyCode) -> TResult override;
    void EvCommandEnable(TCommandEnabler&) override;
 
    // Tell child windows frame has minimized/maximized/restored
    //
    void            BroadcastResizeToChildren(uint sizeType, const TSize& size);
 
    // Message response functions
    //
    void            EvInitMenuPopup(HMENU hPopupMenu, uint index, bool isSysMenu);
    HICON           EvQueryDragIcon();
    void            EvSetFocus(HWND hWndLostFocus);
    void            EvSize(uint sizeType, const TSize& size);
    void            EvParentNotify(const TParentNotify&);
    void            EvPaletteChanged(HWND hWndPalChg);
    bool            EvQueryNewPalette();
 
    // Override virtual functions defined by TWindow
    //
    void SetupWindow() override;
    void CleanupWindow() override;
 
    // Accesors to data members
    //
    HWND            GetHWndRestoreFocus();
    void            SetHWndRestoreFocus(HWND hwndRestoreFocus);
    int             GetDocTitleIndex() const;
    void            SetDocTitleIndex(int index);
    void            SetMergeModule(TModule* module);
 
  public_data:
/// Indicates if keyboard navigation is required.
    bool            KeyboardHandling;
 
  protected_data:
/// Stores the handle of the child window whose focus gets restored.
    THandle         HWndRestoreFocus;
 
/// ClientWnd points to the frame's client window.
    TWindow*        ClientWnd;
 
/// Holds the index number for the document title.
    int             DocTitleIndex;
 
/// Tells the frame window which module the menu comes from. TDecoratedFrame uses
/// this member to get the menu hints it displays at the bottom of the screen. It
/// assumes that the menu hints come from the same place the menu came from.
    TModule*        MergeModule;
 
  private:
    TMenuDescr*     MenuDescr;
    TBarDescr*       BarDescr;
    bool            DeleteBar;
    TModule*        IconModule;
    TResId          IconResId;
    TModule*        IconSmModule;
    TResId          IconSmResId;
    TPoint          MinimizedPos;
    HICON           CurIcon;
    HICON           CurIconSm;
 
    void            Init(TWindow* clientWnd);
    bool            ResizeClientWindow(bool redraw = true);
    TWindow*        FirstChildWithTab();
 
    // Hidden to prevent accidental copying or assignment
    //
    TFrameWindow(const TFrameWindow&);
    TFrameWindow& operator =(const TFrameWindow&);
 
  DECLARE_RESPONSE_TABLE(TFrameWindow);
  DECLARE_STREAMABLE_OWL(TFrameWindow, 3);
};
class _OWLCLASS TFrameWindow : virtual public TWindow {…};
/// @}
 
DECLARE_STREAMABLE_INLINES(owl::TFrameWindow);
 
#include <owl/posclass.h>
 
//----------------------------------------------------------------------------
// Inline implementations
//
 
//
/// Constructs a TMenuItemEnabler with the specified command ID for the menu item,
/// message responder (hWndReceiver), and position on the menu.
//
inline TMenuItemEnabler::TMenuItemEnabler(HMENU hMenu, uint id,
                                          HWND hWndReceiver, int position)
:
  TCommandEnabler(id, hWndReceiver),
  HMenu(hMenu),
  Position(position)
{
  if (::GetMenuItemID(HMenu, Position) == uint(-1))
    Flags = NonSender;
}
inline TMenuItemEnabler::TMenuItemEnabler(HMENU hMenu, uint id, {…}
 
//
/// Returns the menu that holds the item being enabled or disabled.
//
inline HMENU TMenuItemEnabler::GetMenu()
{
  return HMenu;
}
inline HMENU TMenuItemEnabler::GetMenu() {…}
 
//
/// Returns the position of the menu item.
//
inline int TMenuItemEnabler::GetPosition()
{
  return Position;
}
inline int TMenuItemEnabler::GetPosition() {…}
 
//
/// Retrieve handle of icon of frame window
/// \note Only retrieves icon set via the 'SetIcon' API - does not retrieve
///       the small HICON associated with the HWND.
//
inline HICON TFrameWindow::GetIcon() const
{
    return CurIcon;
}
inline HICON TFrameWindow::GetIcon() const {…}
 
//
/// Retrieve handle of icon of frame window
/// \note Only retrieves icon set via the 'SetIconSm' API - does not retrieve
///       the HICON associated with the HWND.
//
inline HICON TFrameWindow::GetIconSm() const
{
  return CurIconSm;
}
inline HICON TFrameWindow::GetIconSm() const {…}
 
//
/// Returns a pointer to the menu descriptor for the frame window.
//
inline const TMenuDescr* TFrameWindow::GetMenuDescr() const
{
  return MenuDescr;
}
inline const TMenuDescr* TFrameWindow::GetMenuDescr() const {…}
 
//
/// Returns a pointer to the control bar descriptor.
//
inline const TBarDescr* TFrameWindow::GetBarDescr() const
{
  return BarDescr;
}
inline const TBarDescr* TFrameWindow::GetBarDescr() const {…}
 
 
//
/// Do nothing. Return false. Overriden in TDecoratedFrame
//
inline bool TFrameWindow::MergeBar(const TBarDescr& /*childBarDescr*/)
{
  return false;
}
inline bool TFrameWindow::MergeBar(const TBarDescr& /*childBarDescr*/) {…}
 
//
/// Do nothing in TFrameWindow. Overriden in TDecoratedFrame.
//
inline bool TFrameWindow::RestoreBar()
{
  return false;
}
inline bool TFrameWindow::RestoreBar() {…}
 
//
/// Returns flag indicating that the receiver has requested "keyboard handling"
/// (translation of keyboard input into control selections).
//
inline bool TFrameWindow::GetKeyboardHandling() const
{
  return KeyboardHandling;
}
inline bool TFrameWindow::GetKeyboardHandling() const {…}
 
//
/// Sets flag indicating that the receiver has requested "keyboard handling"
/// (translation of keyboard input into control selections).
//
inline void TFrameWindow::SetKeyboardHandling(bool kh)
{
  KeyboardHandling = kh;
}
inline void TFrameWindow::SetKeyboardHandling(bool kh) {…}
 
//
/// Sets the keyboard handling flag to true.
//
/// Sets a flag indicating that the receiver has requested keyboard navigation
/// (translation of keyboard input into control selections). By default, the
/// keyboard interface, which lets users use the tab and arrow keys to move between
/// the controls, is disabled for windows and dialog boxes.
//
inline void TFrameWindow::EnableKBHandler()
{
  SetKeyboardHandling(true);
}
inline void TFrameWindow::EnableKBHandler() {…}
 
//
/// Returns the handle of the window to restore the focus to.
//
inline HWND TFrameWindow::GetHWndRestoreFocus()
{
  return HWndRestoreFocus;
}
inline HWND TFrameWindow::GetHWndRestoreFocus() {…}
 
//
/// Sets the remembered focused window.
//
inline void TFrameWindow::SetHWndRestoreFocus(HWND hwndrestorefocus)
{
  HWndRestoreFocus = hwndrestorefocus;
}
inline void TFrameWindow::SetHWndRestoreFocus(HWND hwndrestorefocus) {…}
 
//
/// Returns the document title index.
//
inline int TFrameWindow::GetDocTitleIndex() const
{
  return DocTitleIndex;
}
inline int TFrameWindow::GetDocTitleIndex() const {…}
 
//
/// Sets the current document's title index.
//
inline void TFrameWindow::SetDocTitleIndex(int index)
{
  DocTitleIndex = index;
}
inline void TFrameWindow::SetDocTitleIndex(int index) {…}
 
//
/// Returns the module of the merge menu.
//
inline TModule* TFrameWindow::GetMergeModule()
{
  return MergeModule;
}
inline TModule* TFrameWindow::GetMergeModule() {…}
 
//
/// Remembers where the merged menu came from.
//
inline void TFrameWindow::SetMergeModule(TModule* module)
{
  MergeModule = module;
}
inline void TFrameWindow::SetMergeModule(TModule* module) {…}
 
} // OWL namespace
 
 
#endif  // OWL_FRAMEWIN_H