Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека разработчика Mac

Разработчик

Ссылка платформы AppKit ссылка класса NSColorList

Опции
Развертывание Target:

На этой странице
Язык:

NSColorList

NSColorList объект является упорядоченным списком NSColor объекты, идентифицированные ключами. Экземпляры NSColorList, или проще списки цветов, используются для управления названный списками NSColor экземпляры. NSColorPanel палитра цветов режима списка использует экземпляры NSColorList представлять любые списки цветов, идущих с системой, а также любыми списками, создаваемыми пользователем. Приложение может использовать NSColorList управлять специфичными для документа списками цветов.

Наследование

Соответствует

Оператор импорта

Swift

import AppKit

Objective C

@import AppKit;

Доступность

Доступный в OS X v10.0 и позже.

Инициализация объекта NSColorList

  • init (имя:) - initWithName:

    Инициализирует и возвращает получатель, регистрируя его под именем, если это уже не используется.

    Объявление

    Swift

    init(name name: String)

    Objective C

    - (instancetype)initWithName:(NSString *)name

    Параметры

    name

    Имя, под которым можно зарегистрировать список цветов. Укажите””, если Вы не хотите имя.

    Возвращаемое значение

    Инициализированный список цветов.

    Обсуждение

    Этот метод вызывает initWithName:fromFile: с a fromFile: параметр nil, указание, что список цветов не должен быть инициализирован от файла. Обратите внимание на то, что этот метод не добавляет список цветов к availableColorLists пока список цветов не сохраняется в путь пользователя с writeToFile: со значением nil.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

  • init (name:fromFile:) - initWithName:fromFile:

    Инициализирует и возвращает получатель, регистрируя его под именем, если это уже не используется.

    Объявление

    Swift

    init?(name name: String, fromFile path: String?)

    Objective C

    - (instancetype)initWithName:(NSString *)name fromFile:(NSString *)path

    Параметры

    name

    Имя файла для списка цветов (минус “.clr” расширение). Укажите””, если Вы не хотите имя.

    path

    Полный путь к файлу для списка цветов. A nil путь указывает, что список цветов должен быть инициализирован без цветов.

    Обсуждение

    Обратите внимание на то, что этот метод не добавляет список цветов к availableColorLists пока список цветов не сохраняется в путь пользователя с writeToFile: со значением nil.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

Получение списков цветов
  • availableColorLists () + availableColorLists

    Возвращает массив всех списков цветов, найденных в каталогах списка стандартного цвета.

    Объявление

    Swift

    class func availableColorLists() -> [AnyObject]

    Objective C

    + (NSArray *)availableColorLists

    Возвращаемое значение

    Массив NSColorList объекты, представляющие все списки цветов, найденные в каталогах списка стандартного цвета, включая цветные каталоги (списки цветов идентифицировали только по имени). Списки цветов, создаваемые во время выполнения, не включены в этот список, если они не сохраняются в один из каталогов списка стандартного цвета.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

    См. также

    + colorListNamed:

  • init (названный:) + colorListNamed:

    Ищет массив, которым это возвращается availableColorLists и возвращает список цветов с именем.

    Объявление

    Swift

    init?(named name: String) -> NSColorList

    Objective C

    + (NSColorList *)colorListNamed:(NSString *)name

    Параметры

    name

    Имя списка цветов для получения. Это имя не должно включать “.clr” суффикс.

    Возвращаемое значение

    Список цветов с указанным именем или nil если не существует никакой такой список цветов.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

    См. также

    – имя

Получение свойств списка цветов
  • имя - имя

    Возвращает имя получателя.

    Объявление

    Swift

    var name: String? { get }

    Objective C

    @property(readonly, copy) NSString *name

    Возвращаемое значение

    Имя получателя.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

  • isEditable - isEditable Доступный в OS X v10.0 через OS X v10.9

    Возвращает булево значение, указывающее, может ли быть изменен получатель.

    Объявление

    Objective C

    - (BOOL)isEditable

    Возвращаемое значение

    YEStrue если может быть изменен список цветов; иначе NOfalse. Этот результат зависит от источника списка: Если это прибыло из файла защищенного от записи, этот метод возвраты NOfalse.

    Оператор импорта

    Objective C

    @import AppKit;

    Доступность

    Доступный в OS X v10.0 через OS X v10.9.

