// ----------------------------------------------------------------------------
// struct containing all the visual attributes of a control
-struct WXDLLEXPORT wxVisualAttributes
+struct WXDLLIMPEXP_CORE wxVisualAttributes
{
// the font used for control label/text inside it
wxFont font;
// valid values for Show/HideWithEffect()
enum wxShowEffect
{
- wxSHOW_EFFECT_ROLL,
- wxSHOW_EFFECT_SLIDE,
+ wxSHOW_EFFECT_ROLL_TO_LEFT,
+ wxSHOW_EFFECT_ROLL_TO_RIGHT,
+ wxSHOW_EFFECT_ROLL_TO_TOP,
+ wxSHOW_EFFECT_ROLL_TO_BOTTOM,
+ wxSHOW_EFFECT_SLIDE_TO_LEFT,
+ wxSHOW_EFFECT_SLIDE_TO_RIGHT,
+ wxSHOW_EFFECT_SLIDE_TO_TOP,
+ wxSHOW_EFFECT_SLIDE_TO_BOTTOM,
wxSHOW_EFFECT_BLEND,
wxSHOW_EFFECT_EXPAND,
wxSHOW_EFFECT_MAX
};
+// flags for SendSizeEvent()
+enum
+{
+ wxSEND_EVENT_POST = 1
+};
+
// ----------------------------------------------------------------------------
// (pseudo)template list classes
// ----------------------------------------------------------------------------
-WX_DECLARE_LIST_3(wxWindow, wxWindowBase, wxWindowList, wxWindowListNode, class WXDLLEXPORT);
+WX_DECLARE_LIST_3(wxWindow, wxWindowBase, wxWindowList, wxWindowListNode, class WXDLLIMPEXP_CORE);
// ----------------------------------------------------------------------------
// global variables
// ----------------------------------------------------------------------------
-extern WXDLLEXPORT_DATA(wxWindowList) wxTopLevelWindows;
+extern WXDLLIMPEXP_DATA_CORE(wxWindowList) wxTopLevelWindows;
extern WXDLLIMPEXP_DATA_CORE(wxList) wxPendingDelete;
// ----------------------------------------------------------------------------
// temporarily switches event handlers).
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxWindowBase : public wxEvtHandler
+class WXDLLIMPEXP_CORE wxWindowBase : public wxEvtHandler
{
public:
// creating the window
bool DestroyChildren();
// is the window being deleted?
- bool IsBeingDeleted() const { return m_isBeingDeleted; }
+ bool IsBeingDeleted() const;
// window attributes
// -----------------
void SetId( wxWindowID winid ) { m_windowId = winid; }
wxWindowID GetId() const { return m_windowId; }
- // returns true if this id value belong to the range reserved for the
- // auto-generated (by NewControlId()) ids (they're always negative)
- static bool IsAutoGeneratedId(wxWindowID id);
-
// generate a unique id (or count of them consecutively), returns a
- // valid id in IsAutoGeneratedId() range or wxID_NONE if failed
- static wxWindowID NewControlId(int count = 1);
+ // 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);
+ }
- // mark an id previously returned by NewControlId() as being unused any
- // more so that it can be reused again for another control later
- static void ReleaseControlId(wxWindowID id);
+ // 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
return wxRect(GetClientAreaOrigin(), GetClientSize());
}
+ // client<->window size conversion
+ virtual wxSize ClientToWindowSize(const wxSize& size) const;
+ virtual wxSize WindowToClientSize(const wxSize& size) const;
+
// get the size best suited for the window (in fact, minimal
// acceptable size using which it will still look "nice" in
// most situations)
- wxSize GetBestSize() const
- {
- if (m_bestSizeCache.IsFullySpecified())
- return m_bestSizeCache;
- return DoGetBestSize();
- }
+ wxSize GetBestSize() const;
+
void GetBestSize(int *w, int *h) const
{
wxSize s = GetBestSize();
// This function will merge the window's best size into the window's
// minimum size, giving priority to the min size components, and
// returns the results.
- wxSize GetEffectiveMinSize() const;
+ virtual wxSize GetEffectiveMinSize() const;
wxDEPRECATED( wxSize GetBestFittingSize() const ); // replaced by GetEffectiveMinSize
wxDEPRECATED( wxSize GetAdjustedMinSize() const ); // replaced by GetEffectiveMinSize
// Call these to override what GetBestSize() returns. This
// method is only virtual because it is overriden in wxTLW
// as a different API for SetSizeHints().
- virtual void SetMinSize(const wxSize& minSize) { m_minWidth = minSize.x; m_minHeight = minSize.y; }
- virtual void SetMaxSize(const wxSize& maxSize) { m_maxWidth = maxSize.x; m_maxHeight = maxSize.y; }
+ virtual void SetMinSize(const wxSize& minSize);
+ virtual void SetMaxSize(const wxSize& maxSize);
+
+ // Like Set*Size, but for client, not window, size
+ virtual void SetMinClientSize(const wxSize& size)
+ { SetMinSize(ClientToWindowSize(size)); }
+ virtual void SetMaxClientSize(const wxSize& size)
+ { SetMaxSize(ClientToWindowSize(size)); }
// Override these methods to impose restrictions on min/max size.
// The easier way is to call SetMinSize() and SetMaxSize() which
virtual wxSize GetMinSize() const { return wxSize(m_minWidth, m_minHeight); }
virtual wxSize GetMaxSize() const { return wxSize(m_maxWidth, m_maxHeight); }
+ // Like Get*Size, but for client, not window, size
+ virtual wxSize GetMinClientSize() const
+ { return WindowToClientSize(GetMinSize()); }
+ virtual wxSize GetMaxClientSize() const
+ { return WindowToClientSize(GetMaxSize()); }
+
// Get the min and max values one by one
int GetMinWidth() const { return GetMinSize().x; }
int GetMinHeight() const { return GetMinSize().y; }
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
+ // 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
+ // 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; }
+ virtual bool
+ InformFirstDirection(int WXUNUSED(direction),
+ int WXUNUSED(size),
+ int WXUNUSED(availableOtherDir))
+ {
+ return false;
+ }
+
+ // sends a size event to the window using its current size -- this has an
+ // effect of refreshing the window layout
+ //
+ // by default the event is sent, i.e. processed immediately, but if flags
+ // value includes wxSEND_EVENT_POST then it's posted, i.e. only schedule
+ // for later processing
+ virtual void SendSizeEvent(int flags = 0);
+
+ // this is a safe wrapper for GetParent()->SendSizeEvent(): it checks that
+ // we have a parent window and it's not in process of being deleted
+ //
+ // this is used by controls such as tool/status bars changes to which must
+ // also result in parent re-layout
+ void SendSizeEventToParent(int flags = 0);
+
+ // this is a more readable synonym for SendSizeEvent(wxSEND_EVENT_POST)
+ void PostSizeEvent() { SendSizeEvent(wxSEND_EVENT_POST); }
+
+ // this is the same as SendSizeEventToParent() but using PostSizeEvent()
+ void PostSizeEventToParent() { SendSizeEventToParent(wxSEND_EVENT_POST); }
+
// window state
// ------------
//
// 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)
+ virtual bool ShowWithEffect(wxShowEffect WXUNUSED(effect),
+ unsigned WXUNUSED(timeout) = 0)
{
- wxUnusedVar(effect);
- wxUnusedVar(timeout);
- wxUnusedVar(dir);
-
return Show();
}
- virtual bool HideWithEffect(wxShowEffect effect,
- unsigned timeout = 0,
- wxDirection dir = wxBOTTOM)
+ virtual bool HideWithEffect(wxShowEffect WXUNUSED(effect),
+ unsigned WXUNUSED(timeout) = 0)
{
- wxUnusedVar(effect);
- wxUnusedVar(timeout);
- wxUnusedVar(dir);
-
return Hide();
}
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
bool Navigate(int flags = wxNavigationKeyEvent::IsForward)
{ return m_parent && ((wxWindowBase *)m_parent)->DoNavigateIn(flags); }
+ // this function will generate the appropriate call to Navigate() if the
+ // key event is one normally used for keyboard navigation and return true
+ // in this case
+ bool HandleAsNavigationKey(const wxKeyEvent& event);
+
// move this window just before/after the specified one in tab order
// (the other window must be our sibling!)
void MoveBeforeInTabOrder(wxWindow *win)
// replace the event handler (allows to completely subclass the
// window)
- void SetEventHandler( wxEvtHandler *handler ) { m_eventHandler = handler; }
+ void SetEventHandler( wxEvtHandler *handler );
// push/pop event handler: allows to chain a custom event handler to
// alreasy existing ones
// 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.
+ // Process an event by calling GetEventHandler()->ProcessEvent(): this
+ // is a straightforward replacement for ProcessEvent() itself which
+ // shouldn't be used directly with windows as it doesn't take into
+ // account any event handlers associated with the window
+ bool ProcessWindowEvent(wxEvent& event)
+ { return GetEventHandler()->ProcessEvent(event); }
+
+ // 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;
+ // disable wxEvtHandler double-linked list mechanism:
+ virtual void SetNextHandler(wxEvtHandler *handler);
+ virtual void SetPreviousHandler(wxEvtHandler *handler);
+
+protected:
+
+ // NOTE: we change the access specifier of the following wxEvtHandler functions
+ // so that the user won't be able to call them directly.
+ // Calling wxWindow::ProcessEvent in fact only works when there are NO
+ // event handlers pushed on the window.
+ // To ensure correct operation, instead of wxWindow::ProcessEvent
+ // you must always call wxWindow::GetEventHandler()->ProcessEvent()
+ // or HandleWindowEvent().
+ // The same holds for all other wxEvtHandler functions.
+
+ using wxEvtHandler::ProcessEvent;
+#if wxUSE_THREADS
+ using wxEvtHandler::ProcessThreadEvent;
+#endif
+ using wxEvtHandler::SafelyProcessEvent;
+ using wxEvtHandler::ProcessPendingEvents;
+ using wxEvtHandler::AddPendingEvent;
+ using wxEvtHandler::QueueEvent;
+
+public:
+
// validators
// ----------
virtual void ClearBackground();
// freeze the window: don't redraw it until it is thawed
- virtual void Freeze() { }
+ void Freeze();
// thaw the window: redraw it after it had been frozen
- virtual void Thaw() { }
+ void Thaw();
// 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) ) { }
// font
virtual void GetTextExtent(const wxString& string,
int *x, int *y,
- int *descent = (int *) NULL,
- int *externalLeading = (int *) NULL,
+ int *descent = NULL,
+ int *externalLeading = NULL,
const wxFont *theFont = (const wxFont *) NULL)
const = 0;
// 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
// scroll window to the specified position
virtual void ScrollWindow( int dx, int dy,
- const wxRect* rect = (wxRect *) NULL ) = 0;
+ const wxRect* rect = NULL ) = 0;
// scrolls window by line/page: note that not all controls support this
//
#if wxUSE_HELP
// associate this help text with this window
void SetHelpText(const wxString& text);
- // associate this help text with all windows with the same id as this
- // one
- void SetHelpTextForId(const wxString& text);
+
+#if WXWIN_COMPATIBILITY_2_8
+ // Associate this help text with all windows with the same id as this one.
+ // Don't use this, do wxHelpProvider::Get()->AddHelp(id, text);
+ wxDEPRECATED( void SetHelpTextForId(const wxString& text) );
+#endif // WXWIN_COMPATIBILITY_2_8
+
// get the help string associated with the given position in this window
//
// notice that pt may be invalid if event origin is keyboard or unknown
#if wxUSE_TOOLTIPS
// the easiest way to set a tooltip for a window is to use this method
void SetToolTip( const wxString &tip );
- // attach a tooltip to the window
+ // attach a tooltip to the window, pointer can be NULL to remove
+ // existing tooltip
void SetToolTip( wxToolTip *tip ) { DoSetToolTip(tip); }
+ // more readable synonym for SetToolTip(NULL)
+ void UnsetToolTip() { SetToolTip(NULL); }
// get the associated tooltip or NULL if none
wxToolTip* GetToolTip() const { return m_tooltip; }
- wxString GetToolTipText() const ;
-#else
+ wxString GetToolTipText() const;
+#else // !wxUSE_TOOLTIPS
// make it much easier to compile apps in an environment
// that doesn't support tooltips, such as PocketPC
- inline void SetToolTip( const wxString & WXUNUSED(tip) ) {}
-#endif // wxUSE_TOOLTIPS
+ void SetToolTip(const wxString & WXUNUSED(tip)) { }
+ void UnsetToolTip() { }
+#endif // wxUSE_TOOLTIPS/!wxUSE_TOOLTIPS
// drag and drop
// -------------
// NULL; it's owned by the window and will be deleted by it)
virtual void SetDropTarget( wxDropTarget *dropTarget ) = 0;
virtual wxDropTarget *GetDropTarget() const { return m_dropTarget; }
+
+ // Accept files for dragging
+ virtual void DragAcceptFiles(bool accept)
+#ifdef __WXMSW__
+ // it does have common implementation but not for MSW which has its own
+ // native version of it
+ = 0
+#endif // __WXMSW__
+ ;
+
#endif // wxUSE_DRAG_AND_DROP
// constraints and sizers
protected:
// event handling specific to wxWindow
- virtual bool TryValidator(wxEvent& event);
- virtual bool TryParent(wxEvent& event);
+ virtual bool TryBefore(wxEvent& event);
+ virtual bool TryAfter(wxEvent& event);
enum WindowOrder
{
void SatisfyConstraints();
#endif // wxUSE_CONSTRAINTS
- // Send the wxWindowDestroyEvent
+ // Send the wxWindowDestroyEvent if not done yet and sets m_isBeingDeleted
+ // to true
void SendDestroyEvent();
// returns the main window of composite control; this is the window
// 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
// Layout() window automatically when its size changes?
bool m_autoLayout:1;
- // true if we had automatically allocated the id value for this window
- // (i.e. wxID_ANY had been passed to the ctor)
- bool m_freeId:1;
-
// window state
bool m_isShown:1;
bool m_isEnabled:1;
// 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
// 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();
void NotifyWindowOnEnableChange(bool enabled);
#if wxUSE_MENUS
- // temporary event handler used by GetPopupMenuSelectionFromUser()
+ // temporary event handlers used by GetPopupMenuSelectionFromUser()
void InternalOnPopupMenu(wxCommandEvent& event);
+ void InternalOnPopupMenuUpdate(wxUpdateUIEvent& event);
// implementation of the public GetPopupMenuSelectionFromUser() method
int DoGetPopupMenuSelectionFromUser(wxMenu& menu, int x, int y);
// 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)
+ wxDECLARE_NO_COPY_CLASS(wxWindowBase);
DECLARE_EVENT_TABLE()
};
#else // !wxUniv
#define wxWindowMac wxWindow
#endif // wxUniv
- #include "wx/mac/window.h"
+ #include "wx/osx/window.h"
#elif defined(__WXCOCOA__)
#ifdef __WXUNIVERSAL__
#define wxWindowNative wxWindowCocoa
inline wxWindow *wxWindowBase::GetGrandParent() const
{
- return m_parent ? m_parent->GetParent() : (wxWindow *)NULL;
+ return m_parent ? m_parent->GetParent() : NULL;
}
// ----------------------------------------------------------------------------
// Find the wxWindow at the current mouse position, also returning the mouse
// position.
-extern WXDLLEXPORT wxWindow* wxFindWindowAtPointer(wxPoint& pt);
+extern WXDLLIMPEXP_CORE wxWindow* wxFindWindowAtPointer(wxPoint& pt);
// Get the current mouse position.
-extern WXDLLEXPORT wxPoint wxGetMousePosition();
+extern WXDLLIMPEXP_CORE wxPoint wxGetMousePosition();
// get the currently active window of this application or NULL
-extern WXDLLEXPORT wxWindow *wxGetActiveWindow();
+extern WXDLLIMPEXP_CORE wxWindow *wxGetActiveWindow();
// get the (first) top level parent window
-WXDLLEXPORT wxWindow* wxGetTopLevelParent(wxWindow *win);
+WXDLLIMPEXP_CORE wxWindow* wxGetTopLevelParent(wxWindow *win);
#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
// accessible object for windows
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxWindowAccessible: public wxAccessible
+class WXDLLIMPEXP_CORE wxWindowAccessible: public wxAccessible
{
public:
wxWindowAccessible(wxWindow* win): wxAccessible(win) { if (win) win->SetAccessible(this); }
projects / wxWidgets.git / blobdiff