class WXDLLIMPEXP_FWD_CORE wxCursor;
class WXDLLIMPEXP_FWD_CORE wxDC;
class WXDLLIMPEXP_FWD_CORE wxDropTarget;
-class WXDLLIMPEXP_FWD_CORE wxItemResource;
class WXDLLIMPEXP_FWD_CORE wxLayoutConstraints;
-class WXDLLIMPEXP_FWD_CORE wxResourceTable;
class WXDLLIMPEXP_FWD_CORE wxSizer;
class WXDLLIMPEXP_FWD_CORE wxToolTip;
class WXDLLIMPEXP_FWD_CORE wxWindowBase;
#define wxWINDOW_DEFAULT_VARIANT wxT("window-default-variant")
#endif
+// valid values for Show/HideWithEffect()
+enum wxShowEffect
+{
+ wxSHOW_EFFECT_ROLL,
+ wxSHOW_EFFECT_SLIDE,
+ wxSHOW_EFFECT_BLEND,
+ wxSHOW_EFFECT_EXPAND,
+ wxSHOW_EFFECT_MAX
+};
+
// ----------------------------------------------------------------------------
// (pseudo)template list classes
// ----------------------------------------------------------------------------
wxWindowVariant GetWindowVariant() const { return m_windowVariant; }
- // window id uniquely identifies the window among its siblings unless
- // it is wxID_ANY which means "don't care"
- void SetId( wxWindowID winid ) { m_windowId = winid; }
- wxWindowID GetId() const { return m_windowId; }
-
// get or change the layout direction (LTR or RTL) for this window,
// wxLayout_Default is returned if layout direction is not supported
virtual wxLayoutDirection GetLayoutDirection() const
wxCoord width,
wxCoord widthTotal) const;
- // generate a control id for the controls which were not given one by
- // user
- static int NewControlId() { return --ms_lastControlId; }
- // get the id of the control following the one with the given
- // (autogenerated) id
- static int NextControlId(int winid) { return winid - 1; }
- // get the id of the control preceding the one with the given
- // (autogenerated) id
- static int PrevControlId(int winid) { return winid + 1; }
+
+ // window id uniquely identifies the window among its siblings unless
+ // it is wxID_ANY which means "don't care"
+ void SetId( wxWindowID winid ) { m_windowId = winid; }
+ wxWindowID GetId() const { return m_windowId; }
+
+ // generate a unique id (or count of them consecutively), returns a
+ // valid id in the auto-id range or wxID_NONE if failed. If using
+ // autoid management, it will mark the id as reserved until it is
+ // used (by assigning it to a wxWindowIDRef) or unreserved.
+ static wxWindowID NewControlId(int count = 1)
+ {
+ return wxIdManager::ReserveId(count);
+ }
+
+ // If an ID generated from NewControlId is not assigned to a wxWindowIDRef,
+ // it must be unreserved
+ static void UnreserveControlId(wxWindowID id, int count = 1)
+ {
+ wxIdManager::UnreserveId(id, count);
+ }
+
// moving/resizing
// ---------------
const wxSize& incSize=wxDefaultSize)
{ DoSetSizeHints(minSize.x, minSize.y, maxSize.x, maxSize.y, incSize.x, incSize.y); }
- virtual void DoSetSizeHints( int minW, int minH,
- int maxW, int maxH,
- int incW, int incH );
- // Methods for setting virtual size hints
- // FIXME: What are virtual size hints?
-
- virtual void SetVirtualSizeHints( int minW, int minH,
- int maxW = wxDefaultCoord, int maxH = wxDefaultCoord );
- void SetVirtualSizeHints( const wxSize& minSize,
- const wxSize& maxSize=wxDefaultSize)
- {
- SetVirtualSizeHints(minSize.x, minSize.y, maxSize.x, maxSize.y);
- }
+#if WXWIN_COMPATIBILITY_2_8
+ // these are useless and do nothing since wxWidgets 2.9
+ wxDEPRECATED( virtual void SetVirtualSizeHints( int minW, int minH,
+ int maxW = wxDefaultCoord, int maxH = wxDefaultCoord ) );
+ wxDEPRECATED( void SetVirtualSizeHints( const wxSize& minSize,
+ const wxSize& maxSize=wxDefaultSize) );
+#endif // WXWIN_COMPATIBILITY_2_8
// Call these to override what GetBestSize() returns. This
// components of the result respectively
virtual wxSize GetWindowBorderSize() const;
+ // wxSizer and friends use this to give a chance to a component to recalc
+ // its min size once one of the final size components is known. Override
+ // this function when that is useful (such as for wxStaticText which can
+ // stretch over several lines). Parameter availableOtherDir
+ // tells the item how much more space there is available in the opposite
+ // direction (-1 if unknown).
+ virtual bool InformFirstDirection( int WXUNUSED(direction), int WXUNUSED(size), int WXUNUSED(availableOtherDir) )
+ { return false; }
// window state
// ------------
virtual bool Show( bool show = true );
bool Hide() { return Show(false); }
+ // show or hide the window with a special effect, not implemented on
+ // most platforms (where it is the same as Show()/Hide() respectively)
+ //
+ // timeout specifies how long the animation should take, in ms, the
+ // default value of 0 means to use the default (system-dependent) value
+ //
+ // direction is only used with wxSHOW_EFFECT_ROLL and SLIDE values
+ virtual bool ShowWithEffect(wxShowEffect effect,
+ unsigned timeout = 0,
+ wxDirection dir = wxBOTTOM)
+ {
+ wxUnusedVar(effect);
+ wxUnusedVar(timeout);
+ wxUnusedVar(dir);
+
+ return Show();
+ }
+
+ virtual bool HideWithEffect(wxShowEffect effect,
+ unsigned timeout = 0,
+ wxDirection dir = wxBOTTOM)
+ {
+ wxUnusedVar(effect);
+ wxUnusedVar(timeout);
+ wxUnusedVar(dir);
+
+ return Hide();
+ }
+
// returns true if window was enabled/disabled, false if nothing done
virtual bool Enable( bool enable = true );
bool Disable() { return Enable(false); }
static wxWindow *DoFindFocus() /* = 0: implement in derived classes */;
+ // return true if the window has focus (handles composite windows
+ // correctly - returns true if GetMainWindowOfCompositeControl()
+ // has focus)
+ virtual bool HasFocus() const;
+
// can this window have focus in principle?
//
// the difference between AcceptsFocus[FromKeyboard]() and CanAcceptFocus
// move this window just before/after the specified one in tab order
// (the other window must be our sibling!)
void MoveBeforeInTabOrder(wxWindow *win)
- { DoMoveInTabOrder(win, MoveBefore); }
+ { DoMoveInTabOrder(win, OrderBefore); }
void MoveAfterInTabOrder(wxWindow *win)
- { DoMoveInTabOrder(win, MoveAfter); }
+ { DoMoveInTabOrder(win, OrderAfter); }
// parent/children relations
// needed just for extended runtime
const wxWindowList& GetWindowChildren() const { return GetChildren() ; }
+ // get the window before/after this one in the parents children list,
+ // returns NULL if this is the first/last window
+ wxWindow *GetPrevSibling() const { return DoGetSibling(OrderBefore); }
+ wxWindow *GetNextSibling() const { return DoGetSibling(OrderAfter); }
+
// get the parent or the parent of the parent
wxWindow *GetParent() const { return m_parent; }
inline wxWindow *GetGrandParent() const;
// be there)
bool RemoveEventHandler(wxEvtHandler *handler);
+ // Process an event by calling GetEventHandler()->ProcessEvent() and
+ // handling any exceptions thrown by event handlers. It's mostly useful
+ // when processing wx events when called from C code (e.g. in GTK+
+ // callback) when the exception wouldn't correctly propagate to
+ // wxEventLoop.
+ bool HandleWindowEvent(wxEvent& event) const;
+
// validators
// ----------
virtual void ClearBackground();
// freeze the window: don't redraw it until it is thawed
- virtual void Freeze() { }
+ void Freeze() { if ( !m_freezeCount++ ) DoFreeze(); }
// thaw the window: redraw it after it had been frozen
- virtual void Thaw() { }
+ void Thaw()
+ {
+ wxASSERT_MSG( m_freezeCount, "Thaw() without matching Freeze()" );
+
+ if ( !--m_freezeCount )
+ DoThaw();
+ }
// return true if window had been frozen and not unthawed yet
- virtual bool IsFrozen() const { return false; }
+ bool IsFrozen() const { return m_freezeCount != 0; }
// adjust DC for drawing on this window
virtual void PrepareDC( wxDC & WXUNUSED(dc) ) { }
// show popup menu at the given position, generate events for the items
// selected in it
bool PopupMenu(wxMenu *menu, const wxPoint& pos = wxDefaultPosition)
- { return DoPopupMenu(menu, pos.x, pos.y); }
- bool PopupMenu(wxMenu *menu, int x, int y)
- { return DoPopupMenu(menu, x, y); }
+ { return PopupMenu(menu, pos.x, pos.y); }
+ bool PopupMenu(wxMenu *menu, int x, int y);
// simply return the id of the selected item or wxID_NONE without
// generating any events
bool PageUp() { return ScrollPages(-1); }
bool PageDown() { return ScrollPages(1); }
+ // call this to always show one or both scrollbars, even if the window
+ // is big enough to not require them
+ virtual void AlwaysShowScrollbars(bool WXUNUSED(horz) = true,
+ bool WXUNUSED(vert) = true)
+ {
+ }
+
+ // return true if AlwaysShowScrollbars() had been called before for the
+ // corresponding orientation
+ virtual bool IsScrollbarAlwaysShown(int WXUNUSED(orient)) const
+ {
+ return false;
+ }
+
// context-sensitive help
// ----------------------
// area (normal windows can't, but e.g. menubar or statusbar can):
virtual bool CanBeOutsideClientArea() const { return false; }
- // returns true if the platform should explicitly apply a theme border
+ // returns true if the platform should explicitly apply a theme border. Currently
+ // used only by Windows
virtual bool CanApplyThemeBorder() const { return true; }
protected:
virtual bool TryValidator(wxEvent& event);
virtual bool TryParent(wxEvent& event);
- // common part of MoveBefore/AfterInTabOrder()
- enum MoveKind
+ enum WindowOrder
{
- MoveBefore, // insert before the given window
- MoveAfter // insert after the given window
+ OrderBefore, // insert before the given window
+ OrderAfter // insert after the given window
};
- virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move);
+
+ // common part of GetPrev/NextSibling()
+ wxWindow *DoGetSibling(WindowOrder order) const;
+
+ // common part of MoveBefore/AfterInTabOrder()
+ virtual void DoMoveInTabOrder(wxWindow *win, WindowOrder move);
// implementation of Navigate() and NavigateIn()
virtual bool DoNavigateIn(int flags);
-
#if wxUSE_CONSTRAINTS
// satisfy the constraints for the windows but don't set the window sizes
void SatisfyConstraints();
// the window id - a number which uniquely identifies a window among
// its siblings unless it is wxID_ANY
- wxWindowID m_windowId;
+ wxWindowIDRef m_windowId;
// the parent window of this window (or NULL) and the list of the children
// of this window
wxScrollHelper *m_scrollHelper;
- int m_minVirtualWidth; // VirtualSizeHints
- int m_minVirtualHeight;
- int m_maxVirtualWidth;
- int m_maxVirtualHeight;
-
wxWindowVariant m_windowVariant ;
// override this to change the default (i.e. used when no style is
// this allows you to implement standard control borders without
// repeating the code in different classes that are not derived from
// wxControl
- virtual wxBorder GetDefaultBorderForControl() const { return wxBORDER_SUNKEN; }
+ virtual wxBorder GetDefaultBorderForControl() const { return wxBORDER_THEME; }
// Get the default size for the new window if no explicit size given. TLWs
// have their own default size so this is just for non top-level windows.
// same size as it would have after a call to Fit()
virtual wxSize DoGetBestSize() const;
- // called from DoGetBestSize() to convert best virtual size (returned by
- // the window sizer) to the best size for the window itself; this is
- // overridden at wxScrolledWindow level to clump down virtual size to real
- virtual wxSize GetWindowSizeForVirtualSize(const wxSize& size) const
- {
- return size;
- }
-
// this is the virtual function to be overriden in any derived class which
// wants to change how SetSize() or Move() works - it is called by all
// versions of these functions in the base class
// same as DoSetSize() for the client size
virtual void DoSetClientSize(int width, int height) = 0;
+ virtual void DoSetSizeHints( int minW, int minH,
+ int maxW, int maxH,
+ int incW, int incH );
+
// move the window to the specified location and resize it: this is called
// from both DoSetSize() and DoSetClientSize() and would usually just
// reposition this window except for composite controls which will want to
// implements the window variants
virtual void DoSetWindowVariant( wxWindowVariant variant ) ;
+
+ // really freeze/thaw the window (should have port-specific implementation)
+ virtual void DoFreeze() { }
+ virtual void DoThaw() { }
+
+
// Must be called when mouse capture is lost to send
// wxMouseCaptureLostEvent to windows on capture stack.
static void NotifyCaptureLost();
int DoGetPopupMenuSelectionFromUser(wxMenu& menu, int x, int y);
#endif // wxUSE_MENUS
- // contains the last id generated by NewControlId
- static int ms_lastControlId;
-
// the stack of windows which have captured the mouse
static struct WXDLLIMPEXP_FWD_CORE wxWindowNext *ms_winCaptureNext;
+
// the window that currently has mouse capture
static wxWindow *ms_winCaptureCurrent;
+
// indicates if execution is inside CaptureMouse/ReleaseMouse
static bool ms_winCaptureChanging;
+
+ // number of Freeze() calls minus the number of Thaw() calls: we're frozen
+ // (i.e. not being updated) if it is positive
+ unsigned int m_freezeCount;
+
+
DECLARE_ABSTRACT_CLASS(wxWindowBase)
DECLARE_NO_COPY_CLASS(wxWindowBase)
DECLARE_EVENT_TABLE()
#if WXWIN_COMPATIBILITY_2_6
// deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
- wxDEPRECATED( int NewControlId() );
- inline int NewControlId() { return wxWindowBase::NewControlId(); }
+ wxDEPRECATED( wxWindowID NewControlId() );
+ inline wxWindowID NewControlId() { return wxWindowBase::NewControlId(); }
#endif // WXWIN_COMPATIBILITY_2_6
#if wxUSE_ACCESSIBILITY
projects / wxWidgets.git / blobdiff