diff options
Diffstat (limited to 'awesome/lib/wibox/widget/textbox.lua')
-rw-r--r-- | awesome/lib/wibox/widget/textbox.lua | 507 |
1 files changed, 0 insertions, 507 deletions
diff --git a/awesome/lib/wibox/widget/textbox.lua b/awesome/lib/wibox/widget/textbox.lua deleted file mode 100644 index add35e9..0000000 --- a/awesome/lib/wibox/widget/textbox.lua +++ /dev/null @@ -1,507 +0,0 @@ ---------------------------------------------------------------------------- --- --- --- ---![Usage example](../images/AUTOGEN_wibox_widget_defaults_textbox.svg) --- --- @usage ---wibox.widget{ --- markup = 'This <i>is</i> a <b>textbox</b>!!!', --- align = 'center', --- valign = 'center', --- widget = wibox.widget.textbox ---} --- @author Uli Schlachter --- @author dodo --- @copyright 2010, 2011 Uli Schlachter, dodo --- @classmod wibox.widget.textbox ---------------------------------------------------------------------------- - -local base = require("wibox.widget.base") -local gdebug = require("gears.debug") -local beautiful = require("beautiful") -local lgi = require("lgi") -local util = require("awful.util") -local Pango = lgi.Pango -local PangoCairo = lgi.PangoCairo -local setmetatable = setmetatable - -local textbox = { mt = {} } - ---- The textbox font. --- @beautiful beautiful.font - ---- Set the DPI of a Pango layout -local function setup_dpi(box, dpi) - if box._private.dpi ~= dpi then - box._private.dpi = dpi - box._private.ctx:set_resolution(dpi) - box._private.layout:context_changed() - end -end - ---- Setup a pango layout for the given textbox and dpi -local function setup_layout(box, width, height, dpi) - box._private.layout.width = Pango.units_from_double(width) - box._private.layout.height = Pango.units_from_double(height) - setup_dpi(box, dpi) -end - --- Draw the given textbox on the given cairo context in the given geometry -function textbox:draw(context, cr, width, height) - setup_layout(self, width, height, context.dpi) - cr:update_layout(self._private.layout) - local _, logical = self._private.layout:get_pixel_extents() - local offset = 0 - if self._private.valign == "center" then - offset = (height - logical.height) / 2 - elseif self._private.valign == "bottom" then - offset = height - logical.height - end - cr:move_to(0, offset) - cr:show_layout(self._private.layout) -end - -local function do_fit_return(self) - local _, logical = self._private.layout:get_pixel_extents() - if logical.width == 0 or logical.height == 0 then - return 0, 0 - end - return logical.width, logical.height -end - --- Fit the given textbox -function textbox:fit(context, width, height) - setup_layout(self, width, height, context.dpi) - return do_fit_return(self) -end - ---- Get the preferred size of a textbox. --- This returns the size that the textbox would use if infinite space were --- available. --- @tparam integer|screen s The screen on which the textbox will be displayed. --- @treturn number The preferred width. --- @treturn number The preferred height. -function textbox:get_preferred_size(s) - return self:get_preferred_size_at_dpi(beautiful.xresources.get_dpi(s)) -end - ---- Get the preferred height of a textbox at a given width. --- This returns the height that the textbox would use when it is limited to the --- given width. --- @tparam number width The available width. --- @tparam integer|screen s The screen on which the textbox will be displayed. --- @treturn number The needed height. -function textbox:get_height_for_width(width, s) - return self:get_height_for_width_at_dpi(width, beautiful.xresources.get_dpi(s)) -end - ---- Get the preferred size of a textbox. --- This returns the size that the textbox would use if infinite space were --- available. --- @tparam number dpi The DPI value to render at. --- @treturn number The preferred width. --- @treturn number The preferred height. -function textbox:get_preferred_size_at_dpi(dpi) - local max_lines = 2^20 - setup_dpi(self, dpi) - self._private.layout.width = -1 -- no width set - self._private.layout.height = -max_lines -- show this many lines per paragraph - return do_fit_return(self) -end - ---- Get the preferred height of a textbox at a given width. --- This returns the height that the textbox would use when it is limited to the --- given width. --- @tparam number width The available width. --- @tparam number dpi The DPI value to render at. --- @treturn number The needed height. -function textbox:get_height_for_width_at_dpi(width, dpi) - local max_lines = 2^20 - setup_dpi(self, dpi) - self._private.layout.width = Pango.units_from_double(width) - self._private.layout.height = -max_lines -- show this many lines per paragraph - local _, h = do_fit_return(self) - return h -end - ---- Set the text of the textbox (with --- [Pango markup](https://developer.gnome.org/pango/stable/PangoMarkupFormat.html)). --- @tparam string text The text to set. This can contain pango markup (e.g. --- `<b>bold</b>`). You can use `awful.util.escape` to escape --- parts of it. --- @treturn[1] boolean true --- @treturn[2] boolean false --- @treturn[2] string Error message explaining why the markup was invalid. -function textbox:set_markup_silently(text) - if self._private.markup == text then - return true - end - - local attr, parsed = Pango.parse_markup(text, -1, 0) - -- In case of error, attr is false and parsed is a GLib.Error instance. - if not attr then - return false, parsed.message or tostring(parsed) - end - - self._private.markup = text - self._private.layout.text = parsed - self._private.layout.attributes = attr - self:emit_signal("widget::redraw_needed") - self:emit_signal("widget::layout_changed") - return true -end - ---- Set the text of the textbox (with --- [Pango markup](https://developer.gnome.org/pango/stable/PangoMarkupFormat.html)). --- @property markup --- @tparam string text The text to set. This can contain pango markup (e.g. --- `<b>bold</b>`). You can use `awful.util.escape` to escape --- parts of it. --- @see text - -function textbox:set_markup(text) - local success, message = self:set_markup_silently(text) - if not success then - gdebug.print_error(message) - end -end - -function textbox:get_markup() - return self._private.markup -end - ---- Set a textbox' text. --- @property text --- @param text The text to display. Pango markup is ignored and shown as-is. --- @see markup - -function textbox:set_text(text) - if self._private.layout.text == text and self._private.layout.attributes == nil then - return - end - self._private.markup = nil - self._private.layout.text = text - self._private.layout.attributes = nil - self:emit_signal("widget::redraw_needed") - self:emit_signal("widget::layout_changed") -end - -function textbox:get_text() - return self._private.layout.text -end - ---- Set a textbox' ellipsize mode. --- @property ellipsize --- @param mode Where should long lines be shortened? "start", "middle" or "end" - -function textbox:set_ellipsize(mode) - local allowed = { none = "NONE", start = "START", middle = "MIDDLE", ["end"] = "END" } - if allowed[mode] then - if self._private.layout:get_ellipsize() == allowed[mode] then - return - end - self._private.layout:set_ellipsize(allowed[mode]) - self:emit_signal("widget::redraw_needed") - self:emit_signal("widget::layout_changed") - end -end - ---- Set a textbox' wrap mode. --- @property wrap --- @param mode Where to wrap? After "word", "char" or "word_char" - -function textbox:set_wrap(mode) - local allowed = { word = "WORD", char = "CHAR", word_char = "WORD_CHAR" } - if allowed[mode] then - if self._private.layout:get_wrap() == allowed[mode] then - return - end - self._private.layout:set_wrap(allowed[mode]) - self:emit_signal("widget::redraw_needed") - self:emit_signal("widget::layout_changed") - end -end - ---- The textbox' vertical alignment --- @property valign --- @param mode Where should the textbox be drawn? "top", "center" or "bottom" - -function textbox:set_valign(mode) - local allowed = { top = true, center = true, bottom = true } - if allowed[mode] then - if self._private.valign == mode then - return - end - self._private.valign = mode - self:emit_signal("widget::redraw_needed") - self:emit_signal("widget::layout_changed") - end -end - ---- Set a textbox' horizontal alignment. --- @property align --- @param mode Where should the textbox be drawn? "left", "center" or "right" - -function textbox:set_align(mode) - local allowed = { left = "LEFT", center = "CENTER", right = "RIGHT" } - if allowed[mode] then - if self._private.layout:get_alignment() == allowed[mode] then - return - end - self._private.layout:set_alignment(allowed[mode]) - self:emit_signal("widget::redraw_needed") - self:emit_signal("widget::layout_changed") - end -end - ---- Set a textbox' font --- @property font --- @param font The font description as string - -function textbox:set_font(font) - self._private.layout:set_font_description(beautiful.get_font(font)) - self:emit_signal("widget::redraw_needed") - self:emit_signal("widget::layout_changed") -end - ---- Create a new textbox. --- @tparam[opt=""] string text The textbox content --- @tparam[opt=false] boolean ignore_markup Ignore the pango/HTML markup --- @treturn table A new textbox widget --- @function wibox.widget.textbox -local function new(text, ignore_markup) - local ret = base.make_widget(nil, nil, {enable_properties = true}) - - util.table.crush(ret, textbox, true) - - ret._private.dpi = -1 - ret._private.ctx = PangoCairo.font_map_get_default():create_context() - ret._private.layout = Pango.Layout.new(ret._private.ctx) - - ret:set_ellipsize("end") - ret:set_wrap("word_char") - ret:set_valign("center") - ret:set_align("left") - ret:set_font(beautiful and beautiful.font) - - if text then - if ignore_markup then - ret:set_text(text) - else - ret:set_markup(text) - end - end - - return ret -end - -function textbox.mt.__call(_, ...) - return new(...) -end - ---Imported documentation - - ---- Get a widex index. --- @param widget The widget to look for --- @param[opt] recursive Also check sub-widgets --- @param[opt] ... Aditional widgets to add at the end of the \"path\" --- @return The index --- @return The parent layout --- @return The path between \"self\" and \"widget\" --- @function index - ---- Get all direct and indirect children widgets. --- This will scan all containers recursively to find widgets --- Warning: This method it prone to stack overflow id the widget, or any of its --- children, contain (directly or indirectly) itself. --- @treturn table The children --- @function get_all_children - ---- Set a declarative widget hierarchy description. --- See [The declarative layout system](../documentation/03-declarative-layout.md.html) --- @param args An array containing the widgets disposition --- @function setup - ---- Force a widget height. --- @property forced_height --- @tparam number|nil height The height (`nil` for automatic) - ---- Force a widget width. --- @property forced_width --- @tparam number|nil width The width (`nil` for automatic) - ---- The widget opacity (transparency). --- @property opacity --- @tparam[opt=1] number opacity The opacity (between 0 and 1) - ---- The widget visibility. --- @property visible --- @param boolean - ---- Set/get a widget's buttons. --- @param _buttons The table of buttons that should bind to the widget. --- @function buttons - ---- Emit a signal and ensure all parent widgets in the hierarchies also --- forward the signal. This is useful to track signals when there is a dynamic --- set of containers and layouts wrapping the widget. --- @tparam string signal_name --- @param ... Other arguments --- @function emit_signal_recursive - ---- When the layout (size) change. --- This signal is emitted when the previous results of `:layout()` and `:fit()` --- are no longer valid. Unless this signal is emitted, `:layout()` and `:fit()` --- must return the same result when called with the same arguments. --- @signal widget::layout_changed --- @see widget::redraw_needed - ---- When the widget content changed. --- This signal is emitted when the content of the widget changes. The widget will --- be redrawn, it is not re-layouted. Put differently, it is assumed that --- `:layout()` and `:fit()` would still return the same results as before. --- @signal widget::redraw_needed --- @see widget::layout_changed - ---- When a mouse button is pressed over the widget. --- @signal button::press --- @tparam number lx The horizontal position relative to the (0,0) position in --- the widget. --- @tparam number ly The vertical position relative to the (0,0) position in the --- widget. --- @tparam number button The button number. --- @tparam table mods The modifiers (mod4, mod1 (alt), Control, Shift) --- @tparam table find_widgets_result The entry from the result of --- @{wibox.drawable:find_widgets} for the position that the mouse hit. --- @tparam wibox.drawable find_widgets_result.drawable The drawable containing --- the widget. --- @tparam widget find_widgets_result.widget The widget being displayed. --- @tparam wibox.hierarchy find_widgets_result.hierarchy The hierarchy --- managing the widget's geometry. --- @tparam number find_widgets_result.x An approximation of the X position that --- the widget is visible at on the surface. --- @tparam number find_widgets_result.y An approximation of the Y position that --- the widget is visible at on the surface. --- @tparam number find_widgets_result.width An approximation of the width that --- the widget is visible at on the surface. --- @tparam number find_widgets_result.height An approximation of the height that --- the widget is visible at on the surface. --- @tparam number find_widgets_result.widget_width The exact width of the widget --- in its local coordinate system. --- @tparam number find_widgets_result.widget_height The exact height of the widget --- in its local coordinate system. --- @see mouse - ---- When a mouse button is released over the widget. --- @signal button::release --- @tparam number lx The horizontal position relative to the (0,0) position in --- the widget. --- @tparam number ly The vertical position relative to the (0,0) position in the --- widget. --- @tparam number button The button number. --- @tparam table mods The modifiers (mod4, mod1 (alt), Control, Shift) --- @tparam table find_widgets_result The entry from the result of --- @{wibox.drawable:find_widgets} for the position that the mouse hit. --- @tparam wibox.drawable find_widgets_result.drawable The drawable containing --- the widget. --- @tparam widget find_widgets_result.widget The widget being displayed. --- @tparam wibox.hierarchy find_widgets_result.hierarchy The hierarchy --- managing the widget's geometry. --- @tparam number find_widgets_result.x An approximation of the X position that --- the widget is visible at on the surface. --- @tparam number find_widgets_result.y An approximation of the Y position that --- the widget is visible at on the surface. --- @tparam number find_widgets_result.width An approximation of the width that --- the widget is visible at on the surface. --- @tparam number find_widgets_result.height An approximation of the height that --- the widget is visible at on the surface. --- @tparam number find_widgets_result.widget_width The exact width of the widget --- in its local coordinate system. --- @tparam number find_widgets_result.widget_height The exact height of the widget --- in its local coordinate system. --- @see mouse - ---- When the mouse enter a widget. --- @signal mouse::enter --- @tparam table find_widgets_result The entry from the result of --- @{wibox.drawable:find_widgets} for the position that the mouse hit. --- @tparam wibox.drawable find_widgets_result.drawable The drawable containing --- the widget. --- @tparam widget find_widgets_result.widget The widget being displayed. --- @tparam wibox.hierarchy find_widgets_result.hierarchy The hierarchy --- managing the widget's geometry. --- @tparam number find_widgets_result.x An approximation of the X position that --- the widget is visible at on the surface. --- @tparam number find_widgets_result.y An approximation of the Y position that --- the widget is visible at on the surface. --- @tparam number find_widgets_result.width An approximation of the width that --- the widget is visible at on the surface. --- @tparam number find_widgets_result.height An approximation of the height that --- the widget is visible at on the surface. --- @tparam number find_widgets_result.widget_width The exact width of the widget --- in its local coordinate system. --- @tparam number find_widgets_result.widget_height The exact height of the widget --- in its local coordinate system. --- @see mouse - ---- When the mouse leave a widget. --- @signal mouse::leave --- @tparam table find_widgets_result The entry from the result of --- @{wibox.drawable:find_widgets} for the position that the mouse hit. --- @tparam wibox.drawable find_widgets_result.drawable The drawable containing --- the widget. --- @tparam widget find_widgets_result.widget The widget being displayed. --- @tparam wibox.hierarchy find_widgets_result.hierarchy The hierarchy --- managing the widget's geometry. --- @tparam number find_widgets_result.x An approximation of the X position that --- the widget is visible at on the surface. --- @tparam number find_widgets_result.y An approximation of the Y position that --- the widget is visible at on the surface. --- @tparam number find_widgets_result.width An approximation of the width that --- the widget is visible at on the surface. --- @tparam number find_widgets_result.height An approximation of the height that --- the widget is visible at on the surface. --- @tparam number find_widgets_result.widget_width The exact width of the widget --- in its local coordinate system. --- @tparam number find_widgets_result.widget_height The exact height of the widget --- in its local coordinate system. --- @see mouse - - ---Imported documentation - - ---- Disconnect to a signal. --- @tparam string name The name of the signal --- @tparam function func The callback that should be disconnected --- @function disconnect_signal - ---- Emit a signal. --- --- @tparam string name The name of the signal --- @param ... Extra arguments for the callback functions. Each connected --- function receives the object as first argument and then any extra arguments --- that are given to emit_signal() --- @function emit_signal - ---- Connect to a signal. --- @tparam string name The name of the signal --- @tparam function func The callback to call when the signal is emitted --- @function connect_signal - ---- Connect to a signal weakly. This allows the callback function to be garbage --- collected and automatically disconnects the signal when that happens. --- --- **Warning:** --- Only use this function if you really, really, really know what you --- are doing. --- @tparam string name The name of the signal --- @tparam function func The callback to call when the signal is emitted --- @function weak_connect_signal - - -return setmetatable(textbox, textbox.mt) - --- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80 |