370286 - Audit use of pageTitle vs. displayTitle

Status: RESOLVED FIXED

(Camino Graveyard :: General, defect)

Description

[Stuart Morgan]

Right now most of the UI uses pageTitle, rather than displayTitle. Most, if not all, actually should be using displayTitle (bookmarking, for example), so it should be changed where appropriate (and if that lets us eliminate pageTitle altogether, even better).

Comment 1

[Stuart Morgan]

Attachment: remove displayTitle

As expected, UI should all be using the display title, so I made pageTitle return the fixed up form and removed displayTitle.

Since it's related, I'd also like to change 'untitled' to 'Untitled' in our strings file unless anyone objects. The comment says it's lower case to match the HIG, but:
- NSDocument uses Untitled
- Prominent AppKit engineers have commented on lists that the HIG is out of date in that respect, and that Untitled is now considered correct
- The HIG argument for lower-case was to make it clear that it was unsaved to encourage the user to save; that's cleary irrelevant for us
- It looks out of place relative to other titles, most of which are upper-case (and relative to most apps, given the NSDocument behavior).

Comment 2

[Stuart Morgan]

Comment on attachment 263837 [details] [diff] [review]
remove displayTitle

pink, when you look at this a yay or nay on the strings change in comment 1 would be good as well.

Comment 3

[Mike Pinkerton (not reading bugmail)]

I'm ok with the strings change in comment 1.

 - (NSString*)pageTitle
 {
-  return [mBrowserView pageTitle];
+  return mDisplayTitle;
 }

Why isn't |displayTitle| a better name for a member called |mDisplayTitle|? This seems more confusing to me...

Comment 4

[Stuart Morgan]

(In reply to comment #3)
> Why isn't |displayTitle| a better name for a member called |mDisplayTitle|?
> This seems more confusing to me...

displayTitle isn't a very descriptive name from an API standpoint; if you are looking for a method to give you the page's title, pageTitle is a lot more obvious, and similarly if you are reading code using it. I could change the member variable, but I thought it was still a useful internal distinction since it's not necessarily the same as the underlying title as reported by Gecko.

Comment 5

[Mike Pinkerton (not reading bugmail)]

Comment on attachment 263837 [details] [diff] [review]
remove displayTitle

sr=pink

Comment 6

[Stuart Morgan]

Checked in on trunk and MOZILLA_1_8_BRANCH