Inkscape
Vector Graphics Editor
Loading...
Searching...
No Matches
Inkscape::CanvasItemRect Class Referencefinal

#include <canvas-item-rect.h>

Inheritance diagram for Inkscape::CanvasItemRect:
Inkscape::CanvasItem

Public Member Functions

 CanvasItemRect (CanvasItemGroup *group)
 Create an null control rect.
 
 CanvasItemRect (CanvasItemGroup *group, Geom::Rect const &rect)
 Create a control rect.
 
void set_rect (Geom::Rect const &rect)
 Set a control rect.
 
void visit_page_rects (std::function< void(Geom::Rect const &)> const &) const override
 Run a callback for each rectangle that should be filled and painted in the background.
 
bool contains (Geom::Point const &p, double tolerance=0) override
 Returns true if point p (in canvas units) is within tolerance (canvas units) distance of rect.
 
void set_is_page (bool is_page)
 
void set_fill (uint32_t color) override
 
void set_dashed (bool dash=true)
 
void set_inverted (bool inverted=false)
 
void set_shadow (uint32_t color, int width)
 
- Public Member Functions inherited from Inkscape::CanvasItem
 CanvasItem (CanvasItemContext *context)
 
 CanvasItem (CanvasItemGroup *parent)
 
 CanvasItem (CanvasItem const &)=delete
 
CanvasItemoperator= (CanvasItem const &)=delete
 
void unlink ()
 
UI::Widget::Canvasget_canvas () const
 
CanvasItemGroupget_parent () const
 
bool is_descendant_of (CanvasItem const *ancestor) const
 
void set_z_position (int zpos)
 
void raise_to_top ()
 
void lower_to_bottom ()
 
void request_update ()
 
void update (bool propagate)
 
Geom::OptRect const & get_bounds () const
 
void grab (EventMask event_mask, Glib::RefPtr< Gdk::Cursor > const &={})
 
void ungrab ()
 
void render (Inkscape::CanvasItemBuffer &buf) const
 
bool is_visible () const
 
virtual void set_visible (bool visible)
 
void request_redraw ()
 
void set_fill (CanvasItemColor color)
 
void set_fill_pattern (Cairo::RefPtr< Cairo::Pattern > pattern)
 
virtual void set_stroke (uint32_t rgba)
 
void set_stroke (CanvasItemColor color)
 
void set_stroke_width (double width)
 Set the stroke width.
 
void set_outline (uint32_t color)
 Set the outline color.
 
void set_outline_width (double width)
 Set the outline width.
 
double get_effective_outline () const
 Get the effective outline.
 
void set_name (std::string &&name)
 
std::string const & get_name () const
 
void update_canvas_item_ctrl_sizes (int size_index)
 
void set_pickable (bool pickable)
 
bool is_pickable () const
 
sigc::connection connect_event (sigc::slot< bool(CanvasEvent const &)> const &slot)
 
virtual bool handle_event (CanvasEvent const &event)
 
void canvas_item_print_tree (int level=0, int zorder=0) const
 

Protected Member Functions

 ~CanvasItemRect () override=default
 
void _update (bool propagate) override
 Update and redraw control rect.
 
void _render (Inkscape::CanvasItemBuffer &buf) const override
 Render rect to screen via Cairo.
 
double get_shadow_size () const
 
- Protected Member Functions inherited from Inkscape::CanvasItem
virtual ~CanvasItem ()
 
Geom::Affine const & affine () const
 
virtual void _mark_net_invisible ()
 
virtual void _invalidate_ctrl_handles ()
 
template<typename F >
void defer (F &&f)
 

Protected Attributes

Geom::Rect _rect
 
bool _is_page = false
 
bool _dashed = false
 
bool _inverted = false
 
int _shadow_width = 0
 
uint32_t _shadow_color = 0x0
 
- Protected Attributes inherited from Inkscape::CanvasItem
CanvasItemContext_context
 
CanvasItemGroup_parent
 
Geom::OptRect _bounds
 
bool _need_update = false
 
bool _visible = true
 
bool _net_visible = true
 
bool _pickable = false
 
uint32_t _fill = CANVAS_ITEM_COLORS[CANVAS_ITEM_SECONDARY]
 
Cairo::RefPtr< Cairo::Pattern > _fill_pattern
 
uint32_t _stroke = CANVAS_ITEM_COLORS[CANVAS_ITEM_PRIMARY]
 
double _stroke_width = 1.0
 
uint32_t _outline = 0x0
 
double _outline_width = 0
 
std::string _name
 
sigc::signal< bool(CanvasEvent const &)> _event_signal
 

