X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3c3ead1d1513a5eb79091a604f4e42b45d1bdf5d..b09857ae000a60704207d63290be937584805fb0:/interface/wx/ribbon/control.h?ds=sidebyside diff --git a/interface/wx/ribbon/control.h b/interface/wx/ribbon/control.h index 8c63afe0de..88e0c85ee0 100644 --- a/interface/wx/ribbon/control.h +++ b/interface/wx/ribbon/control.h @@ -10,10 +10,10 @@ @class wxRibbonControl wxRibbonControl serves as a base class for all controls which share the - ribbon charactertics of having a ribbon art provider, and (optionally) - non-continous resizing. Despite what the name may imply, it is not the + ribbon characteristics of having a ribbon art provider, and (optionally) + non-continuous resizing. Despite what the name may imply, it is not the top-level control for creating a ribbon interface - that is wxRibbonBar. - + Ribbon controls often have a region which is "transparent", and shows the contents of the ribbon page or panel behind it. If implementing a new ribbon control, then it may be useful to realise that this effect is done @@ -36,7 +36,7 @@ public: /** Constructor. - + If @a parent is a wxRibbonControl with a non-NULL art provider, then the art provider of new control is set to that of @a parent. */ @@ -50,12 +50,12 @@ public: Set the art provider to be used. In many cases, setting the art provider will also set the art provider on all child windows which extend wxRibbonControl. - + In most cases, controls will not take ownership of the given pointer, with the notable exception being wxRibbonBar::SetArtProvider(). */ virtual void SetArtProvider(wxRibbonArtProvider* art); - + /** Get the art provider to be used. Note that until an art provider has been set in some way, this function may return NULL. @@ -65,31 +65,31 @@ public: /** @return @true if this window can take any size (greater than its minimum size), @false if it can only take certain sizes. - + @see GetNextSmallerSize() @see GetNextLargerSize() */ virtual bool IsSizingContinuous() const; - + /** If sizing is not continuous, then return a suitable size for the control which is smaller than the current size. - + @param direction The direction(s) in which the size should reduce. @return The current size if there is no smaller size, otherwise a suitable size which is smaller in the given direction(s), and the same as the current size in the other direction (if any). - + @see IsSizingContinuous() */ wxSize GetNextSmallerSize(wxOrientation direction) const; - + /** If sizing is not continuous, then return a suitable size for the control which is smaller than the given size. - + @param direction The direction(s) in which the size should reduce. @param relative_to @@ -98,31 +98,31 @@ public: @a relative_to if there is no smaller size, otherwise a suitable size which is smaller in the given direction(s), and the same as @a relative_to in the other direction (if any). - + @see IsSizingContinuous() @see DoGetNextSmallerSize() */ wxSize GetNextSmallerSize(wxOrientation direction, wxSize relative_to) const; - + /** If sizing is not continuous, then return a suitable size for the control - which is larger then the current size. - + which is larger than the current size. + @param direction The direction(s) in which the size should increase. @return The current size if there is no larger size, otherwise a suitable size which is larger in the given direction(s), and the same as the current size in the other direction (if any). - + @see IsSizingContinuous() */ wxSize GetNextLargerSize(wxOrientation direction) const; - + /** If sizing is not continuous, then return a suitable size for the control - which is larger then the given size. - + which is larger than the given size. + @param direction The direction(s) in which the size should increase. @param relative_to @@ -131,23 +131,37 @@ public: @a relative_to if there is no larger size, otherwise a suitable size which is larger in the given direction(s), and the same as @a relative_to in the other direction (if any). - + @see IsSizingContinuous() @see DoGetNextLargerSize() */ wxSize GetNextLargerSize(wxOrientation direction, wxSize relative_to) const; - + /** Perform initial size and layout calculations after children have been added, and/or realize children. */ virtual bool Realize(); - + /** Alias for Realize(). */ bool Realise(); - + + /** + Get the first ancestor which is a wxRibbonBar (or derived) or NULL + if not having such parent. + + @since 2.9.4 + */ + virtual wxRibbonBar* GetAncestorRibbonBar()const; + + + /** + Finds the best width and height given the parent's width and height. + Used to implement the wxRIBBON_PANEL_FLEXIBLE panel style. + */ + virtual wxSize GetBestSizeForParentSize(const wxSize& parentSize) const; protected: /** Implementation of GetNextSmallerSize().