/////////////////////////////////////////////////////////////////////////////
-// Name: No names yet.
+// Name: controlbar.h
// Purpose: Central header file for control-bar related classes
//
// Author: Aleksandras Gluchovas <mailto:alex@soften.ktu.lt>
#define wxALL_PANES 0x000F
-// enumeration of hittest results, see cbDockPane::HitTestPaneItems(..)
+// enumeration of hittest results, see cbDockPane::HitTestPaneItems(..)
enum CB_HITTEST_RESULT
{
CB_BAR_CONTENT_HITTED
};
-// FIXME:: somehow in debug v. originall wxASSERT's are not compiled in...
+// FIXME:: somehow in debug v. original wxASSERT's are not compiled in...
//#undef wxASSERT
//#define wxASSERT(x) if ( !(x) ) throw;
-// helper class, used for spying for not-handled mouse events on control-bars
-// and forwarding them to the frame layout
+/*
+Helper class, used for spying for unhandled mouse events on control bars
+and forwarding them to the frame layout.
+*/
-class cbBarSpy : public wxEvtHandler
+class cbBarSpy : public wxEvtHandler
{
public:
DECLARE_DYNAMIC_CLASS( cbBarSpy )
wxWindow* mpBarWnd;
public:
+ // Default constructor.
+
cbBarSpy(void);
+ // Constructor, taking a parent pane.
+
cbBarSpy( wxFrameLayout* pPanel );
+ // Sets the bar window.
+
void SetBarWindow( wxWindow* pWnd );
- // overriden
+ // Performs special event processing.
virtual bool ProcessEvent(wxEvent& event);
};
-/* wxFrameLayout manages containment and docking of control bars.
- * which can be docked along top, bottom, righ, or left side of the
- * parent frame
- */
+/*
+wxFrameLayout manages containment and docking of control bars,
+which can be docked along the top, bottom, right, or left side of the
+parent frame.
+*/
class wxFrameLayout : public wxEvtHandler
{
public:
- wxFrameLayout(void); // used only while serializing
+ // Default constructor, used only for serialization.
+
+ wxFrameLayout();
+
+ // Constructor, taking parent window, the (MDI) client of the parent if there
+ // is one, and flag specifying whether to activate the layout.
- wxFrameLayout( wxWindow* pParentFrame,
- wxWindow* pFrameClient = NULL,
+ wxFrameLayout( wxWindow* pParentFrame,
+ wxWindow* pFrameClient = NULL,
bool activateNow = TRUE );
- // (doesn't destroy bar windows)
+ // Destructor. It does not destroy the bar windows.
+
virtual ~wxFrameLayout();
- // (by default floating of control-bars is ON)
+ // Enables floating behaviour. By default floating of control bars is on.
+
virtual void EnableFloating( bool enable = TRUE );
- // Can be called after some other layout has been deactivated,
- // and this one must "take over" the current contents of frame window.
+ // Activate can be called after some other layout has been deactivated,
+ // and this one must take over the current contents of the frame window.
//
- // Effectively hooks itself to the frame window, re-displays all not-hidden
- // bar-windows and repaints decorations
+ // Effectively hooks itself to the frame window, re-displays all non-hidden
+ // bar windows and repaints the decorations.
virtual void Activate();
- // unhooks itself from frame window, and hides all not-hidden windows
+ // Deactivate unhooks itself from frame window, and hides all non-hidden windows.
//
- // NOTE:: two frame-layouts should not be active at the same time in the
- // same frame window, it would cause messy overlapping of bar windows
- // from both layouts
+ // Note: two frame layouts should not be active at the same time in the
+ // same frame window, since it would cause messy overlapping of bar windows
+ // from both layouts.
virtual void Deactivate();
- // also hides the client window if presents
+ // Hides the bar windows, and also the client window if present.
void HideBarWindows();
+ // Destroys the bar windows.
+
virtual void DestroyBarWindows();
- // passes the client window (e.g. MDI-client frame) to be controled by
- // frame layout, the size and position of which should be adjusted to be
- // surrounded by controlbar panes, whenever frame is resized, or dimensions
- // of control panes change
+ // Passes the client window (e.g. MDI client window) to be controlled by
+ // frame layout, the size and position of which should be adjusted to be
+ // surrounded by controlbar panes, whenever the frame is resized or the dimensions
+ // of control panes change.
void SetFrameClient( wxWindow* pFrameClient );
+ // Returns the frame client, or NULL if not present.
+
wxWindow* GetFrameClient();
+ // Returns the parent frame.
+
wxWindow& GetParentFrame() { return *mpFrame; }
- // used by updates-managers
+ // Returns an array of panes. Used by update managers.
+
cbDockPane** GetPanesArray() { return mPanes; }
- // see pane alignment types
+ // Returns a pane for the given alignment. See pane alignment types.
+
cbDockPane* GetPane( int alignment )
{ return mPanes[alignment]; }
- // Adds bar information to frame-layout, appearence of layout is not refreshed
- // immediately, RefreshNow() can be called if necessary.
+ // Adds bar information to the frame layout. The appearance of the layout is not refreshed
+ // immediately; RefreshNow() can be called if necessary.
//
- // NOTES:: argument pBarWnd can by NULL, resulting bar decorations to be drawn
- // around the empty rectangle (filled with default background colour).
- // Argument dimInfo, can be re-used for adding any number of bars, since
- // it is not used directly, instead it's members are copied. If dimensions-
- // handler is present, it's instance shared (reference counted). Dimension
- // handler should always be allocated on the heap!)
-
- virtual void AddBar( wxWindow* pBarWnd,
+ // Notes: the argument pBarWnd can by NULL, resulting in bar decorations to be drawn
+ // around the empty rectangle (filled with default background colour).
+ // Argument dimInfo can be reused for adding any number of bars, since
+ // it is not used directly - instead its members are copied. If the dimensions
+ // handler is present, its instance is shared (reference counted). The dimension
+ // handler should always be allocated on the heap.
+
+ // pBarWnd is the window to be managed.
+
+ // dimInfo contains dimension information.
+
+ // alignment is a value such as FL_ALIGN_TOP.
+
+ // rowNo is the vertical position or row in the pane (if in docked state).
+
+ // columnPos is the horizontal position within the row in pixels (if in docked state).
+
+ // name is a name by which the bar can be referred in layout customization dialogs.
+
+ // If spyEvents is TRUE, input events for the bar should be "spyed" in order
+ // to forward unhandled mouse clicks to the frame layout, for example to enable
+ // easy draggablity of toolbars just by clicking on their interior regions.
+ // For widgets like text/tree control this value should be FALSE,
+ // since there's no certain way to detect whether the event was actually handled.
+
+ // state is the initial state, such as wxCBAR_DOCKED_HORIZONTALLY,
+ // wxCBAR_FLOATING, wxCBAR_HIDDEN.
+
+ virtual void AddBar( wxWindow* pBarWnd,
const cbDimInfo& dimInfo,
// defaults:
int alignment = FL_ALIGN_TOP,
- int rowNo = 0, // vert. position - row in the pane (if docked state)
- int columnPos = 0, // horiz. position in the row in pixels (if docked state)
- const wxString& name="bar",// name, by which the bar could be referred
- // in layout customization dialogs
-
- bool spyEvents = FALSE, // if TRUE - input events for the bar should
- // be "spyed" in order to forward not-handled
- // mouse clicks to frame layout (e.g. to enable
- // easy-draggablity of toolbars just by clicking
- // on their interior regions). For widgets like
- // text/tree control this value should be FALSE
- // (since there's _no_ certain way to detect
- // whether the event was actually handled...)
-
- int state = wxCBAR_DOCKED_HORIZONTALLY // e.g. wxCBAR_FLOATING
- // or wxCBAR_HIDDEN
+ int rowNo = 0,
+ int columnPos = 0,
+ const wxString& name="bar",
+ bool spyEvents = FALSE,
+ int state = wxCBAR_DOCKED_HORIZONTALLY
);
- // can be used for repositioning already existing bars. The given bar is first removed
+ // ReddockBar can be used for repositioning existing bars. The given bar is first removed
// from the pane it currently belongs to, and inserted into the pane, which "matches"
- // the given recantular area. If pToPane is not NULL, bar is docked to this given pane
-
- // to dock the bar which is floated, use wxFrameLayout::DockBar(..) method
+ // the given rectangular area. If pToPane is not NULL, the bar is docked to this given pane.
+ // To dock a bar which is floating, use the wxFrameLayout::DockBar method.
- virtual bool RedockBar( cbBarInfo* pBar, const wxRect& shapeInParent,
+ virtual bool RedockBar( cbBarInfo* pBar, const wxRect& shapeInParent,
cbDockPane* pToPane = NULL, bool updateNow = TRUE );
- // methods for access and modification of bars in frame layout
+ // Finds the bar in the framelayout, by name.
cbBarInfo* FindBarByName( const wxString& name );
+ // Finds the bar in the framelayout, by window.
+
cbBarInfo* FindBarByWindow( const wxWindow* pWnd );
+ // Gets an array of bars.
+
BarArrayT& GetBars();
- // changes bar's docking state (see possible control bar states)
+ // Changes the bar's docking state (see possible control bar states).
void SetBarState( cbBarInfo* pBar, int newStatem, bool updateNow );
+ // Toggles the bar between visible and hidden.
+
void InverseVisibility( cbBarInfo* pBar );
- // reflects changes in bar information structure visually
- // (e.g. moves bar, changes it's dimension info, pane to which it is docked)
+ // Reflects changes in bar information structure visually.
+ // For example, moves the bar, changes its dimension information,
+ // or changes the pane to which it is docked.
void ApplyBarProperties( cbBarInfo* pBar );
- // removes bar from layout permanently, hides it's corresponding window if present
+ // Removes the bar from the layout permanently, and hides its corresponding window if present.
void RemoveBar( cbBarInfo* pBar );
- // recalcualtes layout of panes, and all bars/rows in each pane
+ // Recalculates the layout of panes, and all bars/rows in each pane.
virtual void RecalcLayout( bool repositionBarsNow = FALSE );
+ // Returns the client height.
+
int GetClientHeight();
+
+ // Returns the client width.
+
int GetClientWidth();
+
+ // Returns the client's rectangle.
+
wxRect& GetClientRect() { return mClntWndBounds; }
- // NOTE:: in future ubdates-manager will become a normal plugin
-
+ // Returns a reference to the updates manager.
+ // Note: in future, the updates manager will become a normal plugin.
+
cbUpdatesManagerBase& GetUpdatesManager();
-
- // destroys the previous manager if any, set the new one
+
+ // Destroys the previous manager if any, and sets the new one.
void SetUpdatesManager( cbUpdatesManagerBase* pUMgr );
- // NOTE:: changing properties of panes, does not result immediate on-screen update
+ // Gets the pane properties for the given alignment.
virtual void GetPaneProperties( cbCommonPaneProperties& props, int alignment = FL_ALIGN_TOP );
- virtual void SetPaneProperties( const cbCommonPaneProperties& props,
+ // Sets the pane properties for the given alignment.
+ // Note: changing properties of panes does not result immediate on-screen update.
+
+ virtual void SetPaneProperties( const cbCommonPaneProperties& props,
int paneMask = wxALL_PANES );
- // TODO:: margins should go into cbCommonPaneProperties in the future
+ // Sets the margins for the given panes.
+ // The margins should go into cbCommonPaneProperties in the future.
//
- // NOTE:: this method should be called before any custom plugins are attached
+ // Note: this method should be called before any custom plugins are attached.
virtual void SetMargins( int top, int bottom, int left, int right,
int paneMask = wxALL_PANES );
+ // Sets the pane background colour.
+
virtual void SetPaneBackground( const wxColour& colour );
- // recalculates layoute and performs on-screen update of all panes
+ // Recalculates layout and performs on-screen update of all panes.
void RefreshNow( bool recalcLayout = TRUE );
- // event handlers
+ // Event handler for a size event.
void OnSize ( wxSizeEvent& event );
+
+ // Event handler for a left down button event.
+
void OnLButtonDown( wxMouseEvent& event );
+
+ // Event handler for a left doubleclick button event.
+
void OnLDblClick ( wxMouseEvent& event );
+
+ // Event handler for a left button up event.
+
void OnLButtonUp ( wxMouseEvent& event );
+
+ // Event handler for a right button down event.
+
void OnRButtonDown( wxMouseEvent& event );
+
+ // Event handler for a right button up event.
+
void OnRButtonUp ( wxMouseEvent& event );
- void OnMouseMove ( wxMouseEvent& event );
- /*** plugin-related methods ***/
+ // Event handler for a mouse move event.
- // should be used, instead of passing the event to ProcessEvent(..) method
- // of the top-plugin directly. This method checks if events are currently
+ void OnMouseMove ( wxMouseEvent& event );
+
+ // This function should be used instead of passing the event to the ProcessEvent method
+ // of the top-level plugin directly. This method checks if events are currently
// captured and ensures that plugin-event is routed correctly.
virtual void FirePluginEvent( cbPluginEvent& event );
-
- // captures/releases user-input event's for the given plugin
- // Input events are: mouse movement, mouse clicks, keyboard input
+
+ // Captures user input events for the given plugin.
+ // Input events are: mouse movement, mouse clicks, keyboard input.
virtual void CaptureEventsForPlugin ( cbPluginBase* pPlugin );
+
+ // Releases user input events for the given plugin.
+ // Input events are: mouse movement, mouse clicks, keyboard input
+
virtual void ReleaseEventsFromPlugin( cbPluginBase* pPlugin );
- // called by plugins ( also captures/releases mouse in parent frame)
+ // Called by plugins; also captures the mouse in the parent frame.
+
void CaptureEventsForPane( cbDockPane* toPane );
+
+ // Called by plugins; also releases mouse in the parent frame.
+
void ReleaseEventsFromPane( cbDockPane* fromPane );
- // returns current top-level plugin (the one which receives events first,
- // with an exception if input-events are currently captured by some other plugin)
-
+ // Returns the current top-level plugin (the one that receives events first,
+ // except if input events are currently captured by some other plugin).
+
virtual cbPluginBase& GetTopPlugin();
- // hooking custom plugins to frame layout
+ // Hooking custom plugins to frame layout.
//
- // NOTE:: when hooking one plugin on top of the other -
- // use SetNextHandler(..) or similar methods
- // of wxEvtHandler class to compose the chain of plugins,
- // than pass the left-most handler in this chain to
- // the above methods (assuming that events are delegated
- // from left-most towards right-most handler)
+ // Note: when hooking one plugin on top of the other,
+ // use SetNextHandler or similar methods
+ // of wxEvtHandler class to compose the chain of plugins,
+ // than pass the left-most handler in this chain to
+ // the above methods (assuming that events are delegated
+ // from left-most towards right-most handler).
//
- // NOTE2:: this secenario is very inconvenient and "low-level",
- // use Add/Push/PopPlugin methods instead
+ // This secenario is very inconvenient and "low-level",
+ // so use the Add/Push/PopPlugin methods instead.
virtual void SetTopPlugin( cbPluginBase* pPlugin );
- // similar to wxWindow's "push/pop-event-handler" methods, execept
- // that plugin is *deleted* upon "popping"
+ // Similar to wxWindow's "push/pop-event-handler" methods, execept
+ // that the plugin is deleted upon "popping".
virtual void PushPlugin( cbPluginBase* pPugin );
+
+ // Similar to wxWindow's "push/pop-event-handler" methods, execept
+ // that the plugin is deleted upon "popping".
+
virtual void PopPlugin();
+ // Pop all plugins.
virtual void PopAllPlugins();
- // default plugins are : cbPaneDrawPlugin, cbRowLayoutPlugin, cbBarDragPlugin,
- // cbAntiflickerPlugin, cbSimpleCustomizePlugin
+ // Adds the default plugins. These are cbPaneDrawPlugin, cbRowLayoutPlugin, cbBarDragPlugin,
+ // cbAntiflickerPlugin, cbSimpleCustomizePlugin.
//
- // this method is automatically invoked, if no plugins were found upon
- // fireing of the first plugin-event, i.e. wxFrameLayout *CONFIGURES* itself
+ // This method is automatically invoked if no plugins were found upon
+ // firing of the first plugin-event, i.e. when wxFrameLayout configures itself.
virtual void PushDefaultPlugins();
- /* "Advanced" methods for plugin-configuration using their */
- /* dynamic class information (e.g. CLASSINFO(pluginClass) ) */
+ // An advanced methods for plugin configuration using their
+ // dynamic class information, for example CLASSINFO(pluginClass).
- // first checks if plugin of the given class is already "hooked up",
- // if not, adds it to the top of plugins chain
+ // First checks if the plugin of the given class is already "hooked up".
+ // If not, adds it to the top of the plugins chain.
virtual void AddPlugin( wxClassInfo* pPlInfo, int paneMask = wxALL_PANES );
- // first checks if plugin of the givne class already hooked,
- // if so, removes it, and then inserts it to the chain
- // before plugin of the class given by "pNextPlInfo"
+ // First checks if the plugin of the given class is already hooked.
+ // If so, removes it, and then inserts it into the chain
+ // before the plugin of the class given by pNextPlInfo.
//
- // NOTE:: this method is "handy" in some cases, where the order
- // of plugin-chain could be important, e.g. one plugin overrides
- // some functionallity of the other already hooked plugin,
- // thefore the former should be hooked before the one
- // who's functionality is being overriden
+ // Note: this method is handy in some cases where the order
+ // of the plugin-chain could be important, for example when one plugin overrides
+ // some functionality of another already-hooked plugin,
+ // so that the former plugin should be hooked before the one
+ // whose functionality is being overridden.
- virtual void AddPluginBefore( wxClassInfo* pNextPlInfo, wxClassInfo* pPlInfo,
+ virtual void AddPluginBefore( wxClassInfo* pNextPlInfo, wxClassInfo* pPlInfo,
int paneMask = wxALL_PANES );
- // checks if plugin of the given class is hooked, removes
- // it if found
- //
- // @param pPlInfo class information structure for the plugin
- // @note
- // @see wxFrameLayout::Method
-
+ // Checks if the plugin of the given class is hooked, and removes
+ // it if found.
virtual void RemovePlugin( wxClassInfo* pPlInfo );
- // returns NULL, if plugin of the given class is not hooked
+ // Finds a plugin with the given class, or returns NULL if a plugin of the given
+ // class is not hooked.
virtual cbPluginBase* FindPlugin( wxClassInfo* pPlInfo );
+ // Returns true if there is a top plugin.
+
bool HasTopPlugin();
DECLARE_EVENT_TABLE()
// pane, from which mouse pointer had just left
- cbDockPane* mpLRUPane;
+ cbDockPane* mpLRUPane;
// bounds of client window in parent frame's coordinates
cbPluginBase* mpTopPlugin;
- // plugin, which currently has captured all input events, otherwise NULL
+ // plugin, which currently has captured all input events, otherwise NULL
cbPluginBase* mpCaputesInput;
- // list of event handlers which are "pushed" onto each bar, to catch
+ // list of event handlers which are "pushed" onto each bar, to catch
// mouse events which are not handled by bars, and froward them to the ,
// frome-layout and further to plugins
public: /* protected really (accessed only by plugins) */
- // refrence to custom updates manager
+ // refrence to custom updates manager
cbUpdatesManagerBase* mpUpdatesMgr;
- // called to set calculated layout to window objects
+ // Called to apply the calculated layout to window objects.
+
void PositionClientWindow();
+
+ // Called to apply the calculated layout to window objects.
+
void PositionPanes();
+
+ // Creates the cursors.
+
void CreateCursors();
+ // Applies the calculated layout to a floating bar.
+
void RepositionFloatedBar( cbBarInfo* pBar );
+
+ // Applies the state to the window objects.
+
void DoSetBarState( cbBarInfo* pBar );
- bool LocateBar( cbBarInfo* pBarInfo,
+ // The purpose of this function is unknown.
+
+ bool LocateBar( cbBarInfo* pBarInfo,
cbRowInfo** ppRow,
cbDockPane** ppPane );
+ // Returns TRUE if the position is within the given pane.
+
bool HitTestPane( cbDockPane* pPane, int x, int y );
+
+ // Returns the pane for which the rectangle hit test succeeds, giving
+ // preference to the given pane if supplied.
+
cbDockPane* HitTestPanes( const wxRect& rect, cbDockPane* pCurPane );
- // returns panes, to which the given bar belongs
+ // Returns the pane to which the given bar belongs.
cbDockPane* GetBarPane( cbBarInfo* pBar );
- // delegated from "bar-spy"
- void ForwardMouseEvent( wxMouseEvent& event,
+ // Delegated from "bar-spy".
+ void ForwardMouseEvent( wxMouseEvent& event,
cbDockPane* pToPane,
int eventType );
+ // Routes the mouse event to the appropriate pane.
+
void RouteMouseEvent( wxMouseEvent& event, int pluginEvtType );
+ // Shows all floated windows.
+
void ShowFloatedWindows( bool show );
+ // Unhooks the layout from the frame.
+
void UnhookFromFrame();
+
+ // Hooks the layout up to the frame (pushes the layout onto the
+ // frame's event handler stack).
+
void HookUpToFrame();
- // NOTE:: reparenting of windows may NOT work on all platforms
- // (reparenting allows control-bars to be floated)
+ // Returns TRUE if the platform allows reparenting. This may not return TRUE
+ // for all platforms. Reparenting allows control bars to be floated.
bool CanReparent();
+
+ // Reparents pChild to have parent pNewParent.
+
void ReparentWindow( wxWindow* pChild, wxWindow* pNewParent );
+ // Returns the previous client window rectangle.
+
wxRect& GetPrevClientRect() { return mPrevClntWndBounds; }
+ // Handles paint events, calling PaintPane for each pane.
+
void OnPaint( wxPaintEvent& event );
+
+ // Handles background erase events. Currently does nothing.
+
void OnEraseBackground( wxEraseEvent& event );
+
+ // Handles focus kill events. Currently does nothing.
+
void OnKillFocus( wxFocusEvent& event );
+
+ // Handles focus set events. Currently does nothing.
+
void OnSetFocus( wxFocusEvent& event );
+
+ // Handles activation events. Currently does nothing.
+
void OnActivate( wxActivateEvent& event );
+
+ // Handles idle events.
+
void OnIdle( wxIdleEvent& event );
- // factory method
+ // Returns a new cbGCUpdatesMgr object.
+
virtual cbUpdatesManagerBase* CreateUpdatesManager();
};
-/* structure, which is present in each item of layout,
- * it used by any specific updates-manager to store
- * auxilary information to be used by it's specific
- * updating algorithm
- */
+/*
+A structure that is present in each item of layout,
+used by any particular updates-manager to store
+auxiliary information to be used by its updating algorithm.
+*/
class cbUpdateMgrData : public wxObject
{
bool mIsDirty; // overrides result of current-against-previous bounds comparison,
// i.e. requires item to be updated, regardless of it's current area
-
+
wxObject* mpCustomData; // any custom data stored by specific updates mgr.
- cbUpdateMgrData(); // is-dirty flag is set TRUE initially
+ // Default constructor. Is-dirty flag is set TRUE initially.
+
+ cbUpdateMgrData();
+
+ // Store the item state.
void StoreItemState( const wxRect& boundsInParent );
+ // Set the dirty flag.
+
void SetDirty( bool isDirty = TRUE );
+ // Set custom data.
+
void SetCustomData( wxObject* pCustomData );
+ // Returns the is-dirty flag.
+
inline bool IsDirty() { return mIsDirty; }
};
-/* Abstract interface for bar-size handler classes.
- * These objects receive notifications, whenever the docking
- * state of the bar is changed, thus they have a possibility
- * to adjust the values in cbDimInfo::mSizes accordingly.
- * Specific handlers can be hooked to specific types of bars.
- */
+/*
+Abstract interface for bar-size handler classes.
+These objects receive notifications whenever the docking
+state of the bar is changed, thus they provide the possibility
+to adjust the values in cbDimInfo::mSizes accordingly.
+Specific handlers can be hooked up to specific types of bar.
+*/
class cbBarDimHandlerBase : public wxObject
{
// from the bar's actual window, filled
// with frame's beckground color, default: 0
- int mVertGap;
+ int mVertGap;
// left/right gap, separates decorations
// from the bar's actual window, filled
bool mIsFixed;
- cbBarDimHandlerBase* mpHandler; // NULL, if no handler present
+ cbBarDimHandlerBase* mpHandler; // NULL, if no handler present
public:
cbBarDimHandlerBase* pDimHandler = NULL
);
- cbDimInfo( int x, int y,
- bool isFixed = TRUE,
- int gap = 6,
+ cbDimInfo( int x, int y,
+ bool isFixed = TRUE,
+ int gap = 6,
cbBarDimHandlerBase* pDimHandler = NULL
- );
+ );
const cbDimInfo& operator=( const cbDimInfo& other );
// destroys handler automatically, if present
~cbDimInfo();
- inline cbBarDimHandlerBase* GetDimHandler() { return mpHandler; }
+ inline cbBarDimHandlerBase* GetDimHandler() { return mpHandler; }
};
WX_DEFINE_ARRAY(float, cbArrayFloat);
// convenience method
- inline cbBarInfo* GetFirstBar()
+ inline cbBarInfo* GetFirstBar()
{ return mBars.GetCount() ? mBars[0] : NULL; }
};
wxString mName;
// stores bar's bounds in pane's coordinates
- wxRect mBounds;
+ wxRect mBounds;
// stores precalculated bar's bounds in parent frame's coordinates
- wxRect mBoundsInParent;
+ wxRect mBoundsInParent;
// back-ref to the row, which contains this bar
- cbRowInfo* mpRow;
+ cbRowInfo* mpRow;
// are set up according to the types of the surrounding bars in the row
bool mHasLeftHandle;
bool mHasRightHandle;
cbDimInfo mDimInfo; // preferred sizes for each, control bar state
-
+
int mState; // (see definition of controlbar states)
int mAlignment; // alignment of the pane to which this
wxPoint mPosIfFloated; // stored last position when bar was in "floated" state
// poistion is stored in parent-window's coordinates
-
+
cbUpdateMgrData mUMgrData; // info stored for updates-manager
cbBarInfo* mpNext; // next. bar in the row
void Reset();
bool Next(); // TRUE, if next bar is available
-
+
cbBarInfo& BarInfo();
// returns reference to currently traversed row
cbRowInfo& RowInfo();
};
-/* structure holds configuration options,
+/* structure holds configuration options,
* which are usually the same for all panes in
* frame layout
*/
// minimal dimensions for not-fixed bars in this pane (16x16 default)
- wxSize mMinCBarDim;
+ wxSize mMinCBarDim;
// width/height of resizing sash
-
+
int mResizeHandleSize;
cbCommonPaneProperties(void);
};
-/* class manages containment and control of control-bars
+/* class manages containment and control of control-bars
* along one of the four edges of the parent frame
*/
int mRightMargin; // default: 2 pixels
int mTopMargin; // default: 2 pixels
int mBottomMargin; // default: 2 pixels
-
+
public:
// position of the pane in frame's coordinates
- wxRect mBoundsInParent;
+ wxRect mBoundsInParent;
// pane width and height in pane's coordinates
int mPaneWidth;
// transient properties
- wxList mRowShapeData; // shapes of bars of recently modified row,
+ wxList mRowShapeData; // shapes of bars of recently modified row,
// stored when in "non-destructive-firction" mode
cbRowInfo* mpStoredRow; // row-info for which the shapes are stored
int GetRowAt( int paneY );
int GetRowAt( int upperY, int lowerY );
- // re-setups flags in the row-information structure, so that
- // the would match the changed state of row-items correctly
+ // re-setups flags in the row-information structure, so that
+ // the would match the changed state of row-items correctly
void SyncRowFlags( cbRowInfo* pRow );
// layout "AI" helpers:
void InitLinksForRow( cbRowInfo* pRow );
void InitLinksForRows();
- // coordinate translation between parent's frame and this pane
+ // coordinate translation between parent's frame and this pane
void FrameToPane( int* x, int* y );
void PaneToFrame( int* x, int* y );
public: /* protected really (accessed only by plugins) */
- // methods for incramental on-screen refreshing of the pane
+ // methods for incramental on-screen refreshing of the pane
// (simply, they are wrappers around corresponding plugin-events)
virtual void PaintBarDecorations( cbBarInfo* pBar, wxDC& dc );
virtual void RemoveBar( cbBarInfo* pBar );
// rect given in the parent frame's coordinates
-
+
virtual void InsertBar( cbBarInfo* pBar, const wxRect& atRect );
// inserts bar into the given row, with dimensions and position
virtual void InsertBar( cbBarInfo* pBar, cbRowInfo* pIntoRow );
- // inserts bar, sets its position according to the preferred settings
+ // inserts bar, sets its position according to the preferred settings
// given in (*pBarInfo) structure
virtual void InsertBar( cbBarInfo* pBarInfo );
// does not destroy the row object, only removes the corresponding
// node from this pane
virtual void RemoveRow( cbRowInfo* pRow );
-
+
// does not refresh the inserted row immediately,
// if pBeforeRowNode arg. is NULL, row is appended to the end of pane's row list
virtual void InsertRow( cbRowInfo* pRow, cbRowInfo* pBeforeRow );
// convenience method
- inline cbRowInfo* GetFirstRow()
-
+ inline cbRowInfo* GetFirstRow()
+
{ return mRows.GetCount() ? mRows[0] : NULL; }
// TRUE, if the given bar node presents in this pane
: mpLayout( pPanel ) {}
virtual ~cbUpdatesManagerBase() {}
-
+
void SetLayout( wxFrameLayout* pLayout ) { mpLayout = pLayout; }
// notificiactions received from frame-layout (in the order, in which
cbDockPane* mpPane; // NULL, if event is not addressed to any specific pane
/* OLD STUFF::
- // FOR NOW FOR NOW:: all-in-one plugin event structure
+ // FOR NOW FOR NOW:: all-in-one plugin event structure
wxNode* mpObjNode;
wxNode* mpObjNodeAux;
wxPoint mPos;
bool mAuxBoolVal;
*/
+ // Not used, but required
+ virtual wxEvent* Clone() const { return NULL; }
+
#if wxCHECK_VERSION(2,3,0)
cbPluginEvent( wxEventType eventType, cbDockPane* pPane )
: mpPane( pPane )
-
+
{ m_eventType = eventType; }
#else
cbPluginEvent( int eventType, cbDockPane* pPane )
: mpPane( pPane )
-
+
{ m_eventType = eventType; }
#endif
};
#define cbEVT_PL_LEFT_DCLICK 5
- #define cbEVT_PL_LAYOUT_ROW 6
+ #define cbEVT_PL_LAYOUT_ROW 6
#define cbEVT_PL_RESIZE_ROW 7
#define cbEVT_PL_LAYOUT_ROWS 8
#define cbEVT_PL_INSERT_BAR 9
class cbCustomizeLayoutEvent;
// defs. for handler-methods
-
+
typedef void (wxEvtHandler::*cbLeftDownHandler )(cbLeftDownEvent&);
typedef void (wxEvtHandler::*cbLeftUpHandler )(cbLeftUpEvent&);
typedef void (wxEvtHandler::*cbRightDownHandler )(cbRightDownEvent&);
#define EVT_PL_RIGHT_UP(func) wxEventTableEntry( cbEVT_PL_RIGHT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbRightUpHandler ) & func, (wxObject *) NULL ),
#define EVT_PL_MOTION(func) wxEventTableEntry( cbEVT_PL_MOTION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbMotionHandler ) & func, (wxObject *) NULL ),
#define EVT_PL_LEFT_DCLICK(func) wxEventTableEntry( cbEVT_PL_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbLeftDClickHandler ) & func, (wxObject *) NULL ),
-
+
#define EVT_PL_LAYOUT_ROW(func) wxEventTableEntry( cbEVT_PL_LAYOUT_ROW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbLayoutRowHandler ) & func, (wxObject *) NULL ),
#define EVT_PL_RESIZE_ROW(func) wxEventTableEntry( cbEVT_PL_RESIZE_ROW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbResizeRowHandler ) & func, (wxObject *) NULL ),
#define EVT_PL_LAYOUT_ROWS(func) wxEventTableEntry( cbEVT_PL_LAYOUT_ROWS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbLayoutRowsHandler ) & func, (wxObject *) NULL ),
#define EVT_PL_RESIZE_BAR(func) wxEventTableEntry( cbEVT_PL_RESIZE_BAR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbResizeBarHandler ) & func, (wxObject *) NULL ),
#define EVT_PL_REMOVE_BAR(func) wxEventTableEntry( cbEVT_PL_REMOVE_BAR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbRemoveBarHandler ) & func, (wxObject *) NULL ),
#define EVT_PL_SIZE_BAR_WND(func) wxEventTableEntry( cbEVT_PL_SIZE_BAR_WND, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbSizeBarWndHandler ) & func, (wxObject *) NULL ),
-
+
#define EVT_PL_DRAW_BAR_DECOR(func) wxEventTableEntry( cbEVT_PL_DRAW_BAR_DECOR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbDrawBarDecorHandler ) & func, (wxObject *) NULL ),
#define EVT_PL_DRAW_ROW_DECOR(func) wxEventTableEntry( cbEVT_PL_DRAW_ROW_DECOR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbDrawRowDecorHandler ) & func, (wxObject *) NULL ),
#define EVT_PL_DRAW_PANE_DECOR(func) wxEventTableEntry( cbEVT_PL_DRAW_PANE_DECOR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbDrawPaneDecorHandler ) & func, (wxObject *) NULL ),
#define EVT_PL_DRAW_ROW_HANDLES(func) wxEventTableEntry( cbEVT_PL_DRAW_ROW_HANDLES, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbDrawRowHandlesHandler ) & func, (wxObject *) NULL ),
#define EVT_PL_DRAW_ROW_BKGROUND(func) wxEventTableEntry( cbEVT_PL_DRAW_ROW_BKGROUND, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbDrawRowBkGroundHandler ) & func, (wxObject *) NULL ),
#define EVT_PL_DRAW_PANE_BKGROUND(func) wxEventTableEntry( cbEVT_PL_DRAW_PANE_BKGROUND, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbDrawPaneBkGroundHandler) & func, (wxObject *) NULL ),
-
+
#define EVT_PL_START_BAR_DRAGGING(func) wxEventTableEntry( cbEVT_PL_START_BAR_DRAGGING, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbStartBarDraggingHandler) & func, (wxObject *) NULL ),
#define EVT_PL_DRAW_HINT_RECT(func) wxEventTableEntry( cbEVT_PL_DRAW_HINT_RECT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbDrawHintRectHandler ) & func, (wxObject *) NULL ),
#define EVT_PL_RIGHT_UP(func) { cbEVT_PL_RIGHT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbRightUpHandler ) & func },
#define EVT_PL_MOTION(func) { cbEVT_PL_MOTION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbMotionHandler ) & func },
#define EVT_PL_LEFT_DCLICK(func) { cbEVT_PL_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbLeftDClickHandler ) & func },
-
+
#define EVT_PL_LAYOUT_ROW(func) { cbEVT_PL_LAYOUT_ROW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbLayoutRowHandler ) & func },
#define EVT_PL_RESIZE_ROW(func) { cbEVT_PL_RESIZE_ROW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbResizeRowHandler ) & func },
#define EVT_PL_LAYOUT_ROWS(func) { cbEVT_PL_LAYOUT_ROWS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbLayoutRowsHandler ) & func },
#define EVT_PL_RESIZE_BAR(func) { cbEVT_PL_RESIZE_BAR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbResizeBarHandler ) & func },
#define EVT_PL_REMOVE_BAR(func) { cbEVT_PL_REMOVE_BAR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbRemoveBarHandler ) & func },
#define EVT_PL_SIZE_BAR_WND(func) { cbEVT_PL_SIZE_BAR_WND, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbSizeBarWndHandler ) & func },
-
+
#define EVT_PL_DRAW_BAR_DECOR(func) { cbEVT_PL_DRAW_BAR_DECOR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbDrawBarDecorHandler ) & func },
#define EVT_PL_DRAW_ROW_DECOR(func) { cbEVT_PL_DRAW_ROW_DECOR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbDrawRowDecorHandler ) & func },
#define EVT_PL_DRAW_PANE_DECOR(func) { cbEVT_PL_DRAW_PANE_DECOR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbDrawPaneDecorHandler ) & func },
#define EVT_PL_DRAW_ROW_HANDLES(func) { cbEVT_PL_DRAW_ROW_HANDLES, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbDrawRowHandlesHandler ) & func },
#define EVT_PL_DRAW_ROW_BKGROUND(func) { cbEVT_PL_DRAW_ROW_BKGROUND, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbDrawRowBkGroundHandler ) & func },
#define EVT_PL_DRAW_PANE_BKGROUND(func) { cbEVT_PL_DRAW_PANE_BKGROUND, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbDrawPaneBkGroundHandler) & func },
-
+
#define EVT_PL_START_BAR_DRAGGING(func) { cbEVT_PL_START_BAR_DRAGGING, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbStartBarDraggingHandler) & func },
#define EVT_PL_DRAW_HINT_RECT(func) { cbEVT_PL_DRAW_HINT_RECT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbDrawHintRectHandler ) & func },
#define EVT_PL_CUSTOMIZE_BAR(func) { cbEVT_PL_CUSTOMIZE_BAR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbCustomizeBarHandler) & func },
#define EVT_PL_CUSTOMIZE_LAYOUT(func) { cbEVT_PL_CUSTOMIZE_LAYOUT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (cbCustomizeLayoutHandler) & func },
#endif
-/*
- * abstract base class for all control-bar related plugins
+/*
+ * abstract base class for all control-bar related plugins
*/
class cbPluginBase : public wxEvtHandler
DECLARE_ABSTRACT_CLASS( cbPluginBase )
public:
- wxFrameLayout* mpLayout; // back-reference to the frame layout
+ wxFrameLayout* mpLayout; // back-reference to the frame layout
// specifies panes, for which this plugin receives events
// (see pane masks definitions)
- int mPaneMask;
+ int mPaneMask;
bool mIsReady; // is TRUE, when plugin is ready to handle events
public:
- cbPluginBase(void)
+ cbPluginBase(void)
: mpLayout ( 0 ),
mPaneMask( wxALL_PANES ),
mIsReady ( FALSE )
{}
- cbPluginBase( wxFrameLayout* pPanel, int paneMask = wxALL_PANES )
+ cbPluginBase( wxFrameLayout* pPanel, int paneMask = wxALL_PANES )
: mpLayout ( pPanel ),
mPaneMask( paneMask ),
projects / wxWidgets.git / blobdiff