eiffel-iup/library/iup_widget_floating.e

deferred class IUP_WIDGET_FLOATING
-- Commands to handle the attributes related with floating.

inherit
	IUP_WIDGET_INTERNALS
	
feature {ANY}

	set_floating (state: STRING)
		-- If an element has FLOATING=YES then its size and position will 
		-- be ignored by the layout processing in IUP_VBOX, IUP_HBOX and 
		-- IUP_ZBOX. But the element size and position will still be updated 
		-- in the native system allowing the usage of SIZE/RASTERSIZE 
		-- and POSITION to manually position and size the element. And 
		-- must ensure that the element will be on top of other using ZORDER, 
		-- if here is overlap.
		-- This is useful when you do not want that an invisible element 
		-- to be computed in the box size.
		-- If the value IGNORE is used then it will behave as YES, but 
		-- also it will not update the the size and position in the 
		-- native system.
		--
		-- Values: "YES", "IGNORE" or "NO".
		-- Default: "NO".
		require
			is_valid: is_yes_no_ignore(state)
		do
			iup_open.set_attribute(Current, "FLOATING", state)
		end

	get_floating: STRING
		-- Return the floating status of the element.
		do
			Result := iup_open.get_attribute(Current, "FLOATING")
		end

	enable_floating
		-- Like set_floating with YES.
		do
			iup_open.set_attribute(Current, "FLOATING", "YES")
		end

	ignore_floating
		-- Like set_floating with IGNORE.
		do
			iup_open.set_attribute(Current, "FLOATING", "IGNORE")
		end

	disable_floating
		-- Like set_floating with NO.
		do
			iup_open.set_attribute(Current, "FLOATING", "NO")
		end

end

-- The MIT License (MIT)

-- Copyright (c) 2016, 2019 by German A. Arias

-- Permission is hereby granted, free of charge, to any person obtaining a copy
-- of this software and associated documentation files (the "Software"), to deal
-- in the Software without restriction, including without limitation the rights
-- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-- copies of the Software, and to permit persons to whom the Software is
-- furnished to do so, subject to the following conditions:
--
-- The above copyright notice and this permission notice shall be included in 
-- all copies or substantial portions of the Software.
--
-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-- SOFTWARE.