JUCE: ResizableBorderComponent::Zone Class Reference

JUCE

Public Types | Public Member Functions | Static Public Member Functions | List of all members
ResizableBorderComponent::Zone Class Reference
juce_gui_basics » layout

Represents the different sections of a resizable border, which allow it to resized in different ways. More...

`#include <juce_ResizableBorderComponent.h>`

## Public Types
enum | Zones { centre = 0 , left = 1 , top = 2 , right = 4 , bottom = 8 }

## Public Member Functions
| Zone (int zoneFlags) noexcept
| Creates a Zone from a combination of the flags in zoneFlags. More...
| Zone () noexcept
| Zone (const Zone &) noexcept
Zone & | operator= (const Zone &) noexcept
bool | operator== (const Zone &) const noexcept
bool | operator!= (const Zone &) const noexcept
MouseCursor | getMouseCursor () const noexcept
| Returns an appropriate mouse-cursor for this resize zone. More...
bool | isDraggingWholeObject () const noexcept
| Returns true if dragging this zone will move the enire object without resizing it. More...
bool | isDraggingLeftEdge () const noexcept
| Returns true if dragging this zone will move the object's left edge. More...
bool | isDraggingRightEdge () const noexcept
| Returns true if dragging this zone will move the object's right edge. More...
bool | isDraggingTopEdge () const noexcept
| Returns true if dragging this zone will move the object's top edge. More...
bool | isDraggingBottomEdge () const noexcept
| Returns true if dragging this zone will move the object's bottom edge. More...
template<typename ValueType >
Rectangle< ValueType > | resizeRectangleBy (Rectangle< ValueType > original, const Point< ValueType > &distance) const noexcept
| Resizes this rectangle by the given amount, moving just the edges that this zone applies to. More...
int | getZoneFlags () const noexcept
| Returns the raw flags for this zone. More...

## Static Public Member Functions
static Zone | fromPositionOnBorder (Rectangle< int > totalSize, BorderSize< int > border, Point< int > position)
| Given a point within a rectangle with a resizable border, this returns the zone that the point lies within. More...

## Detailed Description

Represents the different sections of a resizable border, which allow it to resized in different ways.

## Member Enumeration Documentation

## ◆ Zones

enum ResizableBorderComponent::Zone::Zones

Enumerator
centre |
left |
top |
right |
bottom |

## Constructor & Destructor Documentation

## ◆ Zone() [1/3]

ResizableBorderComponent::Zone::Zone | ( | int | zoneFlags | ) |
| explicitnoexcept

Creates a Zone from a combination of the flags in zoneFlags.

## ◆ Zone() [2/3]

ResizableBorderComponent::Zone::Zone | ( |  | ) |
| noexcept

## ◆ Zone() [3/3]

ResizableBorderComponent::Zone::Zone | ( | const Zone & |  | ) |
| noexcept

## Member Function Documentation

## ◆ operator=()

Zone & ResizableBorderComponent::Zone::operator= | ( | const Zone & |  | ) |
| noexcept

## ◆ operator==()

bool ResizableBorderComponent::Zone::operator== | ( | const Zone & |  | ) | const
| noexcept

## ◆ operator!=()

bool ResizableBorderComponent::Zone::operator!= | ( | const Zone & |  | ) | const
| noexcept

## ◆ fromPositionOnBorder()

static Zone ResizableBorderComponent::Zone::fromPositionOnBorder | ( | Rectangle< int > | totalSize,
|  | BorderSize< int > | border,
|  | Point< int > | position
| ) |  |
| static

Given a point within a rectangle with a resizable border, this returns the zone that the point lies within.

## ◆ getMouseCursor()

MouseCursor ResizableBorderComponent::Zone::getMouseCursor | ( |  | ) | const
| noexcept

Returns an appropriate mouse-cursor for this resize zone.

## ◆ isDraggingWholeObject()

bool ResizableBorderComponent::Zone::isDraggingWholeObject | ( |  | ) | const
| noexcept

Returns true if dragging this zone will move the enire object without resizing it.

## ◆ isDraggingLeftEdge()

bool ResizableBorderComponent::Zone::isDraggingLeftEdge | ( |  | ) | const
| noexcept

Returns true if dragging this zone will move the object's left edge.

References gl::left.

## ◆ isDraggingRightEdge()

bool ResizableBorderComponent::Zone::isDraggingRightEdge | ( |  | ) | const
| noexcept

Returns true if dragging this zone will move the object's right edge.

References gl::right.

## ◆ isDraggingTopEdge()

bool ResizableBorderComponent::Zone::isDraggingTopEdge | ( |  | ) | const
| noexcept

Returns true if dragging this zone will move the object's top edge.

References gl::top.

## ◆ isDraggingBottomEdge()

bool ResizableBorderComponent::Zone::isDraggingBottomEdge | ( |  | ) | const
| noexcept

Returns true if dragging this zone will move the object's bottom edge.

References gl::bottom.

## ◆ resizeRectangleBy()

template<typename ValueType >

Rectangle< ValueType > ResizableBorderComponent::Zone::resizeRectangleBy | ( | Rectangle< ValueType > | original,
|  | const Point< ValueType > & | distance
| ) |  | const
| noexcept

Resizes this rectangle by the given amount, moving just the edges that this zone applies to.

References gl::distance, jmax(), and jmin().

## ◆ getZoneFlags()

int ResizableBorderComponent::Zone::getZoneFlags | ( |  | ) | const
| noexcept

Returns the raw flags for this zone.

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

- juce_ResizableBorderComponent.h