Управление цветами ключом
  • allKeys - allKeys

    Возвращает массив ключей который NSColor объекты хранятся в получателе.

    Объявление

    Swift

    var allKeys: [AnyObject] { get }

    Objective C

    @property(readonly, copy) NSArray *allKeys

    Возвращаемое значение

    Массив NSString объекты те, содержащие все ключи, который NSColor объекты хранятся в получателе.

    Длина этого массива равняется числу цветов, и его содержание располагается согласно упорядочиванию, указанному, когда были вставлены цвета.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

  • colorWithKey (_:) - colorWithKey:

    Возвраты NSColor объект связался с данным ключом.

    Объявление

    Swift

    func colorWithKey(_ key: String) -> NSColor?

    Objective C

    - (NSColor *)colorWithKey:(NSString *)key

    Параметры

    key

    Ключ, для которого можно получить цвет.

    Возвращаемое значение

    Цвет связался с данным ключом или nil если нет ни одного.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

  • insertColor (_: key:atIndex:) - insertColor:key:atIndex:

    Вставляет указанный цвет в указанном расположении в получателе.

    Объявление

    Swift

    func insertColor(_ color: NSColor, key key: String, atIndex location: Int)

    Objective C

    - (void)insertColor:(NSColor *)color key:(NSString *)key atIndex:(NSUInteger)location

    Параметры

    color

    Цвет для добавления к списку цветов.

    key

    Ключ, с которым можно связать цвет.

    location

    Расположение в списке цветов, в котором можно поместить указанный цвет. Расположения пронумерованы начиная с 0.

    Обсуждение

    Если список уже содержит цвет с тем же ключом в различном расположении, это удалено из старого расположения. Этот метод сообщения NSColorListDidChangeNotification к центру уведомления по умолчанию. Это повышает NSColorListNotEditableException если список цветов не доступен для редактирования.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

    См. также

    – colorWithKey:
    – removeColorWithKey:
    – setColor:forKey:

  • removeColorWithKey (_:) - removeColorWithKey:

    Удаляет цвет, связанный с указанным ключом от получателя.

    Объявление

    Swift

    func removeColorWithKey(_ key: String)

    Objective C

    - (void)removeColorWithKey:(NSString *)key

    Параметры

    key

    Ключ, для которого можно удалить цвет.

    Обсуждение

    Если получатель не содержит ключ, этот метод ничего не делает. Этот метод сообщения NSColorListDidChangeNotification к центру уведомления по умолчанию. Это повышает NSColorListNotEditableException если получатель не доступен для редактирования.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

    См. также

    – insertColor:key:atIndex:
    – setColor:forKey:

  • setColor (_: forKey:) - setColor:forKey:

    Связывает указанное NSColor объект с указанным ключом.

    Объявление

    Swift

    func setColor(_ color: NSColor, forKey key: String)

    Objective C

    - (void)setColor:(NSColor *)color forKey:(NSString *)key

    Параметры

    color

    Цвет для соединения с данным ключом.

    key

    Ключ.

    Обсуждение

    Если список уже содержит key, этот метод выбирает соответствующий цвет к color; иначе, это вставляет color в конце списка путем вызова insertColor:key:atIndex:.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

    См. также

    – colorWithKey:
    – insertColor:key:atIndex:
    – removeColorWithKey:

Запись и удаление файлов списка цветов
  • removeFile () - removeFile

    Удаляет файл, из которого создавался список, если файл находится в стандартном пути поиска и принадлежавший пользователю.

    Объявление

    Swift

    func removeFile()

    Objective C

    - (void)removeFile

    Обсуждение

    Получатель удален из списка доступных списков цветов, возвращенных availableColorLists. Если нет никаких выдающихся ссылок на список цветов, этот метод мог бы освободить объект также.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

  • writeToFile (_:) - writeToFile:

    Сохраняет получатель к файлу в указанном пути.

    Объявление

    Swift

    func writeToFile(_ path: String?) -> Bool

    Objective C

    - (BOOL)writeToFile:(NSString *)path

    Параметры

    path

    Путь, в котором можно сохранить список цветов. Если path каталог, получатель сохраняется в файле, названном listname.clr в том каталоге (где listname является именем, с которым получатель был инициализирован).

    Если path включает имя файла, этот метод сохранил файл под тем именем. Если path nil, файл сохранен как listname.clr в частном каталоге колористов пользователя.

    Возвращаемое значение

    YEStrue на успех и NOfalse если методу не удается записать файл.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.

    См. также

    – removeFile

Уведомления
  • NSColorListDidChangeNotification NSColorListDidChangeNotification

    Отправленный каждый раз, когда изменяется список цветов. Объект уведомления NSColorList возразите, что это изменилось. Это уведомление не содержит a userInfo словарь.

    Оператор импорта

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.0 и позже.