X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cab1a6053dce9f0a2dcd87d8e2d12d8633f4785f..717a70722efbd1931301d44344df83ec23118b7b:/include/wx/window.h diff --git a/include/wx/window.h b/include/wx/window.h index e43fff75ef..da86c0b470 100644 --- a/include/wx/window.h +++ b/include/wx/window.h @@ -5,17 +5,13 @@ // Modified by: Ron Lee // Created: 01/02/97 // RCS-ID: $Id$ -// Copyright: (c) wxWidgets team +// Copyright: (c) Vadim Zeitlin // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// #ifndef _WX_WINDOW_H_BASE_ #define _WX_WINDOW_H_BASE_ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma interface "windowbase.h" -#endif - // ---------------------------------------------------------------------------- // headers which we must include here // ---------------------------------------------------------------------------- @@ -48,9 +44,9 @@ // compiled in - it should only be used when building real wxFoo #ifdef __WXUNIVERSAL__ #define wxUSE_MENUS_NATIVE 0 -#else // __WXMSW__ +#else // !__WXUNIVERSAL__ #define wxUSE_MENUS_NATIVE wxUSE_MENUS -#endif // __WXUNIVERSAL__/__WXMSW__ +#endif // __WXUNIVERSAL__/!__WXUNIVERSAL__ // ---------------------------------------------------------------------------- // forward declarations @@ -116,7 +112,7 @@ WX_DECLARE_LIST_3(wxWindow, wxWindowBase, wxWindowList, wxWindowListNode, class // global variables // ---------------------------------------------------------------------------- -WXDLLEXPORT_DATA(extern wxWindowList) wxTopLevelWindows; +extern WXDLLEXPORT_DATA(wxWindowList) wxTopLevelWindows; // ---------------------------------------------------------------------------- // wxWindowBase is the base class for all GUI controls/widgets, this is the public @@ -172,19 +168,11 @@ public: // window attributes // ----------------- - // NB: in future versions of wxWidgets Set/GetTitle() will only work - // with the top level windows (such as dialogs and frames) and - // Set/GetLabel() only with the other ones (i.e. all controls). - - // the title (or label, see below) of the window: the text which the - // window shows - virtual void SetTitle( const wxString& WXUNUSED(title) ) {} - virtual wxString GetTitle() const { return wxEmptyString; } - // label is just the same as the title (but for, e.g., buttons it - // makes more sense to speak about labels) - virtual void SetLabel(const wxString& label) { SetTitle(label); } - virtual wxString GetLabel() const { return GetTitle(); } + // makes more sense to speak about labels), title access + // is available from wxTLW classes only (frames, dialogs) + virtual void SetLabel(const wxString& label) = 0; + virtual wxString GetLabel() const = 0; // the window name is used for ressource setting in X, it is not the // same as the window title/label @@ -317,7 +305,7 @@ public: // reset the cached best size value so it will be recalculated the // next time it is needed. - void InvalidateBestSize() { m_bestSizeCache = wxDefaultSize; } + void InvalidateBestSize(); void CacheBestSize(const wxSize& size) const { wxConstCast(this, wxWindowBase)->m_bestSizeCache = size; } @@ -364,16 +352,24 @@ public: // set min/max size of the window virtual void SetSizeHints( int minW, int minH, int maxW = wxDefaultCoord, int maxH = wxDefaultCoord, - int incW = wxDefaultCoord, int incH = wxDefaultCoord ); + int incW = wxDefaultCoord, int incH = wxDefaultCoord ) + { + DoSetSizeHints(minW, minH, maxW, maxH, incW, incH); + } + void SetSizeHints( const wxSize& minSize, const wxSize& maxSize=wxDefaultSize, const wxSize& incSize=wxDefaultSize) { - SetSizeHints(minSize.x, minSize.y, - maxSize.x, maxSize.y, - incSize.x, incSize.y); + DoSetSizeHints(minSize.x, minSize.y, + maxSize.x, maxSize.y, + incSize.x, incSize.y); } + virtual void DoSetSizeHints(int minW, int minH, + int maxW = wxDefaultCoord, int maxH = wxDefaultCoord, + int incW = wxDefaultCoord, int incH = wxDefaultCoord ); + virtual void SetVirtualSizeHints( int minW, int minH, int maxW = wxDefaultCoord, int maxH = wxDefaultCoord ); void SetVirtualSizeHints( const wxSize& minSize, @@ -416,10 +412,10 @@ public: // Override these methods for windows that have a virtual size // independent of their client size. eg. the virtual area of a - // wxScrolledWindow. Default is to alias VirtualSize to ClientSize. + // wxScrolledWindow. virtual void DoSetVirtualSize( int x, int y ); - virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; } + virtual wxSize DoGetVirtualSize() const; // Return the largest of ClientSize and BestSize (as determined // by a sizer, interior children, or other means) @@ -444,8 +440,8 @@ public: virtual bool Enable( bool enable = true ); bool Disable() { return Enable(false); } - bool IsShown() const { return m_isShown; } - bool IsEnabled() const { return m_isEnabled; } + virtual bool IsShown() const { return m_isShown; } + virtual bool IsEnabled() const { return m_isEnabled; } // get/set window style (setting style won't update the window and so // is only useful for internal usage) @@ -474,14 +470,6 @@ public: virtual void SetThemeEnabled(bool enableTheme) { m_themeEnabled = enableTheme; } virtual bool GetThemeEnabled() const { return m_themeEnabled; } - // Returns true if this class should have the background colour - // changed to match the parent window's theme. For example when a - // page is added to a notebook it and its children may need to have - // the colours adjusted depending on the current theme settings, but - // not all windows/controls can do this without looking wrong. - virtual void ApplyParentThemeBackground(const wxColour& WXUNUSED(bg)) - { /* do nothing */ } - // focus and keyboard handling // --------------------------- @@ -493,7 +481,9 @@ public: virtual void SetFocusFromKbd() { SetFocus(); } // return the window which currently has the focus or NULL - static wxWindow *FindFocus() /* = 0: implement in derived classes */; + static wxWindow *FindFocus(); + + static wxWindow *DoFindFocus() /* = 0: implement in derived classes */; // can this window have focus? virtual bool AcceptsFocus() const { return IsShown() && IsEnabled(); } @@ -560,8 +550,8 @@ public: // find window among the descendants of this one either by id or by // name (return NULL if not found) - wxWindow *FindWindow( long winid ); - wxWindow *FindWindow( const wxString& name ); + wxWindow *FindWindow(long winid) const; + wxWindow *FindWindow(const wxString& name) const; // Find a window among any window (all return NULL if not found) static wxWindow *FindWindowById( long winid, const wxWindow *parent = NULL ); @@ -682,7 +672,10 @@ public: 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, bool eraseBackground = true) + { + Refresh(eraseBackground, &rect); + } // repaint all invalid areas of the window immediately virtual void Update() { } @@ -746,6 +739,14 @@ public: m_inheritBgCol = false; } wxColour GetBackgroundColour() const; + bool InheritsBackgroundColour() const + { + return m_inheritBgCol; + } + bool UseBgCol() const + { + return m_hasBgCol; + } virtual bool SetForegroundColour(const wxColour& colour); void SetOwnForegroundColour(const wxColour& colour) @@ -760,6 +761,11 @@ public: virtual bool SetBackgroundStyle(wxBackgroundStyle style) { m_backgroundStyle = style; return true; } virtual wxBackgroundStyle GetBackgroundStyle() const { return m_backgroundStyle; } + // returns true if the control has "transparent" areas such as a + // wxStaticText and wxCheckBox and the background should be adapted + // from a parent window + virtual bool HasTransparentBackground() { return false; } + // set/retrieve the font for the window (SetFont() returns true if the // font really changed) virtual bool SetFont(const wxFont& font) = 0; @@ -902,6 +908,10 @@ public: void SetHelpTextForId(const wxString& text); // get the help string associated with this window (may be empty) wxString GetHelpText() const; +#else + // silently ignore SetHelpText() calls + void SetHelpText(const wxString& WXUNUSED(text)) { } + void SetHelpTextForId(const wxString& WXUNUSED(text)) { } #endif // wxUSE_HELP // tooltips @@ -946,7 +956,7 @@ public: void DeleteRelatedConstraints(); void ResetConstraints(); - // these methods may be overriden for special layout algorithms + // these methods may be overridden for special layout algorithms virtual void SetConstraintSizes(bool recurse = true); virtual bool LayoutPhase1(int *noChanges); virtual bool LayoutPhase2(int *noChanges); @@ -1051,6 +1061,17 @@ public: // behaviour in the most common case virtual bool ShouldInheritColours() const { return false; } + // Reserved for future use + virtual void ReservedWindowFunc1() {} + virtual void ReservedWindowFunc2() {} + virtual void ReservedWindowFunc3() {} + virtual void ReservedWindowFunc4() {} + virtual void ReservedWindowFunc5() {} + virtual void ReservedWindowFunc6() {} + virtual void ReservedWindowFunc7() {} + virtual void ReservedWindowFunc8() {} + virtual void ReservedWindowFunc9() {} + protected: // event handling specific to wxWindow virtual bool TryValidator(wxEvent& event); @@ -1072,6 +1093,12 @@ protected: // Send the wxWindowDestroyEvent void SendDestroyEvent(); + // returns the main window of composite control; this is the window + // that FindFocus returns if the focus is in one of composite control's + // windows + virtual wxWindow *GetMainWindowOfCompositeControl() + { return (wxWindow*)this; } + // the window id - a number which uniquely identifies a window among // its siblings unless it is wxID_ANY wxWindowID m_windowId; @@ -1244,6 +1271,14 @@ protected: // 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 @@ -1277,6 +1312,9 @@ protected: // implements the window variants virtual void DoSetWindowVariant( wxWindowVariant variant ) ; + // Reserved for future use + void* m_windowReserved; + private: // contains the last id generated by NewControlId static int ms_lastControlId; @@ -1294,7 +1332,14 @@ private: // ---------------------------------------------------------------------------- // include the declaration of the platform-specific class -#if defined(__WXMSW__) +#if defined(__WXPALMOS__) + #ifdef __WXUNIVERSAL__ + #define wxWindowNative wxWindowPalm + #else // !wxUniv + #define wxWindowPalm wxWindow + #endif // wxUniv/!wxUniv + #include "wx/palmos/window.h" +#elif defined(__WXMSW__) #ifdef __WXUNIVERSAL__ #define wxWindowNative wxWindowMSW #else // !wxUniv @@ -1373,13 +1418,13 @@ inline wxWindow *wxWindowBase::GetGrandParent() const // Find the wxWindow at the current mouse position, also returning the mouse // position. -WXDLLEXPORT extern wxWindow* wxFindWindowAtPointer(wxPoint& pt); +extern WXDLLEXPORT wxWindow* wxFindWindowAtPointer(wxPoint& pt); // Get the current mouse position. -WXDLLEXPORT extern wxPoint wxGetMousePosition(); +extern WXDLLEXPORT wxPoint wxGetMousePosition(); // get the currently active window of this application or NULL -WXDLLEXPORT extern wxWindow *wxGetActiveWindow(); +extern WXDLLEXPORT wxWindow *wxGetActiveWindow(); // get the (first) top level parent window WXDLLEXPORT wxWindow* wxGetTopLevelParent(wxWindow *win); @@ -1396,7 +1441,7 @@ class WXDLLEXPORT wxWindowAccessible: public wxAccessible { public: wxWindowAccessible(wxWindow* win): wxAccessible(win) { if (win) win->SetAccessible(this); } - virtual ~wxWindowAccessible() {}; + virtual ~wxWindowAccessible() {} // Overridables @@ -1483,6 +1528,4 @@ public: #endif // wxUSE_ACCESSIBILITY -#endif - // _WX_WINDOW_H_BASE_ - +#endif // _WX_WINDOW_H_BASE_