Somehow, setting a tint color makes gauge work :/.

[wxWidgets.git] / interface / wx / ribbon / control.h

diff --git a/interface/wx/ribbon/control.h b/interface/wx/ribbon/control.h
index 8c63afe0dea00a2874e6e4bbae396c3cc4984a73..7d49661622b8a26729a4f657154778da887a3a29 100644 (file)
--- a/interface/wx/ribbon/control.h
+++ b/interface/wx/ribbon/control.h
@@ -2,7 +2,6 @@
 // Name:        ribbon/control.h
 // Purpose:     interface of wxRibbonControl
 // Author:      Peter Cawley
 // Name:        ribbon/control.h
 // Purpose:     interface of wxRibbonControl
 // Author:      Peter Cawley

-// RCS-ID:      $Id$

 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 


@@ -10,10 +9,10 @@
     @class wxRibbonControl
 
     wxRibbonControl serves as a base class for all controls which share the
     @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.
     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
     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 +35,7 @@ public:
 
     /**
         Constructor.
 
     /**
         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.
     */
         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 +49,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.
         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);
         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.
     /**
         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 +64,31 @@ public:
     /**
         @return @true if this window can take any size (greater than its minimum
         size), @false if it can only take certain sizes.
     /**
         @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;
         @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.
     /**
         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).
         @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;
         @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.
     /**
         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
         @param direction
             The direction(s) in which the size should reduce.
         @param relative_to


@@ -98,31 +97,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).
             @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;
         @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
     /**
         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).
         @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;
         @see IsSizingContinuous()
     */
     wxSize GetNextLargerSize(wxOrientation direction) const;

-    
+

     /**
         If sizing is not continuous, then return a suitable size for the control
     /**
         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
         @param direction
             The direction(s) in which the size should increase.
         @param relative_to


@@ -131,23 +130,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).
             @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;
         @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();
     /**
         Perform initial size and layout calculations after children have been
         added, and/or realize children.
     */
     virtual bool Realize();

-    
+

     /**
         Alias for Realize().
     */
     bool Realise();
     /**
         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().
 protected:
     /**
         Implementation of GetNextSmallerSize().