git.sesse.net Git - casparcg/blob - dependencies64/cef/windows/include/views/cef_box_layout.h

   1 // Copyright (c) 2016 Marshall A. Greenblatt. All rights reserved.
   2 //
   3 // Redistribution and use in source and binary forms, with or without
   4 // modification, are permitted provided that the following conditions are
   5 // met:
   6 //
   7 //    * Redistributions of source code must retain the above copyright
   8 // notice, this list of conditions and the following disclaimer.
   9 //    * Redistributions in binary form must reproduce the above
  10 // copyright notice, this list of conditions and the following disclaimer
  11 // in the documentation and/or other materials provided with the
  12 // distribution.
  13 //    * Neither the name of Google Inc. nor the name Chromium Embedded
  14 // Framework nor the names of its contributors may be used to endorse
  15 // or promote products derived from this software without specific prior
  16 // written permission.
  17 //
  18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 //
  30 // ---------------------------------------------------------------------------
  31 //
  32 // The contents of this file must follow a specific format in order to
  33 // support the CEF translator tool. See the translator.README.txt file in the
  34 // tools directory for more information.
  35 //
  36
  37 #ifndef CEF_INCLUDE_VIEWS_CEF_BOX_LAYOUT_H_
  38 #define CEF_INCLUDE_VIEWS_CEF_BOX_LAYOUT_H_
  39 #pragma once
  40
  41 #include "include/views/cef_layout.h"
  42
  43 class CefView;
  44
  45 ///
  46 // A Layout manager that arranges child views vertically or horizontally in a
  47 // side-by-side fashion with spacing around and between the child views. The
  48 // child views are always sized according to their preferred size. If the
  49 // host's bounds provide insufficient space, child views will be clamped.
  50 // Excess space will not be distributed. Methods must be called on the browser
  51 // process UI thread unless otherwise indicated.
  52 ///
  53 /*--cef(source=library)--*/
  54 class CefBoxLayout : public CefLayout {
  55  public:
  56   ///
  57   // Set the flex weight for the given |view|. Using the preferred size as
  58   // the basis, free space along the main axis is distributed to views in the
  59   // ratio of their flex weights. Similarly, if the views will overflow the
  60   // parent, space is subtracted in these ratios. A flex of 0 means this view is
  61   // not resized. Flex values must not be negative.
  62   ///
  63   /*--cef()--*/
  64   virtual void SetFlexForView(CefRefPtr<CefView> view, int flex) =0;
  65
  66   ///
  67   // Clears the flex for the given |view|, causing it to use the default flex
  68   // specified via CefBoxLayoutSettings.default_flex.
  69   ///
  70   /*--cef()--*/
  71   virtual void ClearFlexForView(CefRefPtr<CefView> view) =0;
  72 };
  73
  74 #endif  // CEF_INCLUDE_VIEWS_CEF_BOX_LAYOUT_H_