chrome/browser/ui/cocoa/l10n_util.h

// Copyright (c) 2010 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_UI_COCOA_L10N_UTIL_H_
#define CHROME_BROWSER_UI_COCOA_L10N_UTIL_H_

#import <Cocoa/Cocoa.h>
#include <stddef.h>

#include "base/feature_list.h"
#include "base/strings/string16.h"

namespace cocoa_l10n_util {

// Compare function for -[NSArray sortedArrayUsingFunction:context:] that
// sorts the views in Y order bottom up. |context| is ignored.
NSInteger CompareFrameY(id view1, id view2, void* context);

// Helper for tweaking views. If view is a:
//   checkbox, radio group or label: it gets a forced wrap at current size
//   editable field: left as is
//   anything else: do  +[GTMUILocalizerAndLayoutTweaker sizeToFitView:]
NSSize WrapOrSizeToFit(NSView* view);

// Walks views in top-down order, wraps each to their current width, and moves
// the latter ones down to prevent overlaps. Returns the vertical delta in view
// coordinates.
CGFloat VerticallyReflowGroup(NSArray* views);

// Like |base::ReplaceStringPlaceholders(const base::string16&,
// const base::string16&, size_t*)|, but for a NSString formatString.
NSString* ReplaceNSStringPlaceholders(NSString* formatString,
                                      const base::string16& a,
                                      size_t* offset);

// Generates a tooltip string for a given URL and title.
NSString* TooltipForURLAndTitle(NSString* url, NSString* title);

// Returns whether both:
// 1) Mac RTL support is enabled via the MacRTL feature;
// 2) The browser UI is in RTL mode.
// If MacRTL becomes the default, this function can be replaced with
// uses of base::i18n::IsRTL().
bool ShouldDoExperimentalRTLLayout();

// Returns true if ShouldDoExperimentalRTLLayout() is true and the OS is
// 10.12 or above. macOS 10.12 is the first OS where the native stoplight
// buttons are reversed in RTL, so manually reversing them in previous
// OSes would make Chrome stick out.
bool ShouldFlipWindowControlsInRTL();

// Set or clear the keys in NSUserDefaults which control UI direction based on
// whether direction is forced by a Chrome flag. This should be early in
// Chrome's launch, before any views or windows have been created, because it's
// cached by AppKit.
void ApplyForcedRTL();

// Returns NSImageLeading when available (10.12+), otherwise
// NSImageLeft for LTR and NSImageRight in RTL.
NSCellImagePosition LeadingCellImagePosition();
// Returns NSImageTrailing when available (10.12+), otherwise
// NSImageRight for LTR and NSImageLeft in RTL.
NSCellImagePosition TrailingCellImagePosition();
// Returns NSMinXEdge for LTR and NSMaxXEdge for RTL.
NSRectEdge LeadingEdge();
// Returns NSMaxXEdge for LTR and NSMinXEdge for RTL.
NSRectEdge TrailingEdge();

// Returns an autoreleased image containing |image| flipped
// across the x axis.
NSImage* FlippedImage(NSImage* image);

// In RTL, mirrors all subviews of |view|. Additionally,
// reverses horizontal margin autoresizing masks.
// This method is *not* recursive.
// In LTR, this is a no-op.
void FlipAllSubviewsIfNecessary(NSView* view);

}  // namespace cocoa_l10n_util

#endif  // CHROME_BROWSER_UI_COCOA_L10N_UTIL_H_