xtd 0.2.0
Loading...
Searching...
No Matches
xtd::drawing::imaging::frame_dimension Class Referencefinal
Inheritance diagram for xtd::drawing::imaging::frame_dimension:
xtd::object xtd::iequatable< frame_dimension > xtd::interface xtd::equality_operators< type_t, equatable_t >

Definition

Provides properties that get the frame dimensions of an image. Not inheritable.

Namespace
xtd::drawing::imaging
Library
xtd.drawing

Public Constructors

 frame_dimension (const xtd::guid &guid)
 Initializes a new instance of the FrameDimension class using the specified Guid structure.
 

Public Properties

const xtd::guidguid () const noexcept
 Gets a globally unique identifier (GUID) that represents this frame_dimension object.
 

Public Methods

bool equals (const frame_dimension &value) const noexcept override
 
virtual bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object.
 
template<typename object_a_t , typename object_b_t >
static bool equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 

Public Static Properties

static frame_dimension page () noexcept
 Gets the page dimension.
 
static frame_dimension resolution () noexcept
 Gets the resolution dimension.
 
static frame_dimension time () noexcept
 Gets the time dimension.
 

Additional Inherited Members

- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object.
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type.
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance.
 
template<typename object_t >
xtd::uptr< object_t > memberwise_clone () const
 Creates a shallow copy of the current object.
 
virtual xtd::string to_string () const noexcept
 Returns a xtd::string that represents the current object.
 
- Public Member Functions inherited from xtd::iequatable< frame_dimension >
virtual bool equals (const frame_dimension &) const noexcept=0
 Indicates whether the current object is equal to another object of the same type.
 
- Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename object_b_t >
static bool equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 
template<typename object_a_t , typename object_b_t >
static bool reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are the same instance.
 

Constructor & Destructor Documentation

◆ frame_dimension()

xtd::drawing::imaging::frame_dimension::frame_dimension ( const xtd::guid guid)
inlineexplicit

Initializes a new instance of the FrameDimension class using the specified Guid structure.

Parameters
guidA xtd::guid structure that contains a GUID for this frame_dimension object.

Member Function Documentation

◆ guid()

const xtd::guid & xtd::drawing::imaging::frame_dimension::guid ( ) const
inlinenoexcept

Gets a globally unique identifier (GUID) that represents this frame_dimension object.

Returns
An xtd::guid structure that contains a GUID that represents this frame_dimension object.

◆ page()

static frame_dimension xtd::drawing::imaging::frame_dimension::page ( )
inlinestaticnoexcept

Gets the page dimension.

Returns
The page dimension.

◆ resolution()

static frame_dimension xtd::drawing::imaging::frame_dimension::resolution ( )
inlinestaticnoexcept

Gets the resolution dimension.

Returns
The resolution dimension.

◆ time()

static frame_dimension xtd::drawing::imaging::frame_dimension::time ( )
inlinestaticnoexcept

Gets the time dimension.

Returns
The time dimension.

◆ equals() [1/2]

virtual bool xtd::object::equals ( const object obj) const
virtualnoexcept

Determines whether the specified object is equal to the current object.

Parameters
objThe object to compare with the current object.
Returns
true if the specified object is equal to the current object. otherwise, false.
Examples
The following code example compares the current instance with another object.
#include <xtd/console>
using namespace xtd;
auto main() -> int {
auto object1 = new_ptr<object>();
auto object2 = new_ptr<object>();
auto object3 = object2;
console::write_line(object1->equals(*object3));
console::write_line(*object1 == *object3);
object3 = object1;
console::write_line(object1->equals(*object3));
console::write_line(*object1 == *object3);
}
// This code produces the following output :
//
// false
// false
// true
// true
static void write_line()
Writes the current line terminator to the standard output stream using the specified format informati...
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition xtd_about_box.h:10

Reimplemented from xtd::object.

◆ equals() [2/2]

template<typename object_a_t , typename object_b_t >
static bool xtd::object::equals ( const object_a_t &  object_a,
const object_b_t &  object_b 
)
inlinestaticnoexcept

Determines whether the specified object instances are considered equal.

Parameters
object_aThe first object to compare.
object_bThe second object to compare.
Returns
true if object_a is the same instance as object_b or if both are null references or if object_a(object_b) returns true. otherwise, false.
Examples
The following code example compares different objects.
#include <xtd/console>
using namespace xtd;
auto main() -> int {
string s1 = "Tom";
string s2 = "Carol";
console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
s1 = "Tom";
s2 = "Tom";
console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
s1 = "";
s2 = "Tom";
console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
s1 = "Carol";
s2 = "";
console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
s1 = "";
s2 = "";
console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
}
// This code produces the following output :
//
// object::equals("Tom", "Carol") => false
// object::equals("Tom", "Tom") => true
// object::equals("", "Tom") => false
// object::equals("Carol", "") => false
// object::equals("", "") => true
virtual bool equals(const object &obj) const noexcept
Determines whether the specified object is equal to the current object.

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