X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/aede4ebb265b6537038e26131ebf07592ade460d..45bbbc54304272eb25b96e6c63b57107991bcd26:/include/wx/window.h diff --git a/include/wx/window.h b/include/wx/window.h index 679ceb8067..b17fcf0e7f 100644 --- a/include/wx/window.h +++ b/include/wx/window.h @@ -12,7 +12,7 @@ #ifndef _WX_WINDOW_H_BASE_ #define _WX_WINDOW_H_BASE_ -#if defined(__GNUG__) && !defined(__APPLE__) +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "windowbase.h" #endif @@ -119,17 +119,17 @@ public: // deleting the window // ------------------- - // ask the window to close itself, return TRUE if the event handler + // ask the window to close itself, return true if the event handler // honoured our request - bool Close( bool force = FALSE ); + bool Close( bool force = false ); // the following functions delete the C++ objects (the window itself // or its children) as well as the GUI windows and normally should // never be used directly - // delete window unconditionally (dangerous!), returns TRUE if ok + // delete window unconditionally (dangerous!), returns true if ok virtual bool Destroy(); - // delete all children of this window, returns TRUE if ok + // delete all children of this window, returns true if ok bool DestroyChildren(); // is the window being deleted? @@ -219,6 +219,8 @@ public: return wxPoint(w, h); } + void SetPosition( const wxPoint& pt ) { Move( pt ) ; } + void GetSize( int *w, int *h ) const { DoGetSize(w, h); } wxSize GetSize() const { @@ -356,14 +358,14 @@ public: // window state // ------------ - // returns TRUE if window was shown/hidden, FALSE if the nothing was + // returns true if window was shown/hidden, false if the nothing was // done (window was already shown/hidden) - virtual bool Show( bool show = TRUE ); - bool Hide() { return Show(FALSE); } + virtual bool Show( bool show = true ); + bool Hide() { return Show(false); } - // returns TRUE if window was enabled/disabled, FALSE if nothing done - virtual bool Enable( bool enable = TRUE ); - bool Disable() { return Enable(FALSE); } + // returns true if window was enabled/disabled, false if nothing done + virtual bool Enable( bool enable = true ); + bool Disable() { return Enable(false); } bool IsShown() const { return m_isShown; } bool IsEnabled() const { return m_isEnabled; } @@ -386,11 +388,16 @@ public: long GetExtraStyle() const { return m_exStyle; } // make the window modal (all other windows unresponsive) - virtual void MakeModal(bool modal = TRUE); + virtual void MakeModal(bool modal = true); virtual void SetThemeEnabled(bool enableTheme) { m_themeEnabled = enableTheme; } virtual bool GetThemeEnabled() const { return m_themeEnabled; } + // returns true if this window should inherit its parent colours on + // creation + virtual bool ShouldInheritColours() const { return false; } + + // focus and keyboard handling // --------------------------- @@ -432,6 +439,9 @@ public: const wxWindowList& GetChildren() const { return m_children; } wxWindowList& GetChildren() { return m_children; } + // needed just for extended runtime + const wxWindowList& GetWindowChildren() const { return GetChildren() ; } + // get the parent or the parent of the parent wxWindow *GetParent() const { return m_parent; } inline wxWindow *GetGrandParent() const; @@ -441,8 +451,8 @@ public: // it doesn't really change parent, use ReParent() instead void SetParent( wxWindowBase *parent ) { m_parent = (wxWindow *)parent; } - // change the real parent of this window, return TRUE if the parent - // was changed, FALSE otherwise (error or newParent == oldParent) + // change the real parent of this window, return true if the parent + // was changed, false otherwise (error or newParent == oldParent) virtual bool Reparent( wxWindowBase *newParent ); // implementation mostly @@ -477,11 +487,11 @@ public: // push/pop event handler: allows to chain a custom event handler to // alreasy existing ones void PushEventHandler( wxEvtHandler *handler ); - wxEvtHandler *PopEventHandler( bool deleteHandler = FALSE ); + wxEvtHandler *PopEventHandler( bool deleteHandler = false ); // find the given handler in the event handler chain and remove (but - // not delete) it from the event handler chain, return TRUE if it was - // found and FALSE otherwise (this also results in an assert failure so + // not delete) it from the event handler chain, return true if it was + // found and false otherwise (this also results in an assert failure so // this function should only be called when the handler is supposed to // be there) bool RemoveEventHandler(wxEvtHandler *handler); @@ -500,7 +510,7 @@ public: // dialog oriented functions // ------------------------- - // validate the correctness of input, return TRUE if ok + // validate the correctness of input, return true if ok virtual bool Validate(); // transfer data between internal and GUI representations @@ -516,8 +526,18 @@ public: { m_acceleratorTable = accel; } wxAcceleratorTable *GetAcceleratorTable() { return &m_acceleratorTable; } + #endif // wxUSE_ACCEL +#if wxUSE_HOTKEY + // hot keys (system wide accelerators) + // ----------------------------------- + + virtual bool RegisterHotKey(int hotkeyId, int modifiers, int keycode); + virtual bool UnregisterHotKey(int hotkeyId); +#endif // wxUSE_HOTKEY + + // dialog units translations // ------------------------- @@ -562,17 +582,17 @@ public: // mark the specified rectangle (or the whole window) as "dirty" so it // will be repainted - virtual void Refresh( bool eraseBackground = TRUE, + virtual void Refresh( bool eraseBackground = true, const wxRect *rect = (const wxRect *) NULL ) = 0; // a less awkward wrapper for Refresh - void RefreshRect(const wxRect& rect) { Refresh(TRUE, &rect); } + void RefreshRect(const wxRect& rect) { Refresh(true, &rect); } // repaint all invalid areas of the window immediately virtual void Update() { } - // clear the window entirely - virtual void Clear() = 0; + // clear the window background + virtual void ClearBackground(); // freeze the window: don't redraw it until it is thawed virtual void Freeze() { } @@ -605,20 +625,20 @@ public: // -------------------------- // set/retrieve the window colours (system defaults are used by - // default): Set functions return TRUE if colour was changed + // default): Set functions return true if colour was changed virtual bool SetBackgroundColour( const wxColour &colour ); virtual bool SetForegroundColour( const wxColour &colour ); wxColour GetBackgroundColour() const { return m_backgroundColour; } wxColour GetForegroundColour() const { return m_foregroundColour; } - // set/retrieve the cursor for this window (SetCursor() returns TRUE + // set/retrieve the cursor for this window (SetCursor() returns true // if the cursor was really changed) virtual bool SetCursor( const wxCursor &cursor ); const wxCursor& GetCursor() const { return m_cursor; } wxCursor& GetCursor() { return m_cursor; } - // set/retrieve the font for the window (SetFont() returns TRUE if the + // set/retrieve the font for the window (SetFont() returns true if the // font really changed) virtual bool SetFont( const wxFont &font ) = 0; const wxFont& GetFont() const { return m_font; } @@ -688,7 +708,11 @@ public: // get border for the flags of this window wxBorder GetBorder() const { return GetBorder(GetWindowStyleFlag()); } - void UpdateWindowUI(); + // send wxUpdateUIEvents to this window, and children if recurse is true + virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE); + + // do the window-specific processing after processing the update event + virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ; #if wxUSE_MENUS bool PopupMenu( wxMenu *menu, const wxPoint& pos ) @@ -712,8 +736,8 @@ public: int pos, int thumbvisible, int range, - bool refresh = TRUE ) = 0; - virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE ) = 0; + bool refresh = true ) = 0; + virtual void SetScrollPos( int orient, int pos, bool refresh = true ) = 0; virtual int GetScrollPos( int orient ) const = 0; virtual int GetScrollThumb( int orient ) const = 0; virtual int GetScrollRange( int orient ) const = 0; @@ -724,9 +748,9 @@ public: // scrolls window by line/page: note that not all controls support this // - // return TRUE if the position changed, FALSE otherwise - virtual bool ScrollLines(int WXUNUSED(lines)) { return FALSE; } - virtual bool ScrollPages(int WXUNUSED(pages)) { return FALSE; } + // return true if the position changed, false otherwise + virtual bool ScrollLines(int WXUNUSED(lines)) { return false; } + virtual bool ScrollPages(int WXUNUSED(pages)) { return false; } // convenient wrappers for ScrollLines/Pages bool LineUp() { return ScrollLines(-1); } @@ -759,6 +783,7 @@ public: void SetToolTip( wxToolTip *tip ) { DoSetToolTip(tip); } // get the associated tooltip or NULL if none wxToolTip* GetToolTip() const { return m_tooltip; } + wxString GetToolTipText() const ; #endif // wxUSE_TOOLTIPS // drag and drop @@ -787,7 +812,7 @@ public: void ResetConstraints(); // these methods may be overriden for special layout algorithms - virtual void SetConstraintSizes(bool recurse = TRUE); + virtual void SetConstraintSizes(bool recurse = true); virtual bool LayoutPhase1(int *noChanges); virtual bool LayoutPhase2(int *noChanges); virtual bool DoPhase(int phase); @@ -811,13 +836,23 @@ public: virtual bool Layout(); // sizers - void SetSizer(wxSizer *sizer, bool deleteOld = TRUE ); - void SetSizerAndFit( wxSizer *sizer, bool deleteOld = TRUE ); + void SetSizer(wxSizer *sizer, bool deleteOld = true ); + void SetSizerAndFit( wxSizer *sizer, bool deleteOld = true ); wxSizer *GetSizer() const { return m_windowSizer; } // Track if this window is a member of a sizer - void SetContainingSizer(wxSizer* sizer) { m_containingSizer = sizer; } + void SetContainingSizer(wxSizer* sizer) + { + // adding a window to a sizer twice is going to result in fatal and + // hard to debug problems later because when deleting the second + // associated wxSizerItem we're going to dereference a dangling + // pointer; so try to detect this as early as possible + wxASSERT_MSG( !sizer || m_containingSizer != sizer, + _T("Adding a window to the same sizer twice?") ); + + m_containingSizer = sizer; + } wxSizer *GetContainingSizer() const { return m_containingSizer; } // accessibility @@ -836,17 +871,6 @@ public: wxAccessible* GetOrCreateAccessible() ; #endif - // backward compatibility - // ---------------------- -#if WXWIN_COMPATIBILITY - bool Enabled() const { return IsEnabled(); } - - void SetButtonFont(const wxFont& font) { SetFont(font); } - void SetLabelFont(const wxFont& font) { SetFont(font); } - wxFont& GetLabelFont() { return GetFont(); }; - wxFont& GetButtonFont() { return GetFont(); }; -#endif // WXWIN_COMPATIBILITY - // implementation // -------------- @@ -858,7 +882,14 @@ public: void OnHelp(wxHelpEvent& event); #endif // wxUSE_HELP - // get the haqndle of the window for the underlying window system: this + // virtual function for implementing internal idle + // behaviour + virtual void OnInternalIdle() {} + + // call internal idle recursively +// void ProcessInternalIdle() ; + + // get the handle of the window for the underlying window system: this // is only used for wxWin itself or for user code which wants to call // platform-specific APIs virtual WXWidget GetHandle() const = 0; @@ -881,9 +912,7 @@ public: protected: // event handling specific to wxWindow -#if wxUSE_VALIDATORS virtual bool TryValidator(wxEvent& event); -#endif // wxUSE_VALIDATORS virtual bool TryParent(wxEvent& event); @@ -1119,7 +1148,6 @@ private: #define wxWindowNative wxWindowMSW #else // !wxUniv #define wxWindowMSW wxWindow - #define sm_classwxWindowMSW sm_classwxWindow #endif // wxUniv/!wxUniv #include "wx/msw/window.h" #elif defined(__WXMOTIF__) @@ -1129,7 +1157,6 @@ private: #define wxWindowNative wxWindowGTK #else // !wxUniv #define wxWindowGTK wxWindow - #define sm_classwxWindowGTK sm_classwxWindow #endif // wxUniv #include "wx/gtk/window.h" #elif defined(__WXX11__) @@ -1137,7 +1164,6 @@ private: #define wxWindowNative wxWindowX11 #else // !wxUniv #define wxWindowX11 wxWindow - #define sm_classwxWindowX11 sm_classwxWindow #endif // wxUniv #include "wx/x11/window.h" #elif defined(__WXMGL__) @@ -1145,7 +1171,6 @@ private: #define wxWindowNative wxWindowMGL #else // !wxUniv #define wxWindowMGL wxWindow - #define sm_classwxWindowMGL sm_classwxWindow #endif // wxUniv #include "wx/mgl/window.h" #elif defined(__WXMAC__) @@ -1153,7 +1178,6 @@ private: #define wxWindowNative wxWindowMac #else // !wxUniv #define wxWindowMac wxWindow - #define sm_classwxWindowMac sm_classwxWindow #endif // wxUniv #include "wx/mac/window.h" #elif defined(__WXCOCOA__) @@ -1161,7 +1185,6 @@ private: #define wxWindowNative wxWindowCocoa #else // !wxUniv #define wxWindowCocoa wxWindow - #define sm_classwxWindowCocoa sm_classwxWindow #endif // wxUniv #include "wx/cocoa/window.h" #elif defined(__WXPM__) @@ -1169,7 +1192,6 @@ private: #define wxWindowNative wxWindowOS2 #else // !wxUniv #define wxWindowOS2 wxWindow - #define sm_classwxWindowOS2 sm_classwxWindow #endif // wxUniv/!wxUniv #include "wx/os2/window.h" #endif @@ -1299,7 +1321,7 @@ public: // Gets a variant representing the selected children // of this object. // Acceptable values: - // - a null variant (IsNull() returns TRUE) + // - a null variant (IsNull() returns true) // - a list variant (GetType() == wxT("list") // - an integer representing the selected child element, // or 0 if this object is selected (GetType() == wxT("long")