1998-09-07 05:27:34 -04:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Name: laywin.h
|
|
|
|
// Purpose: Implements a simple layout algorithm, plus
|
|
|
|
// wxSashLayoutWindow which is an example of a window with
|
|
|
|
// layout-awareness (via event handlers). This is suited to
|
|
|
|
// IDE-style window layout.
|
|
|
|
// Author: Julian Smart
|
|
|
|
// Modified by:
|
|
|
|
// Created: 04/01/98
|
|
|
|
// RCS-ID: $Id$
|
|
|
|
// Copyright: (c) Julian Smart
|
2004-05-23 16:53:33 -04:00
|
|
|
// Licence: wxWindows licence
|
1998-09-07 05:27:34 -04:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
|
|
#ifndef _WX_LAYWIN_H_G_
|
|
|
|
#define _WX_LAYWIN_H_G_
|
|
|
|
|
1999-06-01 11:32:12 -04:00
|
|
|
#if wxUSE_SASH
|
|
|
|
#include "wx/sashwin.h"
|
|
|
|
#endif // wxUSE_SASH
|
1998-09-07 05:27:34 -04:00
|
|
|
|
2006-01-05 18:11:58 -05:00
|
|
|
#include "wx/event.h"
|
|
|
|
|
2001-01-31 12:16:40 -05:00
|
|
|
BEGIN_DECLARE_EVENT_TYPES()
|
2003-08-01 21:04:55 -04:00
|
|
|
DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_QUERY_LAYOUT_INFO, 1500)
|
|
|
|
DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_CALCULATE_LAYOUT, 1501)
|
2001-01-31 12:16:40 -05:00
|
|
|
END_DECLARE_EVENT_TYPES()
|
1998-09-07 05:27:34 -04:00
|
|
|
|
1999-06-01 11:32:12 -04:00
|
|
|
enum wxLayoutOrientation
|
|
|
|
{
|
1998-09-07 05:27:34 -04:00
|
|
|
wxLAYOUT_HORIZONTAL,
|
|
|
|
wxLAYOUT_VERTICAL
|
|
|
|
};
|
|
|
|
|
1999-06-01 11:32:12 -04:00
|
|
|
enum wxLayoutAlignment
|
|
|
|
{
|
1998-09-07 05:27:34 -04:00
|
|
|
wxLAYOUT_NONE,
|
|
|
|
wxLAYOUT_TOP,
|
|
|
|
wxLAYOUT_LEFT,
|
|
|
|
wxLAYOUT_RIGHT,
|
1999-03-05 08:23:38 -05:00
|
|
|
wxLAYOUT_BOTTOM
|
1998-09-07 05:27:34 -04:00
|
|
|
};
|
|
|
|
|
|
|
|
// Not sure this is necessary
|
|
|
|
// Tell window which dimension we're sizing on
|
|
|
|
#define wxLAYOUT_LENGTH_Y 0x0008
|
|
|
|
#define wxLAYOUT_LENGTH_X 0x0000
|
|
|
|
|
|
|
|
// Use most recently used length
|
|
|
|
#define wxLAYOUT_MRU_LENGTH 0x0010
|
|
|
|
|
|
|
|
// Only a query, so don't actually move it.
|
|
|
|
#define wxLAYOUT_QUERY 0x0100
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This event is used to get information about window alignment,
|
|
|
|
* orientation and size.
|
|
|
|
*/
|
|
|
|
|
2003-08-01 21:04:55 -04:00
|
|
|
class WXDLLIMPEXP_ADV wxQueryLayoutInfoEvent: public wxEvent
|
1998-09-07 05:27:34 -04:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
wxQueryLayoutInfoEvent(wxWindowID id = 0)
|
|
|
|
{
|
|
|
|
SetEventType(wxEVT_QUERY_LAYOUT_INFO);
|
|
|
|
m_requestedLength = 0;
|
|
|
|
m_flags = 0;
|
1998-09-12 13:31:48 -04:00
|
|
|
m_id = id;
|
1998-09-07 05:27:34 -04:00
|
|
|
m_alignment = wxLAYOUT_TOP;
|
|
|
|
m_orientation = wxLAYOUT_HORIZONTAL;
|
|
|
|
}
|
|
|
|
|
1999-02-22 06:01:13 -05:00
|
|
|
// Read by the app
|
|
|
|
void SetRequestedLength(int length) { m_requestedLength = length; }
|
|
|
|
int GetRequestedLength() const { return m_requestedLength; }
|
1998-09-07 05:27:34 -04:00
|
|
|
|
1999-02-22 06:01:13 -05:00
|
|
|
void SetFlags(int flags) { m_flags = flags; }
|
|
|
|
int GetFlags() const { return m_flags; }
|
1998-09-07 05:27:34 -04:00
|
|
|
|
1999-02-22 06:01:13 -05:00
|
|
|
// Set by the app
|
|
|
|
void SetSize(const wxSize& size) { m_size = size; }
|
|
|
|
wxSize GetSize() const { return m_size; }
|
|
|
|
|
|
|
|
void SetOrientation(wxLayoutOrientation orient) { m_orientation = orient; }
|
|
|
|
wxLayoutOrientation GetOrientation() const { return m_orientation; }
|
|
|
|
|
|
|
|
void SetAlignment(wxLayoutAlignment align) { m_alignment = align; }
|
|
|
|
wxLayoutAlignment GetAlignment() const { return m_alignment; }
|
1998-09-07 05:27:34 -04:00
|
|
|
|
2001-11-21 16:44:52 -05:00
|
|
|
virtual wxEvent *Clone() const { return new wxQueryLayoutInfoEvent(*this); }
|
|
|
|
|
1998-09-07 05:27:34 -04:00
|
|
|
protected:
|
|
|
|
int m_flags;
|
|
|
|
int m_requestedLength;
|
|
|
|
wxSize m_size;
|
|
|
|
wxLayoutOrientation m_orientation;
|
|
|
|
wxLayoutAlignment m_alignment;
|
2004-06-17 12:22:36 -04:00
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
private:
|
2003-07-22 07:13:50 -04:00
|
|
|
DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryLayoutInfoEvent)
|
1998-09-07 05:27:34 -04:00
|
|
|
};
|
|
|
|
|
|
|
|
typedef void (wxEvtHandler::*wxQueryLayoutInfoEventFunction)(wxQueryLayoutInfoEvent&);
|
|
|
|
|
2001-01-26 12:35:36 -05:00
|
|
|
#define EVT_QUERY_LAYOUT_INFO(func) \
|
2004-06-17 12:22:36 -04:00
|
|
|
DECLARE_EVENT_TABLE_ENTRY( wxEVT_QUERY_LAYOUT_INFO, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxQueryLayoutInfoEventFunction, & func ), NULL ),
|
1998-09-07 05:27:34 -04:00
|
|
|
|
|
|
|
/*
|
|
|
|
* This event is used to take a bite out of the available client area.
|
|
|
|
*/
|
|
|
|
|
2003-08-01 21:04:55 -04:00
|
|
|
class WXDLLIMPEXP_ADV wxCalculateLayoutEvent: public wxEvent
|
1998-09-07 05:27:34 -04:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
wxCalculateLayoutEvent(wxWindowID id = 0)
|
|
|
|
{
|
|
|
|
SetEventType(wxEVT_CALCULATE_LAYOUT);
|
|
|
|
m_flags = 0;
|
1999-03-05 08:23:38 -05:00
|
|
|
m_id = id;
|
1998-09-07 05:27:34 -04:00
|
|
|
}
|
|
|
|
|
2001-11-21 16:44:52 -05:00
|
|
|
// Read by the app
|
|
|
|
void SetFlags(int flags) { m_flags = flags; }
|
|
|
|
int GetFlags() const { return m_flags; }
|
|
|
|
|
|
|
|
// Set by the app
|
|
|
|
void SetRect(const wxRect& rect) { m_rect = rect; }
|
|
|
|
wxRect GetRect() const { return m_rect; }
|
|
|
|
|
|
|
|
virtual wxEvent *Clone() const { return new wxCalculateLayoutEvent(*this); }
|
|
|
|
|
1998-09-07 05:27:34 -04:00
|
|
|
protected:
|
|
|
|
int m_flags;
|
|
|
|
wxRect m_rect;
|
2004-06-17 12:22:36 -04:00
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
private:
|
2003-07-22 07:13:50 -04:00
|
|
|
DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCalculateLayoutEvent)
|
1998-09-07 05:27:34 -04:00
|
|
|
};
|
|
|
|
|
|
|
|
typedef void (wxEvtHandler::*wxCalculateLayoutEventFunction)(wxCalculateLayoutEvent&);
|
|
|
|
|
2001-01-26 12:35:36 -05:00
|
|
|
#define EVT_CALCULATE_LAYOUT(func) \
|
2004-06-17 12:22:36 -04:00
|
|
|
DECLARE_EVENT_TABLE_ENTRY( wxEVT_CALCULATE_LAYOUT, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxCalculateLayoutEventFunction, & func ), NULL ),
|
1998-09-07 05:27:34 -04:00
|
|
|
|
1999-06-01 11:32:12 -04:00
|
|
|
#if wxUSE_SASH
|
|
|
|
|
1998-09-07 05:27:34 -04:00
|
|
|
// This is window that can remember alignment/orientation, does its own layout,
|
|
|
|
// and can provide sashes too. Useful for implementing docked windows with sashes in
|
|
|
|
// an IDE-style interface.
|
2003-08-01 21:04:55 -04:00
|
|
|
class WXDLLIMPEXP_ADV wxSashLayoutWindow: public wxSashWindow
|
1998-09-07 05:27:34 -04:00
|
|
|
{
|
|
|
|
public:
|
2000-07-15 15:51:35 -04:00
|
|
|
wxSashLayoutWindow()
|
|
|
|
{
|
|
|
|
Init();
|
|
|
|
}
|
|
|
|
|
2004-06-17 12:22:36 -04:00
|
|
|
wxSashLayoutWindow(wxWindow *parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition,
|
2002-12-04 09:11:26 -05:00
|
|
|
const wxSize& size = wxDefaultSize, long style = wxSW_3D|wxCLIP_CHILDREN, const wxString& name = wxT("layoutWindow"))
|
2000-07-15 15:51:35 -04:00
|
|
|
{
|
|
|
|
Create(parent, id, pos, size, style, name);
|
|
|
|
}
|
|
|
|
|
2004-06-17 12:22:36 -04:00
|
|
|
bool Create(wxWindow *parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition,
|
2002-12-04 09:11:26 -05:00
|
|
|
const wxSize& size = wxDefaultSize, long style = wxSW_3D|wxCLIP_CHILDREN, const wxString& name = wxT("layoutWindow"));
|
1998-09-07 05:27:34 -04:00
|
|
|
|
|
|
|
// Accessors
|
2007-04-14 05:58:37 -04:00
|
|
|
inline wxLayoutAlignment GetAlignment() const { return m_alignment; }
|
|
|
|
inline wxLayoutOrientation GetOrientation() const { return m_orientation; }
|
1998-09-07 05:27:34 -04:00
|
|
|
|
2007-04-14 05:58:37 -04:00
|
|
|
inline void SetAlignment(wxLayoutAlignment align) { m_alignment = align; }
|
|
|
|
inline void SetOrientation(wxLayoutOrientation orient) { m_orientation = orient; }
|
1998-09-07 05:27:34 -04:00
|
|
|
|
|
|
|
// Give the window default dimensions
|
|
|
|
inline void SetDefaultSize(const wxSize& size) { m_defaultSize = size; }
|
|
|
|
|
|
|
|
// Event handlers
|
|
|
|
// Called by layout algorithm to allow window to take a bit out of the
|
|
|
|
// client rectangle, and size itself if not in wxLAYOUT_QUERY mode.
|
|
|
|
void OnCalculateLayout(wxCalculateLayoutEvent& event);
|
|
|
|
|
|
|
|
// Called by layout algorithm to retrieve information about the window.
|
|
|
|
void OnQueryLayoutInfo(wxQueryLayoutInfoEvent& event);
|
2000-07-15 15:51:35 -04:00
|
|
|
|
|
|
|
private:
|
|
|
|
void Init();
|
|
|
|
|
1998-09-07 05:27:34 -04:00
|
|
|
wxLayoutAlignment m_alignment;
|
|
|
|
wxLayoutOrientation m_orientation;
|
|
|
|
wxSize m_defaultSize;
|
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
private:
|
2003-07-21 21:42:41 -04:00
|
|
|
DECLARE_DYNAMIC_CLASS_NO_COPY(wxSashLayoutWindow)
|
2002-12-04 09:11:26 -05:00
|
|
|
DECLARE_EVENT_TABLE()
|
1998-09-07 05:27:34 -04:00
|
|
|
};
|
|
|
|
|
1999-06-01 11:32:12 -04:00
|
|
|
#endif // wxUSE_SASH
|
|
|
|
|
2007-07-09 06:09:52 -04:00
|
|
|
class WXDLLIMPEXP_FWD_CORE wxMDIParentFrame;
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxFrame;
|
1998-09-07 05:27:34 -04:00
|
|
|
|
|
|
|
// This class implements the layout algorithm
|
2003-08-01 21:04:55 -04:00
|
|
|
class WXDLLIMPEXP_ADV wxLayoutAlgorithm: public wxObject
|
1998-09-07 05:27:34 -04:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
wxLayoutAlgorithm() {}
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
#if wxUSE_MDI_ARCHITECTURE
|
1998-09-07 05:27:34 -04:00
|
|
|
// The MDI client window is sized to whatever's left over.
|
1998-11-17 18:03:15 -05:00
|
|
|
bool LayoutMDIFrame(wxMDIParentFrame* frame, wxRect* rect = (wxRect*) NULL);
|
2001-06-26 16:59:19 -04:00
|
|
|
#endif // wxUSE_MDI_ARCHITECTURE
|
1998-09-07 05:27:34 -04:00
|
|
|
|
1999-01-30 16:37:17 -05:00
|
|
|
// mainWindow is sized to whatever's left over. This function for backward
|
|
|
|
// compatibility; use LayoutWindow.
|
2001-07-05 14:48:48 -04:00
|
|
|
bool LayoutFrame(wxFrame* frame, wxWindow* mainWindow = (wxWindow*) NULL);
|
1999-01-30 16:37:17 -05:00
|
|
|
|
2000-07-15 15:51:35 -04:00
|
|
|
// mainWindow is sized to whatever's left over.
|
1999-01-30 16:37:17 -05:00
|
|
|
bool LayoutWindow(wxWindow* frame, wxWindow* mainWindow = (wxWindow*) NULL);
|
1998-09-07 05:27:34 -04:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|
|
|
|
// _WX_LAYWIN_H_G_
|