Add Flex::row/column, deprecate Column/Row

cmyr · cmyr · commit 8dd855a97275 · 2019-11-25T12:01:51.000-05:00
I'm actually fairly ambivalent about this change, but it makes
things more consistent and perhaps slightly less confusing.
diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@ active development and its API might change.
 Here's a simple counter example app.
 
 ```rust
-use druid::widget::{Align, Button, Column, Label, Padding, WidgetExt};
+use druid::widget::{Align, Button, Flex, Label, Padding, WidgetExt};
 use druid::{AppLauncher, LocalizedString, Widget, WindowDesc};
 
 fn main() {
@@ -44,7 +44,7 @@ fn ui_builder() -> impl Widget<u32> {
     let button = Button::new("increment", |_ctx, data, _env| *data += 1)
         .padding(5.0);
 
-    let mut col = Column::new();
+    let mut col = Flex::column();
     col.add_child(label, 1.0);
     col.add_child(button, 1.0);
     col
@@ -153,7 +153,7 @@ implement your own. You can also compose widgets into new widgets:
 
 ```rust
 fn build_widget() -> impl Widget<u32> {
-    let mut col = Column::new();
+    let mut col = Flex::column();
     for i in 0..30 {
         let button = Button::new(format!("Button {}", i), Button::noop)
             .padding(5.0).;
diff --git a/druid/examples/calc.rs b/druid/examples/calc.rs
@@ -16,7 +16,7 @@
 
 use druid::{AppLauncher, Data, Lens, LensWrap, Widget, WindowDesc};
 
-use druid::widget::{Button, Column, DynLabel, Padding, Row};
+use druid::widget::{Button, DynLabel, Flex, Padding};
 
 #[derive(Clone, Data, Lens)]
 struct CalcState {
@@ -140,7 +140,7 @@ fn flex_row<T: Data>(
     w3: impl Widget<T> + 'static,
     w4: impl Widget<T> + 'static,
 ) -> impl Widget<T> {
-    let mut row = Row::new();
+    let mut row = Flex::row();
     row.add_child(w1, 1.0);
     row.add_child(w2, 1.0);
     row.add_child(w3, 1.0);
@@ -149,7 +149,7 @@ fn flex_row<T: Data>(
 }
 
 fn build_calc() -> impl Widget<CalcState> {
-    let mut column = Column::new();
+    let mut column = Flex::column();
     let display = LensWrap::new(
         DynLabel::new(|data: &String, _env| data.clone()),
         lenses::calc_state::value,
diff --git a/druid/examples/either.rs b/druid/examples/either.rs
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use druid::widget::{Checkbox, Column, Either, Label, Padding, Slider};
+use druid::widget::{Checkbox, Either, Flex, Label, Padding, Slider};
 use druid::{AppLauncher, Data, Lens, LensWrap, Widget, WindowDesc};
 
 #[derive(Clone, Default, Data, Lens)]
@@ -33,7 +33,7 @@ fn main() {
 fn ui_builder() -> impl Widget<AppState> {
     let label = Label::new("Click to reveal slider");
 
-    let mut col = Column::new();
+    let mut col = Flex::column();
     col.add_child(
         Padding::new(
             5.0,
diff --git a/druid/examples/hello.rs b/druid/examples/hello.rs
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use druid::widget::{Align, Button, Column, Label, Padding};
+use druid::widget::{Align, Button, Flex, Label, Padding};
 use druid::{AppLauncher, LocalizedString, Widget, WindowDesc};
 
 fn main() {
@@ -30,7 +30,7 @@ fn ui_builder() -> impl Widget<u32> {
     let label = Label::new(text);
     let button = Button::new("increment", |_ctx, data, _env| *data += 1);
 
-    let mut col = Column::new();
+    let mut col = Flex::column();
     col.add_child(Align::centered(Padding::new(5.0, label)), 1.0);
     col.add_child(Padding::new(5.0, button), 1.0);
     col
diff --git a/druid/examples/layout.rs b/druid/examples/layout.rs
@@ -15,15 +15,15 @@
 //! This example shows how to construct a basic layout.
 
 use druid::piet::Color;
-use druid::widget::{Button, Column, Label, Row, SizedBox, WidgetExt};
+use druid::widget::{Button, Flex, Label, SizedBox, WidgetExt};
 use druid::{AppLauncher, Widget, WindowDesc};
 
 fn build_app() -> impl Widget<u32> {
     // Begin construction of vertical layout
-    let mut col = Column::new();
+    let mut col = Flex::column();
 
     // Construct a horizontal layout.
-    let mut header = Row::new();
+    let mut header = Flex::row();
     header.add_child(
         Label::new("One")
             .center()
diff --git a/druid/examples/list.rs b/druid/examples/list.rs
@@ -17,7 +17,7 @@ use std::sync::Arc;
 
 use druid::piet::Color;
 
-use druid::widget::{Button, Column, Container, DynLabel, List, Padding, Scroll, SizedBox};
+use druid::widget::{Button, Container, DynLabel, Flex, List, Padding, Scroll, SizedBox};
 use druid::{AppLauncher, Widget, WindowDesc};
 
 type AppData = Arc<Vec<u32>>;
@@ -32,7 +32,7 @@ fn main() {
 }
 
 fn ui_builder() -> impl Widget<AppData> {
-    let mut root = Column::new();
+    let mut root = Flex::column();
 
     root.add_child(
         SizedBox::new(Button::new("Add", |_, data: &mut AppData, _| {
diff --git a/druid/examples/multiwin.rs b/druid/examples/multiwin.rs
@@ -14,7 +14,7 @@
 
 //! Opening and closing windows and using window and context menus.
 
-use druid::widget::{Align, Button, Column, Label, Padding, Row};
+use druid::widget::{Align, Button, Flex, Label, Padding};
 use druid::{
     AppDelegate, AppLauncher, Command, ContextMenu, Data, DelegateCtx, Env, Event, EventCtx,
     LocalizedString, MenuDesc, MenuItem, Selector, Widget, WindowDesc, WindowId,
@@ -73,9 +73,9 @@ fn ui_builder() -> impl Widget<State> {
         ctx.set_menu(make_menu::<State>(data));
     });
 
-    let mut col = Column::new();
+    let mut col = Flex::column();
     col.add_child(Align::centered(Padding::new(5.0, label)), 1.0);
-    let mut row = Row::new();
+    let mut row = Flex::row();
     row.add_child(Padding::new(5.0, inc_button), 1.0);
     row.add_child(Padding::new(5.0, dec_button), 1.0);
     col.add_child(row, 1.0);
diff --git a/druid/examples/radio.rs b/druid/examples/radio.rs
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use druid::widget::{Column, Padding, Radio, RadioGroup, SizedBox};
+use druid::widget::{Flex, Padding, Radio, RadioGroup, SizedBox};
 use druid::{AppLauncher, Data, Widget, WindowDesc};
 
 #[derive(Clone, PartialEq, Data)]
@@ -24,7 +24,7 @@ enum Choice {
 }
 
 fn build_widget() -> impl Widget<Choice> {
-    let mut col = Column::new();
+    let mut col = Flex::column();
 
     col.add_child(
         Padding::new(5.0, Radio::new("First choice", Choice::A)),
diff --git a/druid/examples/scroll.rs b/druid/examples/scroll.rs
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use druid::widget::{Button, Column, Padding, Scroll};
+use druid::widget::{Button, Flex, Padding, Scroll};
 use druid::{AppLauncher, Widget, WindowDesc};
 
 fn main() {
@@ -24,7 +24,7 @@ fn main() {
 }
 
 fn build_widget() -> impl Widget<u32> {
-    let mut col = Column::new();
+    let mut col = Flex::column();
     for i in 0..30 {
         let button = Button::new(format!("Button {}", i), Button::noop);
         col.add_child(Padding::new(3.0, button), 0.0);
diff --git a/druid/examples/scroll_colors.rs b/druid/examples/scroll_colors.rs
@@ -15,16 +15,16 @@
 //! This example allows to play with scroll bars over different color tones.
 
 use druid::piet::Color;
-use druid::widget::{Column, Container, Row, Scroll, SizedBox};
+use druid::widget::{Container, Flex, Scroll, SizedBox};
 use druid::{AppLauncher, Widget, WindowDesc};
 
 fn build_app() -> impl Widget<u32> {
-    let mut col = Column::new();
+    let mut col = Flex::column();
     let rows = 30;
     let cols = 30;
 
     for i in 0..cols {
-        let mut row = Row::new();
+        let mut row = Flex::row();
         let col_progress = i as f64 / cols as f64;
 
         for j in 0..rows {
diff --git a/druid/examples/slider.rs b/druid/examples/slider.rs
@@ -12,9 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use druid::widget::{
-    Align, Button, Checkbox, Column, DynLabel, Label, Padding, ProgressBar, Row, Slider,
-};
+use druid::widget::{Align, Button, Checkbox, DynLabel, Flex, Label, Padding, ProgressBar, Slider};
 use druid::{AppLauncher, Data, Lens, LensWrap, Widget, WindowDesc};
 
 #[derive(Clone, Data, Lens)]
@@ -24,15 +22,15 @@ struct DemoState {
 }
 
 fn build_widget() -> impl Widget<DemoState> {
-    let mut col = Column::new();
+    let mut col = Flex::column();
     let label = DynLabel::new(|data: &DemoState, _env| {
         if data.double {
             format!("2x the value: {0:.2}", data.value * 2.0)
         } else {
             format!("actual value: {0:.2}", data.value)
         }
     });
-    let mut row = Row::new();
+    let mut row = Flex::row();
     let checkbox = LensWrap::new(Checkbox::new(), lenses::demo_state::double);
     let checkbox_label = Label::new("double the value");
     row.add_child(checkbox, 0.0);
diff --git a/druid/examples/switch.rs b/druid/examples/switch.rs
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use druid::widget::{Column, Label, Padding, Row, Switch};
+use druid::widget::{Flex, Label, Padding, Switch};
 use druid::{AppLauncher, Data, Lens, LensWrap, Widget, WindowDesc};
 
 #[derive(Clone, Data, Lens)]
@@ -21,8 +21,8 @@ struct DemoState {
 }
 
 fn build_widget() -> impl Widget<DemoState> {
-    let mut col = Column::new();
-    let mut row = Row::new();
+    let mut col = Flex::column();
+    let mut row = Flex::row();
     let switch = LensWrap::new(Switch::new(), lenses::demo_state::value);
     let switch_label = Label::new("Setting label");
 
diff --git a/druid/examples/textbox.rs b/druid/examples/textbox.rs
@@ -15,7 +15,7 @@
 //! Demos the textbox widget, as well as menu creation and overriding theme settings.
 
 use druid::piet::Color;
-use druid::widget::{Column, DynLabel, EnvScope, Padding, TextBox};
+use druid::widget::{DynLabel, EnvScope, Flex, Padding, TextBox};
 use druid::{theme, AppLauncher, Data, LocalizedString, MenuDesc, Widget, WindowDesc};
 
 fn main() {
@@ -34,7 +34,7 @@ fn main() {
 }
 
 fn build_widget() -> impl Widget<String> {
-    let mut col = Column::new();
+    let mut col = Flex::column();
 
     let textbox = TextBox::new();
     let textbox_2 = EnvScope::new(
diff --git a/druid/src/widget/flex.rs b/druid/src/widget/flex.rs
@@ -39,7 +39,6 @@ pub struct Column;
 /// A container with either horizontal or vertical layout.
 pub struct Flex<T: Data> {
     direction: Axis,
-
     children: Vec<ChildWidget<T>>,
 }
 
@@ -85,29 +84,43 @@ impl Row {
     /// Create a new row widget.
     ///
     /// The child widgets are laid out horizontally, from left to right.
+    #[deprecated(since = "0.4.0", note = "Use Flex::row() instead")]
     pub fn new<T: Data>() -> Flex<T> {
-        Flex {
-            direction: Axis::Horizontal,
-
-            children: Vec::new(),
-        }
+        Flex::row()
     }
 }
 
 impl Column {
     /// Create a new row widget.
     ///
     /// The child widgets are laid out vertically, from top to bottom.
+    #[deprecated(since = "0.4.0", note = "Use Flex::column() instead")]
     pub fn new<T: Data>() -> Flex<T> {
+        Flex::column()
+    }
+}
+
+impl<T: Data> Flex<T> {
+    /// Create a new horizontal stack.
+    ///
+    /// The child widgets are laid out horizontally, from left to right.
+    pub fn row() -> Self {
         Flex {
-            direction: Axis::Vertical,
+            direction: Axis::Horizontal,
+            children: Vec::new(),
+        }
+    }
 
+    /// Create a new vertical stack.
+    ///
+    /// The child widgets are laid out vertically, from top to bottom.
+    pub fn column() -> Self {
+        Flex {
+            direction: Axis::Vertical,
             children: Vec::new(),
         }
     }
-}
 
-impl<T: Data> Flex<T> {
     /// Add a child widget.
     ///
     /// If `flex` is zero, then the child is non-flex. It is given the same
diff --git a/druid/src/widget/radio.rs b/druid/src/widget/radio.rs
@@ -19,7 +19,7 @@ use std::marker::PhantomData;
 use crate::kurbo::{Circle, Point, Rect, Size};
 use crate::piet::{LinearGradient, RenderContext, UnitPoint};
 use crate::theme;
-use crate::widget::{Align, Column, Label, LabelText, Padding};
+use crate::widget::{Align, Flex, Label, LabelText, Padding};
 use crate::{
     BaseState, BoxConstraints, Data, Env, Event, EventCtx, LayoutCtx, PaintCtx, UpdateCtx, Widget,
     WidgetPod,
@@ -36,7 +36,7 @@ impl<T: Data + PartialEq + 'static> RadioGroup<T> {
     pub fn new(
         variants: impl IntoIterator<Item = (impl Into<LabelText<T>> + 'static, T)>,
     ) -> impl Widget<T> {
-        let mut col = Column::new();
+        let mut col = Flex::column();
         for (label, variant) in variants.into_iter() {
             let radio = Radio::new(label, variant);
             col.add_child(Padding::new(5.0, radio), 0.0);
