mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-10 23:44:24 +00:00
First check-in of the "jucequake": a major re-organisation of the library to break it up into modules. For more details about this, see the website forum..
This commit is contained in:
parent
1a21c89755
commit
b70e0a28d2
1527 changed files with 90380 additions and 396643 deletions
109
modules/juce_gui_basics/positioning/juce_RelativeRectangle.h
Normal file
109
modules/juce_gui_basics/positioning/juce_RelativeRectangle.h
Normal file
|
|
@ -0,0 +1,109 @@
|
|||
/*
|
||||
==============================================================================
|
||||
|
||||
This file is part of the JUCE library - "Jules' Utility Class Extensions"
|
||||
Copyright 2004-11 by Raw Material Software Ltd.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
JUCE can be redistributed and/or modified under the terms of the GNU General
|
||||
Public License (Version 2), as published by the Free Software Foundation.
|
||||
A copy of the license is included in the JUCE distribution, or can be found
|
||||
online at www.gnu.org/licenses.
|
||||
|
||||
JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
|
||||
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
|
||||
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
To release a closed-source product which uses JUCE, commercial licenses are
|
||||
available: visit www.rawmaterialsoftware.com/juce for more information.
|
||||
|
||||
==============================================================================
|
||||
*/
|
||||
|
||||
#ifndef __JUCE_RELATIVERECTANGLE_JUCEHEADER__
|
||||
#define __JUCE_RELATIVERECTANGLE_JUCEHEADER__
|
||||
|
||||
#include "juce_RelativeCoordinate.h"
|
||||
class Component;
|
||||
|
||||
//==============================================================================
|
||||
/**
|
||||
An rectangle stored as a set of RelativeCoordinate values.
|
||||
|
||||
The rectangle's top, left, bottom and right edge positions are each stored as a RelativeCoordinate.
|
||||
|
||||
@see RelativeCoordinate, RelativePoint
|
||||
*/
|
||||
class JUCE_API RelativeRectangle
|
||||
{
|
||||
public:
|
||||
//==============================================================================
|
||||
/** Creates a zero-size rectangle at the origin. */
|
||||
RelativeRectangle();
|
||||
|
||||
/** Creates an absolute rectangle, relative to the origin. */
|
||||
explicit RelativeRectangle (const Rectangle<float>& rect);
|
||||
|
||||
/** Creates a rectangle from four coordinates. */
|
||||
RelativeRectangle (const RelativeCoordinate& left, const RelativeCoordinate& right,
|
||||
const RelativeCoordinate& top, const RelativeCoordinate& bottom);
|
||||
|
||||
/** Creates a rectangle from a stringified representation.
|
||||
The string must contain a sequence of 4 coordinates, separated by commas, in the order
|
||||
left, top, right, bottom. The syntax for the coordinate strings is explained in the
|
||||
RelativeCoordinate class.
|
||||
@see toString
|
||||
*/
|
||||
explicit RelativeRectangle (const String& stringVersion);
|
||||
|
||||
bool operator== (const RelativeRectangle& other) const noexcept;
|
||||
bool operator!= (const RelativeRectangle& other) const noexcept;
|
||||
|
||||
//==============================================================================
|
||||
/** Calculates the absolute position of this rectangle.
|
||||
|
||||
You'll need to provide a suitable Expression::Scope for looking up any coordinates that may
|
||||
be needed to calculate the result.
|
||||
*/
|
||||
const Rectangle<float> resolve (const Expression::Scope* scope) const;
|
||||
|
||||
/** Changes the values of this rectangle's coordinates to make it resolve to the specified position.
|
||||
|
||||
Calling this will leave any anchor points unchanged, but will set any absolute
|
||||
or relative positions to whatever values are necessary to make the resultant position
|
||||
match the position that is provided.
|
||||
*/
|
||||
void moveToAbsolute (const Rectangle<float>& newPos, const Expression::Scope* scope);
|
||||
|
||||
/** Returns true if this rectangle depends on any external symbols for its position.
|
||||
Coordinates that refer to symbols based on "this" are assumed not to be dynamic.
|
||||
*/
|
||||
bool isDynamic() const;
|
||||
|
||||
/** Returns a string which represents this point.
|
||||
This returns a comma-separated list of coordinates, in the order left, top, right, bottom. For details of
|
||||
the string syntax used by the coordinates, see the RelativeCoordinate constructor notes.
|
||||
The string that is returned can be passed to the RelativeRectangle constructor to recreate the rectangle.
|
||||
*/
|
||||
String toString() const;
|
||||
|
||||
/** Renames a symbol if it is used by any of the coordinates.
|
||||
This calls Expression::withRenamedSymbol() on the rectangle's coordinates.
|
||||
*/
|
||||
void renameSymbol (const Expression::Symbol& oldSymbol, const String& newName, const Expression::Scope& scope);
|
||||
|
||||
/** Creates and sets an appropriate Component::Positioner object for the given component, which will
|
||||
keep it positioned with this rectangle.
|
||||
*/
|
||||
void applyToComponent (Component& component) const;
|
||||
|
||||
//==============================================================================
|
||||
// The actual rectangle coords...
|
||||
RelativeCoordinate left, right, top, bottom;
|
||||
};
|
||||
|
||||
|
||||
#endif // __JUCE_RELATIVERECTANGLE_JUCEHEADER__
|
||||
Loading…
Add table
Add a link
Reference in a new issue