72195a0fd2
Added wxSP_LIVE_UPADTE to splitter. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@2683 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
339 lines
12 KiB
C++
339 lines
12 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: splitter.h
|
|
// Purpose: wxSplitterWindow class
|
|
// Author: Julian Smart
|
|
// Modified by:
|
|
// Created: 01/02/97
|
|
// RCS-ID: $Id$
|
|
// Copyright: (c) Julian Smart and Markus Holzem
|
|
// Licence: wxWindows license
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef __SPLITTERH_G__
|
|
#define __SPLITTERH_G__
|
|
|
|
#ifdef __GNUG__
|
|
#pragma interface "splitter.h"
|
|
#endif
|
|
|
|
#include "wx/window.h" // base class declaration
|
|
|
|
class WXDLLEXPORT wxSplitterEvent;
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// splitter constants
|
|
// ---------------------------------------------------------------------------
|
|
|
|
enum
|
|
{
|
|
wxSPLIT_HORIZONTAL = 1,
|
|
wxSPLIT_VERTICAL
|
|
};
|
|
|
|
enum
|
|
{
|
|
wxSPLIT_DRAG_NONE,
|
|
wxSPLIT_DRAG_DRAGGING,
|
|
wxSPLIT_DRAG_LEFT_DOWN
|
|
};
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// wxSplitterWindow maintains one or two panes, with
|
|
// an optional vertical or horizontal split which
|
|
// can be used with the mouse or programmatically.
|
|
// ---------------------------------------------------------------------------
|
|
|
|
// TODO:
|
|
// 1) Perhaps make the borders sensitive to dragging in order to create a split.
|
|
// The MFC splitter window manages scrollbars as well so is able to
|
|
// put sash buttons on the scrollbars, but we probably don't want to go down
|
|
// this path.
|
|
// 2) for wxWindows 2.0, we must find a way to set the WS_CLIPCHILDREN style
|
|
// to prevent flickering. (WS_CLIPCHILDREN doesn't work in all cases so can't be
|
|
// standard).
|
|
|
|
class WXDLLEXPORT wxSplitterWindow: public wxWindow
|
|
{
|
|
public:
|
|
|
|
////////////////////////////////////////////////////////////////////////////
|
|
// Public API
|
|
|
|
// Default constructor
|
|
wxSplitterWindow();
|
|
|
|
// Normal constructor
|
|
wxSplitterWindow(wxWindow *parent, wxWindowID id = -1,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = wxSP_3D|wxCLIP_CHILDREN,
|
|
const wxString& name = "splitter");
|
|
~wxSplitterWindow();
|
|
|
|
// Gets the only or left/top pane
|
|
wxWindow *GetWindow1() const { return m_windowOne; }
|
|
|
|
// Gets the right/bottom pane
|
|
wxWindow *GetWindow2() const { return m_windowTwo; }
|
|
|
|
// Sets the split mode
|
|
void SetSplitMode(int mode) { m_splitMode = mode; }
|
|
|
|
// Gets the split mode
|
|
int GetSplitMode() const { return m_splitMode; };
|
|
|
|
// Initialize with one window
|
|
void Initialize(wxWindow *window);
|
|
|
|
// Associates the given window with window 2, drawing the appropriate sash
|
|
// and changing the split mode.
|
|
// Does nothing and returns FALSE if the window is already split.
|
|
// A sashPosition of 0 means choose a default sash position,
|
|
// negative sashPosition specifies the size of right/lower pane as it's
|
|
// absolute value rather than the size of left/upper pane.
|
|
virtual bool SplitVertically(wxWindow *window1,
|
|
wxWindow *window2,
|
|
int sashPosition = 0);
|
|
virtual bool SplitHorizontally(wxWindow *window1,
|
|
wxWindow *window2,
|
|
int sashPosition = 0);
|
|
|
|
// Removes the specified (or second) window from the view
|
|
// Doesn't actually delete the window.
|
|
bool Unsplit(wxWindow *toRemove = (wxWindow *) NULL);
|
|
|
|
// Replaces one of the windows with another one (neither old nor new
|
|
// parameter should be NULL)
|
|
bool ReplaceWindow(wxWindow *winOld, wxWindow *winNew);
|
|
|
|
// Is the window split?
|
|
bool IsSplit() const { return (m_windowTwo != NULL); }
|
|
|
|
// Sets the sash size
|
|
void SetSashSize(int width) { m_sashSize = width; }
|
|
|
|
// Sets the border size
|
|
void SetBorderSize(int width) { m_borderSize = width; }
|
|
|
|
// Gets the sash size
|
|
int GetSashSize() const { return m_sashSize; }
|
|
|
|
// Gets the border size
|
|
int GetBorderSize() const { return m_borderSize; }
|
|
|
|
// Set the sash position
|
|
void SetSashPosition(int position, bool redraw = TRUE);
|
|
|
|
// Gets the sash position
|
|
int GetSashPosition() const { return m_sashPosition; }
|
|
|
|
// If this is zero, we can remove panes by dragging the sash.
|
|
void SetMinimumPaneSize(int min) { m_minimumPaneSize = min; }
|
|
int GetMinimumPaneSize() const { return m_minimumPaneSize; }
|
|
|
|
// Called when the sash position is about to be changed, return
|
|
// FALSE from here to prevent the change from taking place.
|
|
// Repositions sash to minimum position if pane would be too small.
|
|
// newSashPosition here is always positive or zero.
|
|
virtual bool OnSashPositionChange(int WXUNUSED(newSashPosition))
|
|
{ return TRUE; }
|
|
|
|
// If the sash is moved to an extreme position, a subwindow
|
|
// is removed from the splitter window, and the app is
|
|
// notified. The app should delete or hide the window.
|
|
virtual void OnUnsplit(wxWindow *WXUNUSED(removed)) { }
|
|
|
|
// Called when the sash is double-clicked.
|
|
// The default behaviour is to remove the sash if the
|
|
// minimum pane size is zero.
|
|
virtual void OnDoubleClickSash(int WXUNUSED(x), int WXUNUSED(y)) { }
|
|
|
|
////////////////////////////////////////////////////////////////////////////
|
|
// Implementation
|
|
|
|
// Paints the border and sash
|
|
void OnPaint(wxPaintEvent& event);
|
|
|
|
// Handles mouse events
|
|
void OnMouseEvent(wxMouseEvent& ev);
|
|
|
|
// Adjusts the panes
|
|
void OnSize(wxSizeEvent& event);
|
|
|
|
// In live mode, resize child windows in idle time
|
|
void OnIdle(wxIdleEvent& event);
|
|
|
|
// Draws borders
|
|
void DrawBorders(wxDC& dc);
|
|
|
|
// Draws the sash
|
|
void DrawSash(wxDC& dc);
|
|
|
|
// Draws the sash tracker (for whilst moving the sash)
|
|
void DrawSashTracker(int x, int y);
|
|
|
|
// Tests for x, y over sash
|
|
bool SashHitTest(int x, int y, int tolerance = 2);
|
|
|
|
// Resizes subwindows
|
|
void SizeWindows();
|
|
|
|
// Initialize colours
|
|
void InitColours();
|
|
|
|
protected:
|
|
// our event handlers
|
|
void OnSashPosChanged(wxSplitterEvent& event);
|
|
void OnSashPosChanging(wxSplitterEvent& event);
|
|
void OnDoubleClick(wxSplitterEvent& event);
|
|
void OnUnsplitEvent(wxSplitterEvent& event);
|
|
|
|
void SendUnsplitEvent(wxWindow *winRemoved);
|
|
|
|
int m_splitMode;
|
|
bool m_permitUnsplitAlways;
|
|
bool m_needUpdating; // when in live mode, set the to TRUE to resize children in idle
|
|
wxWindow* m_windowOne;
|
|
wxWindow* m_windowTwo;
|
|
int m_dragMode;
|
|
int m_oldX;
|
|
int m_oldY;
|
|
int m_borderSize;
|
|
int m_sashSize; // Sash width or height
|
|
int m_sashPosition; // Number of pixels from left or top
|
|
int m_firstX;
|
|
int m_firstY;
|
|
int m_minimumPaneSize;
|
|
wxCursor* m_sashCursorWE;
|
|
wxCursor* m_sashCursorNS;
|
|
wxPen* m_sashTrackerPen;
|
|
wxPen* m_lightShadowPen;
|
|
wxPen* m_mediumShadowPen;
|
|
wxPen* m_darkShadowPen;
|
|
wxPen* m_hilightPen;
|
|
wxBrush* m_faceBrush;
|
|
wxPen* m_facePen;
|
|
|
|
private:
|
|
DECLARE_DYNAMIC_CLASS(wxSplitterWindow)
|
|
DECLARE_EVENT_TABLE()
|
|
};
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// event class and macros
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// we reuse the same class for all splitter event types because this is the
|
|
// usual wxWin convention, but the three event types have different kind of
|
|
// data associated with them, so the accessors can be only used if the real
|
|
// event type matches with the one for which the accessors make sense
|
|
class WXDLLEXPORT wxSplitterEvent : public wxCommandEvent
|
|
{
|
|
public:
|
|
wxSplitterEvent(wxEventType type = wxEVT_NULL,
|
|
wxSplitterWindow *splitter = (wxSplitterWindow *)NULL)
|
|
: wxCommandEvent(type)
|
|
{
|
|
SetEventObject(splitter);
|
|
}
|
|
|
|
// SASH_POS_CHANGED methods
|
|
|
|
// setting the sash position to -1 prevents the change from taking place at
|
|
// all
|
|
void SetSashPosition(int pos)
|
|
{
|
|
wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED
|
|
|| GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING);
|
|
|
|
m_data.pos = pos;
|
|
}
|
|
|
|
int GetSashPosition() const
|
|
{
|
|
wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED
|
|
|| GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING);
|
|
|
|
return m_data.pos;
|
|
}
|
|
|
|
// UNSPLIT event methods
|
|
wxWindow *GetWindowBeingRemoved() const
|
|
{
|
|
wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_UNSPLIT );
|
|
|
|
return m_data.win;
|
|
}
|
|
|
|
// DCLICK event methods
|
|
int GetX() const
|
|
{
|
|
wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_DOUBLECLICKED );
|
|
|
|
return m_data.pt.x;
|
|
}
|
|
|
|
int GetY() const
|
|
{
|
|
wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_DOUBLECLICKED );
|
|
|
|
return m_data.pt.y;
|
|
}
|
|
|
|
private:
|
|
friend wxSplitterWindow;
|
|
|
|
// data for the different types of event
|
|
union
|
|
{
|
|
int pos; // position for SASH_POS_CHANGED event
|
|
wxWindow *win; // window being removed for UNSPLIT event
|
|
struct
|
|
{
|
|
int x, y;
|
|
} pt; // position of double click for DCLICK event
|
|
} m_data;
|
|
|
|
DECLARE_DYNAMIC_CLASS(wxSplitterEvent)
|
|
};
|
|
|
|
typedef void (wxEvtHandler::*wxSplitterEventFunction)(wxSplitterEvent&);
|
|
|
|
#define EVT_SPLITTER_SASH_POS_CHANGED(id, fn) \
|
|
{ \
|
|
wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED, \
|
|
id, \
|
|
-1, \
|
|
(wxObjectEventFunction)(wxEventFunction)(wxSplitterEventFunction) &fn, \
|
|
NULL \
|
|
},
|
|
|
|
#define EVT_SPLITTER_SASH_POS_CHANGING(id, fn) \
|
|
{ \
|
|
wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING, \
|
|
id, \
|
|
-1, \
|
|
(wxObjectEventFunction)(wxEventFunction)(wxSplitterEventFunction) &fn, \
|
|
NULL \
|
|
},
|
|
|
|
#define EVT_SPLITTER_DCLICK(id, fn) \
|
|
{ \
|
|
wxEVT_COMMAND_SPLITTER_DOUBLECLICKED, \
|
|
id, \
|
|
-1, \
|
|
(wxObjectEventFunction)(wxEventFunction)(wxSplitterEventFunction) &fn, \
|
|
NULL \
|
|
},
|
|
|
|
#define EVT_SPLITTER_UNSPLIT(id, fn) \
|
|
{ \
|
|
wxEVT_COMMAND_SPLITTER_UNSPLIT, \
|
|
id, \
|
|
-1, \
|
|
(wxObjectEventFunction)(wxEventFunction)(wxSplitterEventFunction) &fn, \
|
|
NULL \
|
|
},
|
|
|
|
#endif // __SPLITTERH_G__
|