Additional Inherited Members

- Public Attributes inherited from Inkscape::CanvasItem
boost::intrusive::list_member_hook member_hook
 

Detailed Description

Definition at line 28 of file canvas-item-rect.h.

Constructor & Destructor Documentation

◆ CanvasItemRect() [1/2]

Inkscape::CanvasItemRect::CanvasItemRect ( CanvasItemGroup group)

Create an null control rect.

Definition at line 33 of file canvas-item-rect.cpp.

References Inkscape::CanvasItem::_fill, and Inkscape::CanvasItem::_name.

◆ CanvasItemRect() [2/2]

Inkscape::CanvasItemRect::CanvasItemRect ( CanvasItemGroup group,
Geom::Rect const &  rect 
)

Create a control rect.

Point are in document coordinates.

Definition at line 43 of file canvas-item-rect.cpp.

References Inkscape::CanvasItem::_fill, and Inkscape::CanvasItem::_name.

◆ ~CanvasItemRect()

Inkscape::CanvasItemRect::~CanvasItemRect ( )
overrideprotecteddefault

Member Function Documentation

◆ _render()

◆ _update()

void Inkscape::CanvasItemRect::_update ( bool  propagate)
overrideprotectedvirtual

◆ contains()

bool Inkscape::CanvasItemRect::contains ( Geom::Point const &  p,
double  tolerance = 0 
)
overridevirtual

Returns true if point p (in canvas units) is within tolerance (canvas units) distance of rect.

Non-zero tolerance not implemented! Is valid for a rotated canvas.

Reimplemented from Inkscape::CanvasItem.

Definition at line 77 of file canvas-item-rect.cpp.

References _rect, Inkscape::CanvasItem::affine(), and Geom::GenericRect< C >::contains().

◆ get_shadow_size()

double Inkscape::CanvasItemRect::get_shadow_size ( ) const
protected

◆ set_dashed()

void Inkscape::CanvasItemRect::set_dashed ( bool  dash = true)

◆ set_fill()

void Inkscape::CanvasItemRect::set_fill ( uint32_t  color)
overridevirtual

◆ set_inverted()

void Inkscape::CanvasItemRect::set_inverted ( bool  inverted = false)

◆ set_is_page()

void Inkscape::CanvasItemRect::set_is_page ( bool  is_page)

◆ set_rect()

void Inkscape::CanvasItemRect::set_rect ( Geom::Rect const &  rect)

Set a control rect.

Points are in document coordinates.

Definition at line 54 of file canvas-item-rect.cpp.

References _rect, Inkscape::CanvasItem::defer(), and Inkscape::CanvasItem::request_update().

Referenced by Inkscape::UI::TransformHandleSet::setBounds().

◆ set_shadow()

void Inkscape::CanvasItemRect::set_shadow ( uint32_t  color,
int  width 
)

◆ visit_page_rects()

void Inkscape::CanvasItemRect::visit_page_rects ( std::function< void(Geom::Rect const &)> const &  f) const
overridevirtual

Run a callback for each rectangle that should be filled and painted in the background.

Reimplemented from Inkscape::CanvasItem.

Definition at line 66 of file canvas-item-rect.cpp.

References Inkscape::CanvasItem::_fill, _is_page, and _rect.

Member Data Documentation

◆ _dashed

bool Inkscape::CanvasItemRect::_dashed = false
protected

Definition at line 58 of file canvas-item-rect.h.

Referenced by _render(), _update(), and set_dashed().

◆ _inverted

bool Inkscape::CanvasItemRect::_inverted = false
protected

Definition at line 59 of file canvas-item-rect.h.

Referenced by _render(), and set_inverted().

◆ _is_page

bool Inkscape::CanvasItemRect::_is_page = false
protected

Definition at line 57 of file canvas-item-rect.h.

Referenced by _render(), set_fill(), set_is_page(), set_shadow(), and visit_page_rects().

◆ _rect

Geom::Rect Inkscape::CanvasItemRect::_rect
protected

Definition at line 56 of file canvas-item-rect.h.

Referenced by _render(), _update(), contains(), set_rect(), and visit_page_rects().

◆ _shadow_color

uint32_t Inkscape::CanvasItemRect::_shadow_color = 0x0
protected

Definition at line 61 of file canvas-item-rect.h.

Referenced by _render(), and set_shadow().

◆ _shadow_width

int Inkscape::CanvasItemRect::_shadow_width = 0
protected

Definition at line 60 of file canvas-item-rect.h.

Referenced by _render(), _update(), get_shadow_size(), and set_shadow().


The documentation for this class was generated from the following files: