X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/540b6b097f0a8056189b3f9ab5aab5c99834b9c7..19b44116d5c04181f9a20f92546cff26405ed115:/include/wx/window.h diff --git a/include/wx/window.h b/include/wx/window.h index 877456d967..97b35334c0 100644 --- a/include/wx/window.h +++ b/include/wx/window.h @@ -5,14 +5,14 @@ // Modified by: Ron Lee // Created: 01/02/97 // RCS-ID: $Id$ -// Copyright: (c) wxWindows team +// Copyright: (c) wxWidgets team // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// #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 @@ -73,6 +73,35 @@ class WXDLLEXPORT wxWindow; class WXDLLEXPORT wxAccessible; #endif +// ---------------------------------------------------------------------------- +// helper stuff used by wxWindow +// ---------------------------------------------------------------------------- + +// struct containing all the visual attributes of a control +struct WXDLLEXPORT wxVisualAttributes +{ + // the font used for control label/text inside it + wxFont font; + + // the foreground colour + wxColour colFg; + + // the background colour, may be wxNullColour if the controls background + // colour is not solid + wxColour colBg; +}; + +// different window variants, on platforms like eg mac uses different +// rendering sizes +enum wxWindowVariant +{ + wxWINDOW_VARIANT_NORMAL, // Normal size + wxWINDOW_VARIANT_SMALL, // Smaller size (about 25 % smaller than normal) + wxWINDOW_VARIANT_MINI, // Mini size (about 33 % smaller than normal) + wxWINDOW_VARIANT_LARGE, // Large size (about 25 % larger than normal) + wxWINDOW_VARIANT_MAX +}; + // ---------------------------------------------------------------------------- // (pseudo)template list classes // ---------------------------------------------------------------------------- @@ -102,8 +131,9 @@ public: // creating the window // ------------------- - // default ctor - wxWindowBase() { InitBase(); } + // default ctor, initializes everything which can be initialized before + // Create() + wxWindowBase() ; // pseudo ctor (can't be virtual, called from ctor) bool CreateBase(wxWindowBase *parent, @@ -119,17 +149,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? @@ -138,7 +168,7 @@ public: // window attributes // ----------------- - // NB: in future versions of wxWindows Set/GetTitle() will only work + // 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). @@ -157,6 +187,11 @@ public: virtual void SetName( const wxString &name ) { m_windowName = name; } virtual wxString GetName() const { return m_windowName; } + // sets the window variant, calls internally DoSetVariant if variant has changed + void SetWindowVariant( wxWindowVariant variant ) ; + wxWindowVariant GetWindowVariant() const { return m_windowVariant ; } + + // window id uniquely identifies the window among its siblings unless // it is -1 which means "don't care" void SetId( wxWindowID winid ) { m_windowId = winid; } @@ -195,6 +230,9 @@ public: void Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING) { Move(pt.x, pt.y, flags); } + // A 'Smart' SetSize that will fill in default size values with 'best' size + void SetBestFittingSize(const wxSize& size=wxDefaultSize); + // Z-order virtual void Raise() = 0; virtual void Lower() = 0; @@ -219,6 +257,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 { @@ -303,9 +343,22 @@ public: virtual void SetSizeHints( int minW, int minH, int maxW = -1, int maxH = -1, int incW = -1, int incH = -1 ); + 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); + } virtual void SetVirtualSizeHints( int minW, int minH, int maxW = -1, int maxH = -1 ); + void SetVirtualSizeHints( const wxSize& minSize, + const wxSize& maxSize=wxDefaultSize) + { + SetVirtualSizeHints(minSize.x, minSize.y, maxSize.x, maxSize.y); + } virtual int GetMinWidth() const { return m_minWidth; } virtual int GetMinHeight() const { return m_minHeight; } @@ -314,7 +367,11 @@ public: // Override this method to control the values given to Sizers etc. virtual wxSize GetMaxSize() const { return wxSize( m_maxWidth, m_maxHeight ); } + virtual wxSize GetMinSize() const { return wxSize( m_minWidth, m_minHeight ); } + void SetMinSize(const wxSize& minSize) { SetSizeHints(minSize); } + void SetMaxSize(const wxSize& maxSize) { SetSizeHints(GetMinSize(), maxSize); } + // Methods for accessing the virtual size of a window. For most // windows this is just the client area of the window, but for // some like scrolled windows it is more or less independent of @@ -356,14 +413,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 +443,24 @@ 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); + + + // (primitive) theming support + // --------------------------- 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 it's 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 // --------------------------- @@ -425,6 +495,9 @@ public: // set this child as temporary default virtual void SetTmpDefaultItem(wxWindow * WXUNUSED(win)) { } + // Navigates in the specified direction by sending a wxNavigationKeyEvent + virtual bool Navigate(int flags = wxNavigationKeyEvent::IsForward); + // parent/children relations // ------------------------- @@ -432,6 +505,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 +517,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 +553,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 +576,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 @@ -572,17 +648,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() { } @@ -614,25 +690,55 @@ public: // colours, fonts and cursors // -------------------------- + // get the default attributes for the controls of this class: we + // provide a virtual function which can be used to query the default + // attributes of an existing control and a static function which can + // be used even when no existing object of the given class is + // available, but which won't return any styles specific to this + // particular control, of course (e.g. "Ok" button might have + // different -- bold for example -- font) + virtual wxVisualAttributes GetDefaultAttributes() const + { + return GetClassDefaultAttributes(GetWindowVariant()); + } + + static wxVisualAttributes + GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL); + // set/retrieve the window colours (system defaults are used by - // default): Set functions return TRUE if colour was changed - virtual bool SetBackgroundColour( const wxColour &colour ); - virtual bool SetForegroundColour( const wxColour &colour ); + // default): SetXXX() functions return true if colour was changed, + // SetDefaultXXX() reset the "m_hasXXX" flag after setting the value + // to prevent it from being inherited by our children + virtual bool SetBackgroundColour(const wxColour& colour); + void SetDefaultBackgroundColour(const wxColour& colour) + { + if ( SetBackgroundColour(colour) ) + m_hasBgCol = false; + } + wxColour GetBackgroundColour() const; + + virtual bool SetForegroundColour(const wxColour& colour); + void SetDefaultForegroundColour(const wxColour& colour) + { + if ( SetForegroundColour(colour) ) + m_hasFgCol = false; + } + wxColour GetForegroundColour() const; - wxColour GetBackgroundColour() const { return m_backgroundColour; } - wxColour GetForegroundColour() const { return m_foregroundColour; } + // set/retrieve the font for the window (SetFont() returns true if the + // font really changed) + virtual bool SetFont(const wxFont& font) = 0; + void SetDefaultFont(const wxFont& font) + { + if ( SetFont(font) ) + m_hasFont = false; + } + wxFont GetFont() const; - // 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 - // font really changed) - virtual bool SetFont( const wxFont &font ) = 0; - const wxFont& GetFont() const { return m_font; } - wxFont& GetFont() { return m_font; } #if wxUSE_CARET // associate a caret with the window @@ -698,16 +804,16 @@ public: // get border for the flags of this window wxBorder GetBorder() const { return GetBorder(GetWindowStyleFlag()); } - // send wxUpdateUIEvents to this window, and children if recurse is TRUE + // 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 ) + bool PopupMenu(wxMenu *menu, const wxPoint& pos = wxDefaultPosition) { return DoPopupMenu(menu, pos.x, pos.y); } - bool PopupMenu( wxMenu *menu, int x, int y ) + bool PopupMenu(wxMenu *menu, int x, int y) { return DoPopupMenu(menu, x, y); } #endif // wxUSE_MENUS @@ -726,8 +832,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; @@ -738,9 +844,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); } @@ -773,6 +879,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 @@ -801,7 +908,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); @@ -825,13 +932,13 @@ 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); wxSizer *GetContainingSizer() const { return m_containingSizer; } // accessibility @@ -850,17 +957,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 // -------------- @@ -877,7 +973,7 @@ public: virtual void OnInternalIdle() {} // call internal idle recursively - void ProcessInternalIdle() ; +// 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 @@ -900,11 +996,21 @@ public: wxWindow *GetAncestorWithCustomPalette() const; #endif // wxUSE_PALETTE + // inherit the parents visual attributes if they had been explicitly set + // by the user (i.e. we don't inherit default attributes) and if we don't + // have our own explicitly set + virtual void InheritAttributes(); + + // returns false from here if this window doesn't want to inherit the + // parents colours even if InheritAttributes() would normally do it + // + // this just provides a simple way to customize InheritAttributes() + // behaviour in the most common case + virtual bool ShouldInheritColours() const { return false; } + protected: // event handling specific to wxWindow -#if wxUSE_VALIDATORS virtual bool TryValidator(wxEvent& event); -#endif // wxUSE_VALIDATORS virtual bool TryParent(wxEvent& event); @@ -947,8 +1053,9 @@ protected: // visual window attributes wxCursor m_cursor; - wxFont m_font; - wxColour m_backgroundColour, m_foregroundColour; + wxFont m_font; // see m_hasFont + wxColour m_backgroundColour, // m_hasBgCol + m_foregroundColour; // m_hasFgCol #if wxUSE_CARET wxCaret *m_caret; @@ -1010,6 +1117,7 @@ protected: #if wxUSE_ACCESSIBILITY wxAccessible* m_accessible; #endif + // Virtual size (scrolling) wxSize m_virtualSize; @@ -1018,43 +1126,31 @@ protected: int m_maxVirtualWidth; int m_maxVirtualHeight; - // common part of all ctors: it is not virtual because it is called from - // ctor - void InitBase(); + wxWindowVariant m_windowVariant ; // override this to change the default (i.e. used when no style is // specified) border for the window class virtual wxBorder GetDefaultBorder() const; - // get the default size for the new window if no explicit size given - // FIXME why 20 and not 30, 10 or ...? + // 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. static int WidthDefault(int w) { return w == -1 ? 20 : w; } static int HeightDefault(int h) { return h == -1 ? 20 : h; } - // set the best size for the control if the default size was given: - // replaces the fields of size == -1 with the best values for them and - // calls SetSize() if needed + // keep the old name for compatibility, at least until all the internal + // usages of it are changed to SetBestFittingSize + void SetBestSize(const wxSize& size) { SetBestFittingSize(size); } + + + // set the initial window size if none is given (i.e. at least one of the + // components of the size passed to ctor/Create() is -1) // - // This function is rather unfortunately named.. it's really just a - // smarter SetSize / convenience function for expanding wxDefaultSize. - // Note that it does not influence the value returned by GetBestSize - // at all. - void SetBestSize(const wxSize& size) - { - // the size only needs to be changed if the current size is incomplete, - // i.e. one of the components was specified as default -- so if both - // were given, simply don't do anything - if ( size.x == -1 || size.y == -1 ) - { - wxSize sizeBest = DoGetBestSize(); - if ( size.x != -1 ) - sizeBest.x = size.x; - if ( size.y != -1 ) - sizeBest.y = size.y; - - SetSize(sizeBest); - } - } + // normally just calls SetBestSize() for controls, but can be overridden + // not to do it for the controls which have to do some additional + // initialization (e.g. add strings to list box) before their best size + // can be accurately calculated + virtual void SetInitialBestSize(const wxSize& WXUNUSED(size)) {} + // more pure virtual functions // --------------------------- @@ -1109,16 +1205,19 @@ protected: #endif // wxUSE_TOOLTIPS #if wxUSE_MENUS - virtual bool DoPopupMenu( wxMenu *menu, int x, int y ) = 0; + virtual bool DoPopupMenu(wxMenu *menu, int x, int y) = 0; #endif // wxUSE_MENUS - // Makes an adjustment to the window position (for example, a frame that has - // a toolbar that it manages itself). - virtual void AdjustForParentClientOrigin(int& x, int& y, int sizeFlags) const; + // Makes an adjustment to the window position to make it relative to the + // parents client area, e.g. if the parent is a frame with a toolbar, its + // (0, 0) is just below the toolbar + virtual void AdjustForParentClientOrigin(int& x, int& y, + int sizeFlags = 0) const; + // implements the window variants + virtual void DoSetWindowVariant( wxWindowVariant variant ) ; private: - // contains the last id generated by NewControlId static int ms_lastControlId; @@ -1140,7 +1239,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__) @@ -1150,7 +1248,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__) @@ -1158,7 +1255,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__) @@ -1166,7 +1262,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__) @@ -1174,7 +1269,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__) @@ -1182,7 +1276,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__) @@ -1190,7 +1283,6 @@ private: #define wxWindowNative wxWindowOS2 #else // !wxUniv #define wxWindowOS2 wxWindow - #define sm_classwxWindowOS2 sm_classwxWindow #endif // wxUniv/!wxUniv #include "wx/os2/window.h" #endif @@ -1320,7 +1412,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")